@Generated(value="software.amazon.awssdk:codegen") public final class ListTasksRequest extends EcsRequest implements ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListTasksRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ListTasksRequest.Builder |
builder() |
String |
cluster()
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.
|
String |
containerInstance()
The container instance ID or full ARN of the container instance with which to filter the
ListTasks
results. |
DesiredStatus |
desiredStatus()
The task desired status with which to filter the
ListTasks results. |
String |
desiredStatusAsString()
The task desired status with which to filter the
ListTasks results. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
family()
The name of the family with which to filter the
ListTasks results. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
LaunchType |
launchType()
The launch type for services to list.
|
String |
launchTypeAsString()
The launch type for services to list.
|
Integer |
maxResults()
The maximum number of task results returned by
ListTasks in paginated output. |
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. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListTasksRequest.Builder> |
serializableBuilderClass() |
String |
serviceName()
The name of the service with which to filter the
ListTasks results. |
String |
startedBy()
The
startedBy value with which to filter the task results. |
ListTasksRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final 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.
public final String containerInstance()
The container instance ID or full 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 final 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.
ListTasks
results. Specifying a
family
limits the results to tasks that belong to that family.public final 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 is
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 is 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 final 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.
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 final 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
value with which to filter the task results. Specifying a
startedBy
value limits the results to tasks that were started with that value.public final 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.
ListTasks
results. Specifying a
serviceName
limits the results to tasks that belong to that service.public final DesiredStatus desiredStatus()
The task desired status with which to filter 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 are not 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 does not 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
).
If the service returns an enum value that is not available in the current SDK version, desiredStatus
will return DesiredStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
desiredStatusAsString()
.
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 are not 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 does not 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 final String desiredStatusAsString()
The task desired status with which to filter 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 are not 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 does not 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
).
If the service returns an enum value that is not available in the current SDK version, desiredStatus
will return DesiredStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
desiredStatusAsString()
.
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 are not 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 does not 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 final LaunchType launchType()
The launch type for services to list.
If the service returns an enum value that is not available in the current SDK version, launchType
will
return LaunchType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
launchTypeAsString()
.
LaunchType
public final String launchTypeAsString()
The launch type for services to list.
If the service returns an enum value that is not available in the current SDK version, launchType
will
return LaunchType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
launchTypeAsString()
.
LaunchType
public ListTasksRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>
toBuilder
in class EcsRequest
public static ListTasksRequest.Builder builder()
public static Class<? extends ListTasksRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.