Interface ListContainerInstancesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListContainerInstancesRequest.Builder,
,ListContainerInstancesRequest> EcsRequest.Builder
,SdkBuilder<ListContainerInstancesRequest.Builder,
,ListContainerInstancesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListContainerInstancesRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list.You can filter the results of aListContainerInstances
operation with cluster query language statements.maxResults
(Integer maxResults) The maximum number of container instance results thatListContainerInstances
returned in paginated output.ThenextToken
value returned from aListContainerInstances
request indicating that more results are available to fulfill the request and further calls are needed.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Filters the container instances by status.status
(ContainerInstanceStatus status) Filters the container instances by status.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.services.ecs.model.EcsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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.- Parameters:
filter
- You can filter the results of aListContainerInstances
operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The
nextToken
value returned from aListContainerInstances
request indicating that more results are available to fulfill the request and further calls are needed. IfmaxResults
was provided, it's possible the number of results to be fewer thanmaxResults
.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
- ThenextToken
value returned from aListContainerInstances
request indicating that more results are available to fulfill the request and further calls are needed. IfmaxResults
was provided, it's possible the number of results to be fewer thanmaxResults
.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
The maximum number of container instance results that
ListContainerInstances
returned in paginated output. When this parameter is used,ListContainerInstances
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListContainerInstances
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListContainerInstances
returns up to 100 results and anextToken
value if applicable.- Parameters:
maxResults
- The maximum number of container instance results thatListContainerInstances
returned in paginated output. When this parameter is used,ListContainerInstances
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListContainerInstances
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListContainerInstances
returns up to 100 results and anextToken
value if applicable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 toDRAINING
using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other thanINACTIVE
.- Parameters:
status
- Filters the container instances by status. For example, if you specify theDRAINING
status, the results include only container instances that have been set toDRAINING
using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other thanINACTIVE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toDRAINING
using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other thanINACTIVE
.- Parameters:
status
- Filters the container instances by status. For example, if you specify theDRAINING
status, the results include only container instances that have been set toDRAINING
using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other thanINACTIVE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListContainerInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-