com.amazonaws.services.datasync.model

Class ListLocationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.ListLocationsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListLocationsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

ListLocationsRequest

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListLocationsRequest()

Method Summary

Modifier and Type	Method and Description
ListLocationsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<LocationFilter>	getFilters() You can use API filters to narrow down the list of resources returned by ListLocations.
Integer	getMaxResults() The maximum number of locations to return.
String	getNextToken() An opaque string that indicates the position at which to begin the next list of locations.
int	hashCode()
void	setFilters(Collection<LocationFilter> filters) You can use API filters to narrow down the list of resources returned by ListLocations.
void	setMaxResults(Integer maxResults) The maximum number of locations to return.
void	setNextToken(String nextToken) An opaque string that indicates the position at which to begin the next list of locations.
String	toString() Returns a string representation of this object.
ListLocationsRequest	withFilters(Collection<LocationFilter> filters) You can use API filters to narrow down the list of resources returned by ListLocations.
ListLocationsRequest	withFilters(LocationFilter... filters) You can use API filters to narrow down the list of resources returned by ListLocations.
ListLocationsRequest	withMaxResults(Integer maxResults) The maximum number of locations to return.
ListLocationsRequest	withNextToken(String nextToken) An opaque string that indicates the position at which to begin the next list of locations.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListLocationsRequest

public ListLocationsRequest()

Method Detail

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of locations to return.

Parameters:

maxResults - The maximum number of locations to return.

getMaxResults

public Integer getMaxResults()

The maximum number of locations to return.

Returns:

The maximum number of locations to return.

withMaxResults

public ListLocationsRequest withMaxResults(Integer maxResults)

The maximum number of locations to return.

Parameters:

maxResults - The maximum number of locations to return.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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.

withNextToken

public ListLocationsRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getFilters

public List<LocationFilter> getFilters()

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.

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.

setFilters

public void setFilters(Collection<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.

Parameters:

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.

withFilters

public ListLocationsRequest withFilters(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.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilters

public ListLocationsRequest withFilters(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListLocationsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()