com.amazonaws.services.ecs.model

Class ListTasksRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.ListTasksRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListTasksRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListTasks operation.

Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family , containerInstance , and desiredStatus parameters.

See Also:

AmazonECS.listTasks(ListTasksRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListTasksRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListTasksRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list.
String	getContainerInstance() The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with.
String	getDesiredStatus() The task status that you want to filter the ListTasks results with.
String	getFamily() The name of the family that you want to filter the ListTasks results with.
Integer	getMaxResults() The maximum number of task results returned by ListTasks in paginated output.
String	getNextToken() The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter.
String	getServiceName() The name of the service that you want to filter the ListTasks results with.
String	getStartedBy() The startedBy value that you want to filter the task results with.
int	hashCode()
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list.
void	setContainerInstance(String containerInstance) The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with.
void	setDesiredStatus(DesiredStatus desiredStatus) The task status that you want to filter the ListTasks results with.
void	setDesiredStatus(String desiredStatus) The task status that you want to filter the ListTasks results with.
void	setFamily(String family) The name of the family that you want to filter the ListTasks results with.
void	setMaxResults(Integer maxResults) The maximum number of task results returned by ListTasks in paginated output.
void	setNextToken(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.
void	setServiceName(String serviceName) The name of the service that you want to filter the ListTasks results with.
void	setStartedBy(String startedBy) The startedBy value that you want to filter the task results with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListTasksRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list.
ListTasksRequest	withContainerInstance(String containerInstance) The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with.
ListTasksRequest	withDesiredStatus(DesiredStatus desiredStatus) The task status that you want to filter the ListTasks results with.
ListTasksRequest	withDesiredStatus(String desiredStatus) The task status that you want to filter the ListTasks results with.
ListTasksRequest	withFamily(String family) The name of the family that you want to filter the ListTasks results with.
ListTasksRequest	withMaxResults(Integer maxResults) The maximum number of task results returned by ListTasks in paginated output.
ListTasksRequest	withNextToken(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	withServiceName(String serviceName) The name of the service that you want to filter the ListTasks results with.
ListTasksRequest	withStartedBy(String startedBy) The startedBy value that you want to filter the task results with.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListTasksRequest

public ListTasksRequest()

Method Detail

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want 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 you want to list. If you do not specify a cluster, the default cluster is assumed..

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want 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 tasks you want to list. If you do not specify a cluster, the default cluster is assumed..

withCluster

public ListTasksRequest withCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list. If you do not specify a cluster, the default cluster is assumed..

Returns a reference to this object so that method calls can be chained together.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list. If you do not specify a cluster, the default cluster is assumed..

Returns:

A reference to this updated object so that method calls can be chained together.

getContainerInstance

public String getContainerInstance()

The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.

Returns:

The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.

setContainerInstance

public void setContainerInstance(String containerInstance)

The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.

Parameters:

containerInstance - The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.

withContainerInstance

public ListTasksRequest withContainerInstance(String containerInstance)

The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

containerInstance - The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getFamily

public String getFamily()

The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.

Returns:

The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.

setFamily

public void setFamily(String family)

The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.

Parameters:

family - The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.

withFamily

public ListTasksRequest withFamily(String family)

The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.

Returns a reference to this object so that method calls can be chained together.

Parameters:

family - The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

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.

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.

setNextToken

public void setNextToken(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.

Parameters:

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.

withNextToken

public ListTasksRequest withNextToken(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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

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.

setMaxResults

public void setMaxResults(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.

Parameters:

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.

withMaxResults

public ListTasksRequest withMaxResults(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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getStartedBy

public String getStartedBy()

The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.

Returns:

The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.

setStartedBy

public void setStartedBy(String startedBy)

The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.

Parameters:

startedBy - The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.

withStartedBy

public ListTasksRequest withStartedBy(String startedBy)

The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.

Returns a reference to this object so that method calls can be chained together.

Parameters:

startedBy - The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.

Returns:

A reference to this updated object so that method calls can be chained together.

getServiceName

public String getServiceName()

The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit the results to tasks that belong to that service.

Returns:

The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit the results to tasks that belong to that service.

setServiceName

public void setServiceName(String serviceName)

The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit the results to tasks that belong to that service.

Parameters:

serviceName - The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit the results to tasks that belong to that service.

withServiceName

public ListTasksRequest withServiceName(String serviceName)

The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit the results to tasks that belong to that service.

Returns a reference to this object so that method calls can be chained together.

Parameters:

serviceName - The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit the results to tasks that belong to that service.

Returns:

A reference to this updated object so that method calls can be chained together.

getDesiredStatus

public String getDesiredStatus()

The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

Constraints:
Allowed Values: RUNNING, PENDING, STOPPED

Returns:

The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

See Also:

DesiredStatus

setDesiredStatus

public void setDesiredStatus(String desiredStatus)

The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

Constraints:
Allowed Values: RUNNING, PENDING, STOPPED

Parameters:

desiredStatus - The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

See Also:

DesiredStatus

withDesiredStatus

public ListTasksRequest withDesiredStatus(String desiredStatus)

The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: RUNNING, PENDING, STOPPED

Parameters:

desiredStatus - The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DesiredStatus

setDesiredStatus

public void setDesiredStatus(DesiredStatus desiredStatus)

The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

Constraints:
Allowed Values: RUNNING, PENDING, STOPPED

Parameters:

desiredStatus - The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

See Also:

DesiredStatus

withDesiredStatus

public ListTasksRequest withDesiredStatus(DesiredStatus desiredStatus)

The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: RUNNING, PENDING, STOPPED

Parameters:

desiredStatus - The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DesiredStatus

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ListTasksRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()