Class PutAlarmMuteRuleRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
-
- software.amazon.awssdk.services.cloudwatch.model.PutAlarmMuteRuleRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<PutAlarmMuteRuleRequest.Builder,PutAlarmMuteRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutAlarmMuteRuleRequest extends CloudWatchRequest implements ToCopyableBuilder<PutAlarmMuteRuleRequest.Builder,PutAlarmMuteRuleRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePutAlarmMuteRuleRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PutAlarmMuteRuleRequest.Builderbuilder()Stringdescription()A description of the alarm mute rule that helps you identify its purpose.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantexpireDate()The date and time when the mute rule expires and is no longer evaluated.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.MuteTargetsmuteTargets()Specifies which alarms this rule applies to.Stringname()The name of the alarm mute rule.Rulerule()The configuration that defines when and how long alarms should be muted.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PutAlarmMuteRuleRequest.Builder>serializableBuilderClass()InstantstartDate()The date and time after which the mute rule takes effect.List<Tag>tags()A list of key-value pairs to associate with the alarm mute rule.PutAlarmMuteRuleRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the alarm mute rule. This name must be unique within your Amazon Web Services account and region.
- Returns:
- The name of the alarm mute rule. This name must be unique within your Amazon Web Services account and region.
-
description
public final String description()
A description of the alarm mute rule that helps you identify its purpose.
- Returns:
- A description of the alarm mute rule that helps you identify its purpose.
-
rule
public final Rule rule()
The configuration that defines when and how long alarms should be muted.
- Returns:
- The configuration that defines when and how long alarms should be muted.
-
muteTargets
public final MuteTargets muteTargets()
Specifies which alarms this rule applies to.
- Returns:
- Specifies which alarms this rule applies to.
-
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 theisEmpty()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 List<Tag> tags()
A list of key-value pairs to associate with the alarm mute rule. You can use tags to categorize and manage your mute rules.
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:
- A list of key-value pairs to associate with the alarm mute rule. You can use tags to categorize and manage your mute rules.
-
startDate
public final Instant startDate()
The date and time after which the mute rule takes effect. If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression. This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.
- Returns:
- The date and time after which the mute rule takes effect. If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression. This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.
-
expireDate
public final Instant expireDate()
The date and time when the mute rule expires and is no longer evaluated. After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms. This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.
- Returns:
- The date and time when the mute rule expires and is no longer evaluated. After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms. This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.
-
toBuilder
public PutAlarmMuteRuleRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PutAlarmMuteRuleRequest.Builder,PutAlarmMuteRuleRequest>- Specified by:
toBuilderin classCloudWatchRequest
-
builder
public static PutAlarmMuteRuleRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutAlarmMuteRuleRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-