software.amazon.awssdk.services.ecs.model

Class UpdateContainerInstancesStateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ecs.model.EcsRequest

software.amazon.awssdk.services.ecs.model.UpdateContainerInstancesStateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateContainerInstancesStateRequest.Builder,UpdateContainerInstancesStateRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateContainerInstancesStateRequest
extends EcsRequest
implements ToCopyableBuilder<UpdateContainerInstancesStateRequest.Builder,UpdateContainerInstancesStateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateContainerInstancesStateRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateContainerInstancesStateRequest.Builder	builder()
String	cluster() The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update.
List<String>	containerInstances() A list of container instance IDs or full ARN entries.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContainerInstances() For responses, this returns true if the service returned a value for the ContainerInstances property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateContainerInstancesStateRequest.Builder>	serializableBuilderClass()
ContainerInstanceStatus	status() The container instance state with which to update the container instance.
String	statusAsString() The container instance state with which to update the container instance.
UpdateContainerInstancesStateRequest.Builder	toBuilder()
String	toString() 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

cluster

public final String cluster()

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

hasContainerInstances

public final boolean hasContainerInstances()

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

containerInstances

public final List<String> containerInstances()

A list of container instance IDs or full ARN entries.

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

Returns:

A list of container instance IDs or full ARN entries.

status

public final ContainerInstanceStatus status()

The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.

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

Returns:

The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.

See Also:

ContainerInstanceStatus

statusAsString

public final String statusAsString()

The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.

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

Returns:

The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.

See Also:

ContainerInstanceStatus

toBuilder

public UpdateContainerInstancesStateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateContainerInstancesStateRequest.Builder,UpdateContainerInstancesStateRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static UpdateContainerInstancesStateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateContainerInstancesStateRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo