ListTasksRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ecs.model.EcsRequest
    - - software.amazon.awssdk.services.ecs.model.ListTasksRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListTasksRequest
extends EcsRequest
implements ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListTasksRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListTasksRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListTasksRequest.Builder`	`builder()`
`String`	`cluster()` The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the `ListTasks` results.
`String`	`containerInstance()` The container instance ID or full ARN of the container instance to use when filtering the `ListTasks` results.
`DesiredStatus`	`desiredStatus()` The task desired status to use when filtering the `ListTasks` results.
`String`	`desiredStatusAsString()` The task desired status to use when filtering 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 task definition family to use when filtering 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 to use when filtering the `ListTasks` results.
`String`	`launchTypeAsString()` The launch type to use when filtering the `ListTasks` results.
`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 to use when filtering 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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - cluster
```
public final 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.
    
    Returns:
    
    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.
  - containerInstance
```
public final 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.
    
    Returns:
    
    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.
  - family
```
public final 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.
    
    Returns:
    
    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.
  - nextToken
```
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.
    
    Returns:
    
    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.
  - maxResults
```
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.
    
    Returns:
    
    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.
  - startedBy
```
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.
    
    Returns:
    
    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.
  - serviceName
```
public final 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.
    
    Returns:
    
    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.
  - desiredStatus
```
public final 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 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().
    
    Returns:
    
    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 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).
    
    See Also:
    
    DesiredStatus
  - desiredStatusAsString
```
public final String desiredStatusAsString()
```
    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 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().
    
    Returns:
    
    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 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).
    
    See Also:
    
    DesiredStatus
  - launchType
```
public final LaunchType launchType()
```
    The launch type to use when filtering the ListTasks results.
    
    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().
    
    Returns:
    
    The launch type to use when filtering the ListTasks results.
    
    See Also:
    
    LaunchType
  - launchTypeAsString
```
public final String launchTypeAsString()
```
    The launch type to use when filtering the ListTasks results.
    
    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().
    
    Returns:
    
    The launch type to use when filtering the ListTasks results.
    
    See Also:
    
    LaunchType
  - toBuilder
```
public ListTasksRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>
    
    Specified by:
    
    toBuilder in class EcsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListTasksRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListTasksRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.83

Class ListTasksRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

cluster

containerInstance

family

nextToken

maxResults

startedBy

serviceName

desiredStatus

desiredStatusAsString

launchType

launchTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields