com.amazonaws.services.clouddirectory.model

Class ListIndexRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.clouddirectory.model.ListIndexRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListIndexRequest()

Method Summary

Modifier and Type	Method and Description
ListIndexRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getConsistencyLevel() The consistency level to execute the request at.
String	getDirectoryArn() The ARN of the directory that the index exists in.
ObjectReference	getIndexReference() The reference to the index to list.
Integer	getMaxResults() The maximum number of results to retrieve from the index.
String	getNextToken() The pagination token.
List<ObjectAttributeRange>	getRangesOnIndexedValues() Specifies the ranges of indexed values that you want to query.
int	hashCode()
void	setConsistencyLevel(ConsistencyLevel consistencyLevel) The consistency level to execute the request at.
void	setConsistencyLevel(String consistencyLevel) The consistency level to execute the request at.
void	setDirectoryArn(String directoryArn) The ARN of the directory that the index exists in.
void	setIndexReference(ObjectReference indexReference) The reference to the index to list.
void	setMaxResults(Integer maxResults) The maximum number of results to retrieve from the index.
void	setNextToken(String nextToken) The pagination token.
void	setRangesOnIndexedValues(Collection<ObjectAttributeRange> rangesOnIndexedValues) Specifies the ranges of indexed values that you want to query.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListIndexRequest	withConsistencyLevel(ConsistencyLevel consistencyLevel) The consistency level to execute the request at.
ListIndexRequest	withConsistencyLevel(String consistencyLevel) The consistency level to execute the request at.
ListIndexRequest	withDirectoryArn(String directoryArn) The ARN of the directory that the index exists in.
ListIndexRequest	withIndexReference(ObjectReference indexReference) The reference to the index to list.
ListIndexRequest	withMaxResults(Integer maxResults) The maximum number of results to retrieve from the index.
ListIndexRequest	withNextToken(String nextToken) The pagination token.
ListIndexRequest	withRangesOnIndexedValues(Collection<ObjectAttributeRange> rangesOnIndexedValues) Specifies the ranges of indexed values that you want to query.
ListIndexRequest	withRangesOnIndexedValues(ObjectAttributeRange... rangesOnIndexedValues) Specifies the ranges of indexed values that you want to query.

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

ListIndexRequest

public ListIndexRequest()

Method Detail

setDirectoryArn

public void setDirectoryArn(String directoryArn)

The ARN of the directory that the index exists in.

Parameters:

directoryArn - The ARN of the directory that the index exists in.

getDirectoryArn

public String getDirectoryArn()

The ARN of the directory that the index exists in.

Returns:

The ARN of the directory that the index exists in.

withDirectoryArn

public ListIndexRequest withDirectoryArn(String directoryArn)

The ARN of the directory that the index exists in.

Parameters:

directoryArn - The ARN of the directory that the index exists in.

Returns:

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

getRangesOnIndexedValues

public List<ObjectAttributeRange> getRangesOnIndexedValues()

Specifies the ranges of indexed values that you want to query.

Returns:

Specifies the ranges of indexed values that you want to query.

setRangesOnIndexedValues

public void setRangesOnIndexedValues(Collection<ObjectAttributeRange> rangesOnIndexedValues)

Specifies the ranges of indexed values that you want to query.

Parameters:

rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.

withRangesOnIndexedValues

public ListIndexRequest withRangesOnIndexedValues(ObjectAttributeRange... rangesOnIndexedValues)

Specifies the ranges of indexed values that you want to query.

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

Parameters:

rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.

Returns:

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

withRangesOnIndexedValues

public ListIndexRequest withRangesOnIndexedValues(Collection<ObjectAttributeRange> rangesOnIndexedValues)

Specifies the ranges of indexed values that you want to query.

Parameters:

rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.

Returns:

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

setIndexReference

public void setIndexReference(ObjectReference indexReference)

The reference to the index to list.

Parameters:

indexReference - The reference to the index to list.

getIndexReference

public ObjectReference getIndexReference()

The reference to the index to list.

Returns:

The reference to the index to list.

withIndexReference

public ListIndexRequest withIndexReference(ObjectReference indexReference)

The reference to the index to list.

Parameters:

indexReference - The reference to the index to list.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to retrieve from the index.

Parameters:

maxResults - The maximum number of results to retrieve from the index.

getMaxResults

public Integer getMaxResults()

The maximum number of results to retrieve from the index.

Returns:

The maximum number of results to retrieve from the index.

withMaxResults

public ListIndexRequest withMaxResults(Integer maxResults)

The maximum number of results to retrieve from the index.

Parameters:

maxResults - The maximum number of results to retrieve from the index.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The pagination token.

Parameters:

nextToken - The pagination token.

getNextToken

public String getNextToken()

The pagination token.

Returns:

The pagination token.

withNextToken

public ListIndexRequest withNextToken(String nextToken)

The pagination token.

Parameters:

nextToken - The pagination token.

Returns:

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

setConsistencyLevel

public void setConsistencyLevel(String consistencyLevel)

The consistency level to execute the request at.

Parameters:

consistencyLevel - The consistency level to execute the request at.

See Also:

ConsistencyLevel

getConsistencyLevel

public String getConsistencyLevel()

The consistency level to execute the request at.

Returns:

The consistency level to execute the request at.

See Also:

ConsistencyLevel

withConsistencyLevel

public ListIndexRequest withConsistencyLevel(String consistencyLevel)

The consistency level to execute the request at.

Parameters:

consistencyLevel - The consistency level to execute the request at.

Returns:

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

See Also:

ConsistencyLevel

setConsistencyLevel

public void setConsistencyLevel(ConsistencyLevel consistencyLevel)

The consistency level to execute the request at.

Parameters:

consistencyLevel - The consistency level to execute the request at.

See Also:

ConsistencyLevel

withConsistencyLevel

public ListIndexRequest withConsistencyLevel(ConsistencyLevel consistencyLevel)

The consistency level to execute the request at.

Parameters:

consistencyLevel - The consistency level to execute the request at.

Returns:

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

See Also:

ConsistencyLevel

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

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 ListIndexRequest 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()