Package software.amazon.awssdk.services.ecs.model

Class ContainerInstanceHealthStatus

java.lang.Object

software.amazon.awssdk.services.ecs.model.ContainerInstanceHealthStatus

All Implemented Interfaces:

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

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

An object representing the health status of the container instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ContainerInstanceHealthStatus.Builder

Method Summary

Modifier and Type	Method	Description
static ContainerInstanceHealthStatus.Builder	builder()
List<InstanceHealthCheckResult>	details()	An array of objects representing the details of the container instance health status.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDetails()	For responses, this returns true if the service returned a value for the Details property.
int	hashCode()
InstanceHealthCheckState	overallStatus()	The overall health status of the container instance.
String	overallStatusAsString()	The overall health status of the container instance.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ContainerInstanceHealthStatus.Builder>	serializableBuilderClass()
ContainerInstanceHealthStatus.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

overallStatus

public final InstanceHealthCheckState overallStatus()

The overall health status of the container instance. This is an aggregate status of all container instance health checks.

If the service returns an enum value that is not available in the current SDK version, overallStatus will return InstanceHealthCheckState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from overallStatusAsString().

Returns:

The overall health status of the container instance. This is an aggregate status of all container instance health checks.

See Also:

InstanceHealthCheckState

overallStatusAsString

public final String overallStatusAsString()

The overall health status of the container instance. This is an aggregate status of all container instance health checks.

If the service returns an enum value that is not available in the current SDK version, overallStatus will return InstanceHealthCheckState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from overallStatusAsString().

Returns:

The overall health status of the container instance. This is an aggregate status of all container instance health checks.

See Also:

InstanceHealthCheckState

hasDetails

public final boolean hasDetails()

For responses, this returns true if the service returned a value for the Details 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.

details

public final List<InstanceHealthCheckResult> details()

An array of objects representing the details of the container instance health status.

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 hasDetails() method.

Returns:

An array of objects representing the details of the container instance health status.

toBuilder

public ContainerInstanceHealthStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContainerInstanceHealthStatus.Builder,ContainerInstanceHealthStatus>

builder

public static ContainerInstanceHealthStatus.Builder builder()

serializableBuilderClass

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