public class ListTasksRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
ListTasksRequest() |
| 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 to list.
|
String |
getContainerInstance()
The container instance ID or full Amazon Resource Name (ARN) of the
container instance with which to filter the
ListTasks
results. |
String |
getDesiredStatus()
The task status with which to filter the
ListTasks results. |
String |
getFamily()
The name of the family with which to filter the
ListTasks
results. |
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 with which to filter the
ListTasks
results. |
String |
getStartedBy()
The
startedBy 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 the
ListTasks
results. |
void |
setDesiredStatus(DesiredStatus desiredStatus)
The task status with which to filter the
ListTasks results. |
void |
setDesiredStatus(String desiredStatus)
The task status with which to filter the
ListTasks results. |
void |
setFamily(String family)
The name of the family with which to filter the
ListTasks
results. |
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 with which to filter the
ListTasks
results. |
void |
setStartedBy(String startedBy)
The
startedBy 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 the
ListTasks
results. |
ListTasksRequest |
withDesiredStatus(DesiredStatus desiredStatus)
The task status with which to filter the
ListTasks results. |
ListTasksRequest |
withDesiredStatus(String desiredStatus)
The task status with which to filter the
ListTasks results. |
ListTasksRequest |
withFamily(String family)
The name of the family with which to filter the
ListTasks
results. |
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 with which to filter the
ListTasks
results. |
ListTasksRequest |
withStartedBy(String startedBy)
The
startedBy value with which to filter the task results. |
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic 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..
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..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..
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..
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..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 a containerInstance limits the results
to tasks that belong to that container instance.
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.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 a containerInstance limits the results
to tasks that belong to that container instance.
ListTasks results. Specifying a
containerInstance limits the results to tasks that
belong to that container instance.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 a containerInstance limits the results
to tasks that belong to that container instance.
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.public void setFamily(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.
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.public String getFamily()
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.
ListTasks results. Specifying a family
limits the results to tasks that belong to that family.public ListTasksRequest withFamily(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.
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.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.
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.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.
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.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.
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.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.
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.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.
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.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.
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.public void setStartedBy(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.
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.public String getStartedBy()
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.
startedBy value with which to filter the task
results. Specifying a startedBy value limits the
results to tasks that were started with that value.public ListTasksRequest withStartedBy(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.
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.public void setServiceName(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.
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.public String getServiceName()
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.
ListTasks results. Specifying a
serviceName limits the results to tasks that belong
to that service.public ListTasksRequest withServiceName(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.
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.public void setDesiredStatus(String desiredStatus)
The task status with which to filter the ListTasks results.
Specifying a desiredStatus of STOPPED limits
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.
desiredStatus - The task status with which to filter the ListTasks
results. Specifying a desiredStatus of
STOPPED limits 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.DesiredStatuspublic String getDesiredStatus()
The task status with which to filter the ListTasks results.
Specifying a desiredStatus of STOPPED limits
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.
ListTasks
results. Specifying a desiredStatus of
STOPPED limits 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.DesiredStatuspublic ListTasksRequest withDesiredStatus(String desiredStatus)
The task status with which to filter the ListTasks results.
Specifying a desiredStatus of STOPPED limits
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.
desiredStatus - The task status with which to filter the ListTasks
results. Specifying a desiredStatus of
STOPPED limits 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.DesiredStatuspublic void setDesiredStatus(DesiredStatus desiredStatus)
The task status with which to filter the ListTasks results.
Specifying a desiredStatus of STOPPED limits
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.
desiredStatus - The task status with which to filter the ListTasks
results. Specifying a desiredStatus of
STOPPED limits 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.DesiredStatuspublic ListTasksRequest withDesiredStatus(DesiredStatus desiredStatus)
The task status with which to filter the ListTasks results.
Specifying a desiredStatus of STOPPED limits
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.
desiredStatus - The task status with which to filter the ListTasks
results. Specifying a desiredStatus of
STOPPED limits 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.DesiredStatuspublic String toString()
toString in class ObjectObject.toString()public ListTasksRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.