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
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListTasksRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 to list.String
getContainerInstance()
The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter theListTasks
results.String
getDesiredStatus()
The task status with which to filter theListTasks
results.String
getFamily()
The name of the family with which to filter theListTasks
results.Integer
getMaxResults()
The maximum number of task results returned byListTasks
in paginated output.String
getNextToken()
ThenextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter.String
getServiceName()
The name of the service with which to filter theListTasks
results.String
getStartedBy()
ThestartedBy
value with which to filter the task results.int
hashCode()
void
setCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.void
setContainerInstance(String containerInstance)
The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter theListTasks
results.void
setDesiredStatus(DesiredStatus desiredStatus)
The task status with which to filter theListTasks
results.void
setDesiredStatus(String desiredStatus)
The task status with which to filter theListTasks
results.void
setFamily(String family)
The name of the family with which to filter theListTasks
results.void
setMaxResults(Integer maxResults)
The maximum number of task results returned byListTasks
in paginated output.void
setNextToken(String nextToken)
ThenextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter.void
setServiceName(String serviceName)
The name of the service with which to filter theListTasks
results.void
setStartedBy(String startedBy)
ThestartedBy
value with which to filter the task results.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 to list.ListTasksRequest
withContainerInstance(String containerInstance)
The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter theListTasks
results.ListTasksRequest
withDesiredStatus(DesiredStatus desiredStatus)
The task status with which to filter theListTasks
results.ListTasksRequest
withDesiredStatus(String desiredStatus)
The task status with which to filter theListTasks
results.ListTasksRequest
withFamily(String family)
The name of the family with which to filter theListTasks
results.ListTasksRequest
withMaxResults(Integer maxResults)
The maximum number of task results returned byListTasks
in paginated output.ListTasksRequest
withNextToken(String nextToken)
ThenextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter.ListTasksRequest
withServiceName(String serviceName)
The name of the service with which to filter theListTasks
results.ListTasksRequest
withStartedBy(String startedBy)
ThestartedBy
value with which to filter the task results.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setCluster
public void setCluster(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..
- Parameters:
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..
-
getCluster
public String getCluster()
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..
-
withCluster
public ListTasksRequest withCluster(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..
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setContainerInstance
public void setContainerInstance(String containerInstance)
The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the
ListTasks
results. Specifying acontainerInstance
limits the results to tasks that belong to that container instance.- Parameters:
containerInstance
- The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter theListTasks
results. Specifying acontainerInstance
limits the results to tasks that belong to that container instance.
-
getContainerInstance
public String getContainerInstance()
The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the
ListTasks
results. Specifying acontainerInstance
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 acontainerInstance
limits the results to tasks that belong to that container instance.
-
withContainerInstance
public ListTasksRequest withContainerInstance(String containerInstance)
The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the
ListTasks
results. Specifying acontainerInstance
limits the results to tasks that belong to that container instance.- Parameters:
containerInstance
- The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter theListTasks
results. Specifying acontainerInstance
limits the results to tasks that belong to that container instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFamily
public void setFamily(String family)
The name of the family with which to filter the
ListTasks
results. Specifying afamily
limits the results to tasks that belong to that family.- Parameters:
family
- The name of the family with which to filter theListTasks
results. Specifying afamily
limits the results to tasks that belong to that family.
-
getFamily
public String getFamily()
The name of the family with which to filter the
ListTasks
results. Specifying afamily
limits the results to tasks that belong to that family.- Returns:
- The name of the family with which to filter the
ListTasks
results. Specifying afamily
limits the results to tasks that belong to that family.
-
withFamily
public ListTasksRequest withFamily(String family)
The name of the family with which to filter the
ListTasks
results. Specifying afamily
limits the results to tasks that belong to that family.- Parameters:
family
- The name of the family with which to filter theListTasks
results. Specifying afamily
limits the results to tasks that belong to that family.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
public void setNextToken(String nextToken)
The
nextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
- Parameters:
nextToken
- ThenextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
-
getNextToken
public String getNextToken()
The
nextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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 paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
-
withNextToken
public ListTasksRequest withNextToken(String nextToken)
The
nextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
- Parameters:
nextToken
- ThenextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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:
- Returns a reference to this object so that method calls can be chained together.
-
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 returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTasks
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTasks
returns up to 100 results and anextToken
value if applicable.- Parameters:
maxResults
- The maximum number of task results returned byListTasks
in paginated output. When this parameter is used,ListTasks
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTasks
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTasks
returns up to 100 results and anextToken
value if applicable.
-
getMaxResults
public Integer getMaxResults()
The maximum number of task results returned by
ListTasks
in paginated output. When this parameter is used,ListTasks
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTasks
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTasks
returns up to 100 results and anextToken
value if applicable.- Returns:
- The maximum number of task results returned by
ListTasks
in paginated output. When this parameter is used,ListTasks
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTasks
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTasks
returns up to 100 results and anextToken
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 returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTasks
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTasks
returns up to 100 results and anextToken
value if applicable.- Parameters:
maxResults
- The maximum number of task results returned byListTasks
in paginated output. When this parameter is used,ListTasks
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTasks
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTasks
returns up to 100 results and anextToken
value if applicable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStartedBy
public void setStartedBy(String startedBy)
The
startedBy
value with which to filter the task results. Specifying astartedBy
value limits the results to tasks that were started with that value.- Parameters:
startedBy
- ThestartedBy
value with which to filter the task results. Specifying astartedBy
value limits the results to tasks that were started with that value.
-
getStartedBy
public String getStartedBy()
The
startedBy
value with which to filter the task results. Specifying astartedBy
value limits the results to tasks that were started with that value.- Returns:
- The
startedBy
value with which to filter the task results. Specifying astartedBy
value limits the results to tasks that were started with that value.
-
withStartedBy
public ListTasksRequest withStartedBy(String startedBy)
The
startedBy
value with which to filter the task results. Specifying astartedBy
value limits the results to tasks that were started with that value.- Parameters:
startedBy
- ThestartedBy
value with which to filter the task results. Specifying astartedBy
value limits the results to tasks that were started with that value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setServiceName
public void setServiceName(String serviceName)
The name of the service with which to filter the
ListTasks
results. Specifying aserviceName
limits the results to tasks that belong to that service.- Parameters:
serviceName
- The name of the service with which to filter theListTasks
results. Specifying aserviceName
limits the results to tasks that belong to that service.
-
getServiceName
public String getServiceName()
The name of the service with which to filter the
ListTasks
results. Specifying aserviceName
limits the results to tasks that belong to that service.- Returns:
- The name of the service with which to filter the
ListTasks
results. Specifying aserviceName
limits the results to tasks that belong to that service.
-
withServiceName
public ListTasksRequest withServiceName(String serviceName)
The name of the service with which to filter the
ListTasks
results. Specifying aserviceName
limits the results to tasks that belong to that service.- Parameters:
serviceName
- The name of the service with which to filter theListTasks
results. Specifying aserviceName
limits the results to tasks that belong to that service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDesiredStatus
public void setDesiredStatus(String desiredStatus)
The task status with which to filter the
ListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
.- Parameters:
desiredStatus
- The task status with which to filter theListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
.- See Also:
DesiredStatus
-
getDesiredStatus
public String getDesiredStatus()
The task status with which to filter the
ListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
.- Returns:
- The task status with which to filter the
ListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
. - See Also:
DesiredStatus
-
withDesiredStatus
public ListTasksRequest withDesiredStatus(String desiredStatus)
The task status with which to filter the
ListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
.- Parameters:
desiredStatus
- The task status with which to filter theListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DesiredStatus
-
setDesiredStatus
public void setDesiredStatus(DesiredStatus desiredStatus)
The task status with which to filter the
ListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
.- Parameters:
desiredStatus
- The task status with which to filter theListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
.- See Also:
DesiredStatus
-
withDesiredStatus
public ListTasksRequest withDesiredStatus(DesiredStatus desiredStatus)
The task status with which to filter the
ListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
.- Parameters:
desiredStatus
- The task status with which to filter theListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that are in theSTOPPED
status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-