@Generated(value="software.amazon.awssdk:codegen") public class ListContainerInstancesRequest extends ECSRequest implements ToCopyableBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListContainerInstancesRequest.Builder |
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) |
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)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
maxResults()
The maximum number of container instance results returned by
ListContainerInstances in paginated
output. |
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. |
static Class<? extends ListContainerInstancesRequest.Builder> |
serializableBuilderClass() |
ContainerInstanceStatus |
status()
Filters the container instances by status.
|
String |
statusString()
Filters the container instances by status.
|
ListContainerInstancesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public 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.
public 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.
ListContainerInstances
operation with cluster query language
statements. For more information, see Cluster
Query Language in the Amazon EC2 Container Service Developer Guide.public 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.
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.
public 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.
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.public 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
.
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 statusString()
.
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
.ContainerInstanceStatus
public String statusString()
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
.
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 statusString()
.
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
.ContainerInstanceStatus
public ListContainerInstancesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListContainerInstancesRequest.Builder,ListContainerInstancesRequest>
toBuilder
in class ECSRequest
public static ListContainerInstancesRequest.Builder builder()
public static Class<? extends ListContainerInstancesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.