java.lang.Object
- software.amazon.awssdk.services.ecs.model.ServiceDeploymentAlarms

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ServiceDeploymentAlarms.Builder,ServiceDeploymentAlarms>
```
@Generated("software.amazon.awssdk:codegen")
public final class ServiceDeploymentAlarms
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ServiceDeploymentAlarms.Builder,ServiceDeploymentAlarms>
```
The CloudWatch alarms used to determine a service deployment failed.

Amazon ECS considers the service deployment as failed when any of the alarms move to the ALARM state. For more information, see How CloudWatch alarms detect Amazon ECS deployment failures in the Amazon ECS Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ServiceDeploymentAlarms.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`alarmNames()`	The name of the CloudWatch alarms that determine when a service deployment failed.
`static ServiceDeploymentAlarms.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAlarmNames()`	For responses, this returns true if the service returned a value for the AlarmNames property.
`int`	`hashCode()`
`boolean`	`hasTriggeredAlarmNames()`	For responses, this returns true if the service returned a value for the TriggeredAlarmNames property.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ServiceDeploymentAlarms.Builder>`	`serializableBuilderClass()`
`ServiceDeploymentRollbackMonitorsStatus`	`status()`	The status of the alarms check.
`String`	`statusAsString()`	The status of the alarms check.
`ServiceDeploymentAlarms.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`triggeredAlarmNames()`	One or more CloudWatch alarm names that have been triggered during the service deployment.

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
  - status
```
public final ServiceDeploymentRollbackMonitorsStatus status()
```
    The status of the alarms check. Amazon ECS is not using alarms for service deployment failures when the status is DISABLED.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ServiceDeploymentRollbackMonitorsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the alarms check. Amazon ECS is not using alarms for service deployment failures when the status is DISABLED.
    
    See Also:
    
    ServiceDeploymentRollbackMonitorsStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the alarms check. Amazon ECS is not using alarms for service deployment failures when the status is DISABLED.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ServiceDeploymentRollbackMonitorsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the alarms check. Amazon ECS is not using alarms for service deployment failures when the status is DISABLED.
    
    See Also:
    
    ServiceDeploymentRollbackMonitorsStatus
  - hasAlarmNames
```
public final boolean hasAlarmNames()
```
    For responses, this returns true if the service returned a value for the AlarmNames 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.
  - alarmNames
```
public final List<String> alarmNames()
```
    The name of the CloudWatch alarms that determine when a service deployment failed. A "," separates the alarms.
    
    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 hasAlarmNames() method.
    
    Returns:
    
    The name of the CloudWatch alarms that determine when a service deployment failed. A "," separates the alarms.
  - hasTriggeredAlarmNames
```
public final boolean hasTriggeredAlarmNames()
```
    For responses, this returns true if the service returned a value for the TriggeredAlarmNames 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.
  - triggeredAlarmNames
```
public final List<String> triggeredAlarmNames()
```
    One or more CloudWatch alarm names that have been triggered during the service deployment. A "," separates the alarm names.
    
    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 hasTriggeredAlarmNames() method.
    
    Returns:
    
    One or more CloudWatch alarm names that have been triggered during the service deployment. A "," separates the alarm names.
  - toBuilder
```
public ServiceDeploymentAlarms.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ServiceDeploymentAlarms.Builder,ServiceDeploymentAlarms>
  - builder
```
public static ServiceDeploymentAlarms.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ServiceDeploymentAlarms.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ServiceDeploymentAlarms

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

status

statusAsString

hasAlarmNames

alarmNames

hasTriggeredAlarmNames

triggeredAlarmNames

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField