software.amazon.awssdk.services.ecs.model

Class ListContainerInstancesRequest

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.ListContainerInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListContainerInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListContainerInstancesRequest.Builder	builder()
String	cluster() The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filter() You can filter the results of a ListContainerInstances operation with cluster query language statements.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of container instance results that ListContainerInstances returned in paginated output.
String	nextToken() The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed.
List<SdkField<?>>	sdkFields()
static Class<? extends ListContainerInstancesRequest.Builder>	serializableBuilderClass()
ContainerInstanceStatus	status() Filters the container instances by status.
String	statusAsString() Filters the container instances by status.
ListContainerInstancesRequest.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 instances to list. 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 instances to list. If you do not specify a cluster, the default cluster is assumed.

filter

public final String filter()

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

Returns:

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

nextToken

public final String nextToken()

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

maxResults

public final Integer maxResults()

The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

Returns:

The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

status

public final ContainerInstanceStatus status()

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

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:

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

See Also:

ContainerInstanceStatus

statusAsString

public final String statusAsString()

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

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:

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

See Also:

ContainerInstanceStatus

toBuilder

public ListContainerInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static ListContainerInstancesRequest.Builder builder()

serializableBuilderClass

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