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 to use when filtering the
ListTasks results. |
ListTasksRequest.Builder |
containerInstance(String containerInstance)
The container instance ID or full ARN of the container instance to use when filtering the
ListTasks results. |
ListTasksRequest.Builder |
desiredStatus(DesiredStatus desiredStatus)
The task desired status to use when filtering the
ListTasks results. |
ListTasksRequest.Builder |
desiredStatus(String desiredStatus)
The task desired status to use when filtering the
ListTasks results. |
ListTasksRequest.Builder |
family(String family)
The name of the task definition family to use when filtering the
ListTasks results. |
ListTasksRequest.Builder |
launchType(LaunchType launchType)
The launch type to use when filtering the
ListTasks results. |
ListTasksRequest.Builder |
launchType(String launchType)
The launch type to use when filtering the
ListTasks results. |
ListTasksRequest.Builder |
maxResults(Integer maxResults)
The maximum number of task results that
ListTasks returned in paginated output. |
ListTasksRequest.Builder |
nextToken(String nextToken)
The
nextToken value returned from a ListTasks request indicating that more results
are available to fulfill the request and further calls will be needed. |
ListTasksRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
ListTasksRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
ListTasksRequest.Builder |
serviceName(String serviceName)
The name of the service to use when filtering the
ListTasks results. |
ListTasksRequest.Builder |
startedBy(String startedBy)
The
startedBy value to filter the task results with. |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildListTasksRequest.Builder cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
ListTasks results. 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 to use when filtering the
ListTasks results. 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 to use when filtering 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 to use when filtering 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 task definition family to use when filtering the ListTasks results. Specifying a
family limits the results to tasks that belong to that family.
family - The name of the task definition family to use when filtering 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 ListTasks request indicating that more results
are available to fulfill the request and further calls will be 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.
nextToken - The nextToken value returned from a ListTasks request indicating that more
results are available to fulfill the request and further calls will be 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.
ListTasksRequest.Builder maxResults(Integer maxResults)
The maximum number of task results that ListTasks returned 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 isn't used, then ListTasks returns up to 100 results and
a nextToken value if applicable.
maxResults - The maximum number of task results that ListTasks returned 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 isn't used, then
ListTasks returns up to 100 results and a nextToken value if applicable.ListTasksRequest.Builder startedBy(String startedBy)
The startedBy value to filter the task results with. Specifying a startedBy value
limits the results to tasks that were started with that value.
When you specify startedBy as the filter, it must be the only filter that you use.
startedBy - The startedBy value to filter the task results with. Specifying a startedBy
value limits the results to tasks that were started with that value.
When you specify startedBy as the filter, it must be the only filter that you use.
ListTasksRequest.Builder serviceName(String serviceName)
The name of the service to use when filtering the ListTasks results. Specifying a
serviceName limits the results to tasks that belong to that service.
serviceName - The name of the service to use when filtering 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 to use when filtering 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 aren't 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 doesn't 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 to use when filtering 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 aren't
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 doesn't 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 to use when filtering 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 aren't 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 doesn't 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 to use when filtering 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 aren't
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 doesn't 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 to use when filtering the ListTasks results.
launchType - The launch type to use when filtering the ListTasks results.LaunchType,
LaunchTypeListTasksRequest.Builder launchType(LaunchType launchType)
The launch type to use when filtering the ListTasks results.
launchType - The launch type to use when filtering the ListTasks results.LaunchType,
LaunchTypeListTasksRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderListTasksRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.