@Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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 object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getCluster()
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
ListTasks
results. |
String |
getContainerInstance()
The container instance ID or full ARN of the container instance to use when filtering the
ListTasks
results. |
String |
getDesiredStatus()
The task desired status to use when filtering the
ListTasks results. |
String |
getFamily()
The name of the task definition family to use when filtering the
ListTasks results. |
String |
getLaunchType()
The launch type to use when filtering the
ListTasks results. |
Integer |
getMaxResults()
The maximum number of task results that
ListTasks returned in paginated output. |
String |
getNextToken()
The
nextToken value returned from a ListTasks request indicating that more results are
available to fulfill the request and further calls will be needed. |
String |
getServiceName()
The name of the service to use when filtering the
ListTasks results. |
String |
getStartedBy()
The
startedBy value to filter the task results with. |
int |
hashCode() |
void |
setCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
ListTasks
results. |
void |
setContainerInstance(String containerInstance)
The container instance ID or full ARN of the container instance to use when filtering the
ListTasks
results. |
void |
setDesiredStatus(DesiredStatus desiredStatus)
The task desired status to use when filtering the
ListTasks results. |
void |
setDesiredStatus(String desiredStatus)
The task desired status to use when filtering the
ListTasks results. |
void |
setFamily(String family)
The name of the task definition family to use when filtering the
ListTasks results. |
void |
setLaunchType(LaunchType launchType)
The launch type to use when filtering the
ListTasks results. |
void |
setLaunchType(String launchType)
The launch type to use when filtering the
ListTasks results. |
void |
setMaxResults(Integer maxResults)
The maximum number of task results that
ListTasks returned in paginated output. |
void |
setNextToken(String nextToken)
The
nextToken value returned from a ListTasks request indicating that more results are
available to fulfill the request and further calls will be needed. |
void |
setServiceName(String serviceName)
The name of the service to use when filtering the
ListTasks results. |
void |
setStartedBy(String startedBy)
The
startedBy value to filter the task results with. |
String |
toString()
Returns a string representation of this object.
|
ListTasksRequest |
withCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
ListTasks
results. |
ListTasksRequest |
withContainerInstance(String containerInstance)
The container instance ID or full ARN of the container instance to use when filtering the
ListTasks
results. |
ListTasksRequest |
withDesiredStatus(DesiredStatus desiredStatus)
The task desired status to use when filtering the
ListTasks results. |
ListTasksRequest |
withDesiredStatus(String desiredStatus)
The task desired status to use when filtering the
ListTasks results. |
ListTasksRequest |
withFamily(String family)
The name of the task definition family to use when filtering the
ListTasks results. |
ListTasksRequest |
withLaunchType(LaunchType launchType)
The launch type to use when filtering the
ListTasks results. |
ListTasksRequest |
withLaunchType(String launchType)
The launch type to use when filtering the
ListTasks results. |
ListTasksRequest |
withMaxResults(Integer maxResults)
The maximum number of task results that
ListTasks returned in paginated output. |
ListTasksRequest |
withNextToken(String nextToken)
The
nextToken value returned from a ListTasks request indicating that more results are
available to fulfill the request and further calls will be needed. |
ListTasksRequest |
withServiceName(String serviceName)
The name of the service to use when filtering the
ListTasks results. |
ListTasksRequest |
withStartedBy(String startedBy)
The
startedBy value to filter the task results with. |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks
results. 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 to use when filtering the
ListTasks
results. 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 to use when filtering the ListTasks
results. If you do not specify a cluster, the default cluster is assumed.
ListTasks
results. 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 to use when filtering the ListTasks
results. 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 to use when filtering the
ListTasks
results. If you do not specify a cluster, the default cluster is assumed.public void setContainerInstance(String containerInstance)
The container instance ID or full ARN of the container instance to use when filtering the ListTasks
results. Specifying a containerInstance
limits the results to tasks that belong to that container
instance.
containerInstance
- The container instance ID or full ARN of the container instance to use when filtering 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 ARN of the container instance to use when filtering 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 ARN of the container instance to use when filtering the ListTasks
results. Specifying a containerInstance
limits the results to tasks that belong to that container
instance.
containerInstance
- The container instance ID or full ARN of the container instance to use when filtering 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 task definition family to use when filtering the ListTasks
results. Specifying a
family
limits the results to tasks that belong to that family.
family
- The name of the task definition family to use when filtering the ListTasks
results.
Specifying a family
limits the results to tasks that belong to that family.public String getFamily()
The name of the task definition family to use when filtering 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 task definition family to use when filtering the ListTasks
results. Specifying a
family
limits the results to tasks that belong to that family.
family
- The name of the task definition family to use when filtering 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 ListTasks
request indicating that more results are
available to fulfill the request and further calls will be needed. If maxResults
was provided, it's
possible the number of results to be fewer than maxResults
.
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.
nextToken
- The nextToken
value returned from a ListTasks
request indicating that more
results are available to fulfill the request and further calls will be needed. If maxResults
was provided, it's possible the number of results to be fewer than maxResults
. 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.
public String getNextToken()
The nextToken
value returned from a ListTasks
request indicating that more results are
available to fulfill the request and further calls will be needed. If maxResults
was provided, it's
possible the number of results to be fewer than maxResults
.
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.
nextToken
value returned from a ListTasks
request indicating that more
results are available to fulfill the request and further calls will be needed. If maxResults
was provided, it's possible the number of results to be fewer than maxResults
. 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.
public ListTasksRequest withNextToken(String nextToken)
The nextToken
value returned from a ListTasks
request indicating that more results are
available to fulfill the request and further calls will be needed. If maxResults
was provided, it's
possible the number of results to be fewer than maxResults
.
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.
nextToken
- The nextToken
value returned from a ListTasks
request indicating that more
results are available to fulfill the request and further calls will be needed. If maxResults
was provided, it's possible the number of results to be fewer than maxResults
. 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.
public void setMaxResults(Integer maxResults)
The maximum number of task results that ListTasks
returned 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 isn't used, then ListTasks
returns up to 100 results and a
nextToken
value if applicable.
maxResults
- The maximum number of task results that ListTasks
returned 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 isn't used, then ListTasks
returns up
to 100 results and a nextToken
value if applicable.public Integer getMaxResults()
The maximum number of task results that ListTasks
returned 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 isn't used, then ListTasks
returns up to 100 results and a
nextToken
value if applicable.
ListTasks
returned 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 isn't 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 that ListTasks
returned 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 isn't used, then ListTasks
returns up to 100 results and a
nextToken
value if applicable.
maxResults
- The maximum number of task results that ListTasks
returned 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 isn't used, then ListTasks
returns up
to 100 results and a nextToken
value if applicable.public void setStartedBy(String startedBy)
The startedBy
value to filter the task results with. Specifying a startedBy
value
limits the results to tasks that were started with that value.
When you specify startedBy
as the filter, it must be the only filter that you use.
startedBy
- The startedBy
value to filter the task results with. Specifying a startedBy
value limits the results to tasks that were started with that value.
When you specify startedBy
as the filter, it must be the only filter that you use.
public String getStartedBy()
The startedBy
value to filter the task results with. Specifying a startedBy
value
limits the results to tasks that were started with that value.
When you specify startedBy
as the filter, it must be the only filter that you use.
startedBy
value to filter the task results with. Specifying a startedBy
value limits the results to tasks that were started with that value.
When you specify startedBy
as the filter, it must be the only filter that you use.
public ListTasksRequest withStartedBy(String startedBy)
The startedBy
value to filter the task results with. Specifying a startedBy
value
limits the results to tasks that were started with that value.
When you specify startedBy
as the filter, it must be the only filter that you use.
startedBy
- The startedBy
value to filter the task results with. Specifying a startedBy
value limits the results to tasks that were started with that value.
When you specify startedBy
as the filter, it must be the only filter that you use.
public void setServiceName(String serviceName)
The name of the service to use when filtering the ListTasks
results. Specifying a
serviceName
limits the results to tasks that belong to that service.
serviceName
- The name of the service to use when filtering the ListTasks
results. Specifying a
serviceName
limits the results to tasks that belong to that service.public String getServiceName()
The name of the service to use when filtering 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 to use when filtering the ListTasks
results. Specifying a
serviceName
limits the results to tasks that belong to that service.
serviceName
- The name of the service to use when filtering the ListTasks
results. Specifying a
serviceName
limits the results to tasks that belong to that service.public void setDesiredStatus(String desiredStatus)
The task desired status to use when filtering the ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the
desired status to STOPPED
. This can be useful for debugging tasks that aren't starting properly or
have died or finished. The default status filter is RUNNING
, which shows tasks that Amazon ECS has
set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus
may have a value of PENDING
).
desiredStatus
- The task desired status to use when filtering the ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the
desired status to STOPPED
. This can be useful for debugging tasks that aren't starting
properly or have died or finished. The default status filter is RUNNING
, which shows tasks
that Amazon ECS has set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's
lastStatus
may have a value of PENDING
).
DesiredStatus
public String getDesiredStatus()
The task desired status to use when filtering the ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the
desired status to STOPPED
. This can be useful for debugging tasks that aren't starting properly or
have died or finished. The default status filter is RUNNING
, which shows tasks that Amazon ECS has
set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus
may have a value of PENDING
).
ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set
the desired status to STOPPED
. This can be useful for debugging tasks that aren't starting
properly or have died or finished. The default status filter is RUNNING
, which shows tasks
that Amazon ECS has set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return
any results. Amazon ECS never sets the desired status of a task to that value (only a task's
lastStatus
may have a value of PENDING
).
DesiredStatus
public ListTasksRequest withDesiredStatus(String desiredStatus)
The task desired status to use when filtering the ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the
desired status to STOPPED
. This can be useful for debugging tasks that aren't starting properly or
have died or finished. The default status filter is RUNNING
, which shows tasks that Amazon ECS has
set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus
may have a value of PENDING
).
desiredStatus
- The task desired status to use when filtering the ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the
desired status to STOPPED
. This can be useful for debugging tasks that aren't starting
properly or have died or finished. The default status filter is RUNNING
, which shows tasks
that Amazon ECS has set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's
lastStatus
may have a value of PENDING
).
DesiredStatus
public void setDesiredStatus(DesiredStatus desiredStatus)
The task desired status to use when filtering the ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the
desired status to STOPPED
. This can be useful for debugging tasks that aren't starting properly or
have died or finished. The default status filter is RUNNING
, which shows tasks that Amazon ECS has
set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus
may have a value of PENDING
).
desiredStatus
- The task desired status to use when filtering the ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the
desired status to STOPPED
. This can be useful for debugging tasks that aren't starting
properly or have died or finished. The default status filter is RUNNING
, which shows tasks
that Amazon ECS has set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's
lastStatus
may have a value of PENDING
).
DesiredStatus
public ListTasksRequest withDesiredStatus(DesiredStatus desiredStatus)
The task desired status to use when filtering the ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the
desired status to STOPPED
. This can be useful for debugging tasks that aren't starting properly or
have died or finished. The default status filter is RUNNING
, which shows tasks that Amazon ECS has
set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus
may have a value of PENDING
).
desiredStatus
- The task desired status to use when filtering the ListTasks
results. Specifying a
desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the
desired status to STOPPED
. This can be useful for debugging tasks that aren't starting
properly or have died or finished. The default status filter is RUNNING
, which shows tasks
that Amazon ECS has set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this doesn't return any
results. Amazon ECS never sets the desired status of a task to that value (only a task's
lastStatus
may have a value of PENDING
).
DesiredStatus
public void setLaunchType(String launchType)
The launch type to use when filtering the ListTasks
results.
launchType
- The launch type to use when filtering the ListTasks
results.LaunchType
public String getLaunchType()
The launch type to use when filtering the ListTasks
results.
ListTasks
results.LaunchType
public ListTasksRequest withLaunchType(String launchType)
The launch type to use when filtering the ListTasks
results.
launchType
- The launch type to use when filtering the ListTasks
results.LaunchType
public void setLaunchType(LaunchType launchType)
The launch type to use when filtering the ListTasks
results.
launchType
- The launch type to use when filtering the ListTasks
results.LaunchType
public ListTasksRequest withLaunchType(LaunchType launchType)
The launch type to use when filtering the ListTasks
results.
launchType
- The launch type to use when filtering the ListTasks
results.LaunchType
public String toString()
toString
in class Object
Object.toString()
public ListTasksRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()