Package software.amazon.awssdk.services.ecs.model

Class ListTasksRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ecs.model.ListTasksRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>

@Generated("software.amazon.awssdk:codegen")
public class ListTasksRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListTasksRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static ListTasksRequest.Builder	builder()
String	cluster()	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.
String	containerInstance()	The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the ListTasks results.
String	desiredStatus()	The task desired status with which to filter the ListTasks results.
boolean	equals(Object obj)
String	family()	The name of the family with which to filter the ListTasks results.
int	hashCode()
Integer	maxResults()	The maximum number of task results returned by ListTasks in paginated output.
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.
static Class<? extends ListTasksRequest.Builder>	serializableBuilderClass()
String	serviceName()	The name of the service with which to filter the ListTasks results.
String	startedBy()	The startedBy value with which to filter the task results.
ListTasksRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

cluster

public 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.

Returns:

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.

containerInstance

public String containerInstance()

The container instance ID or full Amazon Resource Name (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.

Returns:

The container instance ID or full Amazon Resource Name (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.

family

public 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.

Returns:

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.

nextToken

public 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 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:

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 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.

maxResults

public 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.

Returns:

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.

startedBy

public 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.

Returns:

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.

serviceName

public 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.

Returns:

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.

desiredStatus

public String desiredStatus()

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which 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 ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this will not return any results because ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

Returns:

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which 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 ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this will not return any results because ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

See Also:

DesiredStatus

toBuilder

public ListTasksRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>

Returns:

a builder for type T

builder

public static ListTasksRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListTasksRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object