public static interface ListTasksRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>
| Modifier and Type | Method and Description |
|---|---|
ListTasksRequest.Builder |
cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.
|
ListTasksRequest.Builder |
containerInstance(String containerInstance)
The container instance ID or full ARN of the container instance with which to filter the
ListTasks results. |
ListTasksRequest.Builder |
desiredStatus(DesiredStatus desiredStatus)
The task desired status with which to filter the
ListTasks results. |
ListTasksRequest.Builder |
desiredStatus(String desiredStatus)
The task desired status with which to filter the
ListTasks results. |
ListTasksRequest.Builder |
family(String family)
The name of the family with which to filter the
ListTasks results. |
ListTasksRequest.Builder |
launchType(LaunchType launchType)
The launch type for services to list.
|
ListTasksRequest.Builder |
launchType(String launchType)
The launch type for services to list.
|
ListTasksRequest.Builder |
maxResults(Integer maxResults)
The maximum number of task results returned by
ListTasks in paginated output. |
ListTasksRequest.Builder |
nextToken(String nextToken)
The
nextToken value returned from a previous paginated ListTasks request where
maxResults was used and the results exceeded the value of that parameter. |
ListTasksRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ListTasksRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
ListTasksRequest.Builder |
serviceName(String serviceName)
The name of the service with which to filter the
ListTasks results. |
ListTasksRequest.Builder |
startedBy(String startedBy)
The
startedBy value with which to filter the task results. |
buildoverrideConfigurationcopyapplyMutation, buildListTasksRequest.Builder cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.
cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you
do not specify a cluster, the default cluster is assumed.ListTasksRequest.Builder containerInstance(String containerInstance)
The container instance ID or full ARN of the container instance with which to filter the
ListTasks results. Specifying a containerInstance limits the results to tasks that
belong to that container instance.
containerInstance - The container instance ID or full ARN of the container instance with which to filter the
ListTasks results. Specifying a containerInstance limits the results to
tasks that belong to that container instance.ListTasksRequest.Builder family(String family)
The name of the family with which to filter the ListTasks results. Specifying a
family limits the results to tasks that belong to that family.
family - The name of the family with which to filter the ListTasks results. Specifying a
family limits the results to tasks that belong to that family.ListTasksRequest.Builder nextToken(String nextToken)
The nextToken value returned from a previous paginated ListTasks 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 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 - The nextToken value returned from a previous paginated ListTasks 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 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.
ListTasksRequest.Builder maxResults(Integer maxResults)
The maximum number of task results returned by ListTasks in paginated output. When this
parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can
be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results
and a nextToken value if applicable.
maxResults - The maximum number of task results returned by ListTasks in paginated output. When this
parameter is used, ListTasks 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 ListTasks request with the returned
nextToken value. This value can be between 1 and 100. If this parameter is not used, then
ListTasks returns up to 100 results and a nextToken value if applicable.ListTasksRequest.Builder startedBy(String startedBy)
The startedBy value with which to filter the task results. Specifying a startedBy
value limits the results to tasks that were started with that value.
startedBy - The startedBy value with which to filter the task results. Specifying a
startedBy value limits the results to tasks that were started with that value.ListTasksRequest.Builder serviceName(String serviceName)
The name of the service with which to filter the ListTasks results. Specifying a
serviceName limits the results to tasks that belong to that service.
serviceName - The name of the service with which to filter the ListTasks results. Specifying a
serviceName limits the results to tasks that belong to that service.ListTasksRequest.Builder desiredStatus(String desiredStatus)
The task desired status with which to filter the ListTasks results. Specifying a
desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the
desired status to STOPPED. This can be useful for debugging tasks that are not starting properly
or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon
ECS has set the desired status to RUNNING.
Although you can filter results based on a desired status of PENDING, this does not return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's
lastStatus may have a value of PENDING).
desiredStatus - The task desired status with which to filter the ListTasks results. Specifying a
desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set
the desired status to STOPPED. This can be useful for debugging tasks that are not
starting properly or have died or finished. The default status filter is RUNNING, which
shows tasks that Amazon ECS has set the desired status to RUNNING.
Although you can filter results based on a desired status of PENDING, this does not
return any results. Amazon ECS never sets the desired status of a task to that value (only a task's
lastStatus may have a value of PENDING).
DesiredStatus,
DesiredStatusListTasksRequest.Builder desiredStatus(DesiredStatus desiredStatus)
The task desired status with which to filter the ListTasks results. Specifying a
desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the
desired status to STOPPED. This can be useful for debugging tasks that are not starting properly
or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon
ECS has set the desired status to RUNNING.
Although you can filter results based on a desired status of PENDING, this does not return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's
lastStatus may have a value of PENDING).
desiredStatus - The task desired status with which to filter the ListTasks results. Specifying a
desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set
the desired status to STOPPED. This can be useful for debugging tasks that are not
starting properly or have died or finished. The default status filter is RUNNING, which
shows tasks that Amazon ECS has set the desired status to RUNNING.
Although you can filter results based on a desired status of PENDING, this does not
return any results. Amazon ECS never sets the desired status of a task to that value (only a task's
lastStatus may have a value of PENDING).
DesiredStatus,
DesiredStatusListTasksRequest.Builder launchType(String launchType)
The launch type for services to list.
launchType - The launch type for services to list.LaunchType,
LaunchTypeListTasksRequest.Builder launchType(LaunchType launchType)
The launch type for services to list.
launchType - The launch type for services to list.LaunchType,
LaunchTypeListTasksRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.ListTasksRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.