Class AlarmConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AlarmConfiguration.Builder,
AlarmConfiguration>
Information about alarms associated with a deployment or deployment group.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionalarms()
A list of alarms configured for the deployment or deployment group.static AlarmConfiguration.Builder
builder()
final Boolean
enabled()
Indicates whether the alarm configuration is enabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Alarms property.final int
hashCode()
final Boolean
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch.static Class
<? extends AlarmConfiguration.Builder> 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
enabled
Indicates whether the alarm configuration is enabled.
- Returns:
- Indicates whether the alarm configuration is enabled.
-
ignorePollAlarmFailure
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.
-
true
: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch. -
false
: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
- Returns:
- Indicates whether a deployment should continue if information about the current state of alarms cannot be
retrieved from Amazon CloudWatch. The default value is false.
-
true
: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch. -
false
: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
-
-
-
hasAlarms
public final boolean hasAlarms()For responses, this returns true if the service returned a value for the Alarms 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. -
alarms
A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
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
hasAlarms()
method.- Returns:
- A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
-
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 interfaceToCopyableBuilder<AlarmConfiguration.Builder,
AlarmConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-