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:: ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>

@Generated(value="software.amazon.awssdk:codegen")
public 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 that hosts the tasks to list.
`String`	`containerInstance()` The container instance ID or full Amazon Resource Name (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)`
`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()`
`Integer`	`maxResults()` The maximum number of task results returned by `ListTasks` in paginated output.
`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.
`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()`

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

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 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.
    
    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.
  - containerInstance
```
public 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.
    
    Returns:
    
    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.
  - family
```
public 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.
    
    Returns:
    
    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.
  - nextToken
```
public 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.
    
    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 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.
    
    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 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 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 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.
    
    Returns:
    
    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.
  - desiredStatus
```
public DesiredStatus desiredStatus()
```
    The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which 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 ECS has set the desired status to RUNNING.
    
    Although you can filter results based on a desired status of PENDING, this will not return any results because 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 with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which 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 ECS has set the desired status to RUNNING.
    
    Although you can filter results based on a desired status of PENDING, this will not return any results because 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 String desiredStatusAsString()
```
    The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which 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 ECS has set the desired status to RUNNING.
    
    Although you can filter results based on a desired status of PENDING, this will not return any results because 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 with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which 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 ECS has set the desired status to RUNNING.
    
    Although you can filter results based on a desired status of PENDING, this will not return any results because 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
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField