Class ListTasksRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter theListTasks
results.The task status with which to filter theListTasks
results.The name of the family with which to filter theListTasks
results.The maximum number of task results returned byListTasks
in paginated output.ThenextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter.The name of the service with which to filter theListTasks
results.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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withCluster
(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.withContainerInstance
(String containerInstance) The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter theListTasks
results.withDesiredStatus
(DesiredStatus desiredStatus) The task status with which to filter theListTasks
results.withDesiredStatus
(String desiredStatus) The task status with which to filter theListTasks
results.withFamily
(String family) The name of the family with which to filter theListTasks
results.withMaxResults
(Integer maxResults) The maximum number of task results returned byListTasks
in paginated output.withNextToken
(String nextToken) ThenextToken
value returned from a previous paginatedListTasks
request wheremaxResults
was used and the results exceeded the value of that parameter.withServiceName
(String serviceName) The name of the service with which to filter theListTasks
results.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
-
Constructor Details
-
ListTasksRequest
public ListTasksRequest()
-
-
Method Details
-
setCluster
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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:
-
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:
-
withDesiredStatus
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:
-
setDesiredStatus
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:
-
withDesiredStatus
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:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-