Package software.amazon.awssdk.services.datasync.model

Class ListTasksRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.ListTasksRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>

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

ListTasksRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListTasksRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListTasksRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<TaskFilter>	filters()	You can use API filters to narrow down the list of resources returned by ListTasks.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxResults()	The maximum number of tasks to return.
String	nextToken()	An opaque string that indicates the position at which to begin the next list of tasks.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTasksRequest.Builder>	serializableBuilderClass()
ListTasksRequest.Builder	toBuilder()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

maxResults

public final Integer maxResults()

The maximum number of tasks to return.

Returns:

The maximum number of tasks to return.

nextToken

public final String nextToken()

An opaque string that indicates the position at which to begin the next list of tasks.

Returns:

An opaque string that indicates the position at which to begin the next list of tasks.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filters

public final List<TaskFilter> filters()

You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a specific source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

Returns:

You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a specific source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

toBuilder

public ListTasksRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTasksRequest.Builder,ListTasksRequest>

Specified by:

toBuilder in class DataSyncRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo