Class UpdateCloudWatchAlarmTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.medialive.model.MediaLiveRequest

software.amazon.awssdk.services.medialive.model.UpdateCloudWatchAlarmTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateCloudWatchAlarmTemplateRequest.Builder,UpdateCloudWatchAlarmTemplateRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateCloudWatchAlarmTemplateRequest
extends MediaLiveRequest
implements ToCopyableBuilder<UpdateCloudWatchAlarmTemplateRequest.Builder,UpdateCloudWatchAlarmTemplateRequest>

Placeholder documentation for UpdateCloudWatchAlarmTemplateRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateCloudWatchAlarmTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateCloudWatchAlarmTemplateRequest.Builder	builder()
final CloudWatchAlarmTemplateComparisonOperator	comparisonOperator()	Returns the value of the ComparisonOperator property for this object.
final String	comparisonOperatorAsString()	Returns the value of the ComparisonOperator property for this object.
final Integer	datapointsToAlarm()	The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
final String	description()	A resource's optional description.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final Integer	evaluationPeriods()	The number of periods over which data is compared to the specified threshold.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkRequest.
final String	groupIdentifier()	A cloudwatch alarm template group's identifier.
final int	hashCode()
final String	identifier()	A cloudwatch alarm template's identifier.
final String	metricName()	The name of the metric associated with the alarm.
final String	name()	A resource's name.
final Integer	period()	The period, in seconds, over which the specified statistic is applied.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends UpdateCloudWatchAlarmTemplateRequest.Builder>	serializableBuilderClass()
final CloudWatchAlarmTemplateStatistic	statistic()	Returns the value of the Statistic property for this object.
final String	statisticAsString()	Returns the value of the Statistic property for this object.
final CloudWatchAlarmTemplateTargetResourceType	targetResourceType()	Returns the value of the TargetResourceType property for this object.
final String	targetResourceTypeAsString()	Returns the value of the TargetResourceType property for this object.
final Double	threshold()	The threshold value to compare with the specified statistic.
UpdateCloudWatchAlarmTemplateRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final CloudWatchAlarmTemplateTreatMissingData	treatMissingData()	Returns the value of the TreatMissingData property for this object.
final String	treatMissingDataAsString()	Returns the value of the TreatMissingData property for this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

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:

• CloudWatchAlarmTemplateComparisonOperator

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:

• CloudWatchAlarmTemplateComparisonOperator

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.

groupIdentifier

public final String groupIdentifier()

A cloudwatch alarm template group's identifier. Can be either be its id or current name.

Returns:

A cloudwatch alarm template group's identifier. Can be either be its id or current name.

identifier

public final String identifier()

A cloudwatch alarm template's identifier. Can be either be its id or current name.

Returns:

A cloudwatch alarm template's identifier. Can be either be its id or current name.

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.

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:

• CloudWatchAlarmTemplateStatistic

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:

• CloudWatchAlarmTemplateStatistic

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:

• CloudWatchAlarmTemplateTargetResourceType

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:

• CloudWatchAlarmTemplateTargetResourceType

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:

• CloudWatchAlarmTemplateTreatMissingData

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:

• CloudWatchAlarmTemplateTreatMissingData

toBuilder

public UpdateCloudWatchAlarmTemplateRequest.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<UpdateCloudWatchAlarmTemplateRequest.Builder,UpdateCloudWatchAlarmTemplateRequest>

Specified by:

toBuilder in class MediaLiveRequest

Returns:

a builder for type T

builder

public static UpdateCloudWatchAlarmTemplateRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.