Package software.amazon.awssdk.services.codedeploy.model

Class AlarmConfiguration

java.lang.Object

software.amazon.awssdk.services.codedeploy.model.AlarmConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AlarmConfiguration.Builder,AlarmConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class AlarmConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AlarmConfiguration.Builder,AlarmConfiguration>

Information about alarms associated with a deployment or deployment group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AlarmConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
List<Alarm>	alarms()	A list of alarms configured for the deployment or deployment group.
static AlarmConfiguration.Builder	builder()
Boolean	enabled()	Indicates whether the alarm configuration is enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlarms()	For responses, this returns true if the service returned a value for the Alarms property.
int	hashCode()
Boolean	ignorePollAlarmFailure()	Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch.
List<SdkField<?>>	sdkFields()
static Class<? extends AlarmConfiguration.Builder>	serializableBuilderClass()
AlarmConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

enabled

public final Boolean enabled()

Indicates whether the alarm configuration is enabled.

Returns:

Indicates whether the alarm configuration is enabled.

ignorePollAlarmFailure

public final Boolean 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 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.

alarms

public final List<Alarm> 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

public AlarmConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AlarmConfiguration.Builder,AlarmConfiguration>

builder

public static AlarmConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends AlarmConfiguration.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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