Class CloudWatchAlarmTemplateSummary

java.lang.Object
software.amazon.awssdk.services.medialive.model.CloudWatchAlarmTemplateSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CloudWatchAlarmTemplateSummary.Builder,CloudWatchAlarmTemplateSummary>
@Generated("software.amazon.awssdk:codegen") public final class CloudWatchAlarmTemplateSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CloudWatchAlarmTemplateSummary.Builder,CloudWatchAlarmTemplateSummary>
Placeholder documentation for CloudWatchAlarmTemplateSummary
See Also:

  • Method Details

    • arn

      public final String arn()
      A cloudwatch alarm template's ARN (Amazon Resource Name)
      Returns:
      A cloudwatch alarm template's ARN (Amazon Resource Name)

    • comparisonOperator

      public final CloudWatchAlarmTemplateComparisonOperator comparisonOperator()
      Returns the value of the ComparisonOperator property for this object.

      If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return CloudWatchAlarmTemplateComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

      Returns:
      The value of the ComparisonOperator property for this object.
      See Also:

    • comparisonOperatorAsString

      public final String comparisonOperatorAsString()
      Returns the value of the ComparisonOperator property for this object.

      If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return CloudWatchAlarmTemplateComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

      Returns:
      The value of the ComparisonOperator property for this object.
      See Also:

    • createdAt

      public final Instant createdAt()
      Returns the value of the CreatedAt property for this object.
      Returns:
      The value of the CreatedAt property for this object.

    • datapointsToAlarm

      public final Integer datapointsToAlarm()
      The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
      Returns:
      The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

    • description

      public final String description()
      A resource's optional description.
      Returns:
      A resource's optional description.

    • evaluationPeriods

      public final Integer evaluationPeriods()
      The number of periods over which data is compared to the specified threshold.
      Returns:
      The number of periods over which data is compared to the specified threshold.

    • groupId

      public final String groupId()
      A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
      Returns:
      A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`

    • id

      public final String id()
      A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`
      Returns:
      A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`

    • metricName

      public final String metricName()
      The name of the metric associated with the alarm. Must be compatible with targetResourceType.
      Returns:
      The name of the metric associated with the alarm. Must be compatible with targetResourceType.

    • modifiedAt

      public final Instant modifiedAt()
      Returns the value of the ModifiedAt property for this object.
      Returns:
      The value of the ModifiedAt property for this object.

    • name

      public final String name()
      A resource's name. Names must be unique within the scope of a resource type in a specific region.
      Returns:
      A resource's name. Names must be unique within the scope of a resource type in a specific region.

    • period

      public final Integer period()
      The period, in seconds, over which the specified statistic is applied.
      Returns:
      The period, in seconds, over which the specified statistic is applied.

    • statistic

      public final CloudWatchAlarmTemplateStatistic statistic()
      Returns the value of the Statistic property for this object.

      If the service returns an enum value that is not available in the current SDK version, statistic will return CloudWatchAlarmTemplateStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

      Returns:
      The value of the Statistic property for this object.
      See Also:

    • statisticAsString

      public final String statisticAsString()
      Returns the value of the Statistic property for this object.

      If the service returns an enum value that is not available in the current SDK version, statistic will return CloudWatchAlarmTemplateStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

      Returns:
      The value of the Statistic property for this object.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()
      Returns the value of the Tags property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The value of the Tags property for this object.

    • targetResourceType

      public final CloudWatchAlarmTemplateTargetResourceType targetResourceType()
      Returns the value of the TargetResourceType property for this object.

      If the service returns an enum value that is not available in the current SDK version, targetResourceType will return CloudWatchAlarmTemplateTargetResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetResourceTypeAsString().

      Returns:
      The value of the TargetResourceType property for this object.
      See Also:

    • targetResourceTypeAsString

      public final String targetResourceTypeAsString()
      Returns the value of the TargetResourceType property for this object.

      If the service returns an enum value that is not available in the current SDK version, targetResourceType will return CloudWatchAlarmTemplateTargetResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetResourceTypeAsString().

      Returns:
      The value of the TargetResourceType property for this object.
      See Also:

    • threshold

      public final Double threshold()
      The threshold value to compare with the specified statistic.
      Returns:
      The threshold value to compare with the specified statistic.

    • treatMissingData

      public final CloudWatchAlarmTemplateTreatMissingData treatMissingData()
      Returns the value of the TreatMissingData property for this object.

      If the service returns an enum value that is not available in the current SDK version, treatMissingData will return CloudWatchAlarmTemplateTreatMissingData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from treatMissingDataAsString().

      Returns:
      The value of the TreatMissingData property for this object.
      See Also:

    • treatMissingDataAsString

      public final String treatMissingDataAsString()
      Returns the value of the TreatMissingData property for this object.

      If the service returns an enum value that is not available in the current SDK version, treatMissingData will return CloudWatchAlarmTemplateTreatMissingData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from treatMissingDataAsString().

      Returns:
      The value of the TreatMissingData property for this object.
      See Also:

    • toBuilder

      public CloudWatchAlarmTemplateSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CloudWatchAlarmTemplateSummary.Builder,CloudWatchAlarmTemplateSummary>
      Returns:
      a builder for type T

    • builder

      public static CloudWatchAlarmTemplateSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CloudWatchAlarmTemplateSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.