software.amazon.awssdk.services.datasync.model

Class ListLocationsRequest

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.ListLocationsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListLocationsRequest.Builder,ListLocationsRequest>

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

ListLocationsRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListLocationsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListLocationsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<LocationFilter>	filters() You can use API filters to narrow down the list of resources returned by ListLocations.
<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 locations to return.
String	nextToken() An opaque string that indicates the position at which to begin the next list of locations.
List<SdkField<?>>	sdkFields()
static Class<? extends ListLocationsRequest.Builder>	serializableBuilderClass()
ListLocationsRequest.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 locations to return.

Returns:

The maximum number of locations to return.

nextToken

public final String nextToken()

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

Returns:

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

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<LocationFilter> filters()

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

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 ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

toBuilder

public ListLocationsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListLocationsRequest.Builder,ListLocationsRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static ListLocationsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListLocationsRequest.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