software.amazon.awssdk.services.ecs.model

Interface ListContainerInstancesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>, EcsRequest.Builder, SdkBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>, SdkRequest.Builder

Enclosing class:

ListContainerInstancesRequest

public static interface ListContainerInstancesRequest.Builder
extends EcsRequest.Builder, CopyableBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>

Method Summary

Modifier and Type	Method and Description
ListContainerInstancesRequest.Builder	cluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list.
ListContainerInstancesRequest.Builder	filter(String filter) You can filter the results of a ListContainerInstances operation with cluster query language statements.
ListContainerInstancesRequest.Builder	maxResults(Integer maxResults) The maximum number of container instance results returned by ListContainerInstances in paginated output.
ListContainerInstancesRequest.Builder	nextToken(String nextToken) The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter.
ListContainerInstancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ListContainerInstancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ListContainerInstancesRequest.Builder	status(ContainerInstanceStatus status) Filters the container instances by status.
ListContainerInstancesRequest.Builder	status(String status) Filters the container instances by status.

Methods inherited from interface software.amazon.awssdk.services.ecs.model.EcsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, build

Method Detail

cluster

ListContainerInstancesRequest.Builder cluster(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

filter

ListContainerInstancesRequest.Builder filter(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 EC2 Container Service Developer Guide.

Parameters:

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 EC2 Container Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

ListContainerInstancesRequest.Builder nextToken(String nextToken)

The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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.

Parameters:

nextToken - The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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:

Returns a reference to this object so that method calls can be chained together.

maxResults

ListContainerInstancesRequest.Builder maxResults(Integer maxResults)

The maximum number of container instance results returned by ListContainerInstances 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 is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

Parameters:

maxResults - The maximum number of container instance results returned by ListContainerInstances 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 is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

ListContainerInstancesRequest.Builder status(String 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 do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING.

Parameters:

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 do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContainerInstanceStatus, ContainerInstanceStatus

status

ListContainerInstancesRequest.Builder status(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 do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING.

Parameters:

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 do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContainerInstanceStatus, ContainerInstanceStatus

overrideConfiguration

ListContainerInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ListContainerInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.