BatchListIndex (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.clouddirectory.model.BatchListIndex

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchListIndex
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BatchListIndex()

Constructors
Constructor and Description
`BatchListIndex()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchListIndex`	`clone()`
`boolean`	`equals(Object obj)`
`ObjectReference`	`getIndexReference()` The reference to the index to list.
`Integer`	`getMaxResults()` The maximum number of results to retrieve.
`String`	`getNextToken()` The pagination token.
`List<ObjectAttributeRange>`	`getRangesOnIndexedValues()` Specifies the ranges of indexed values that you want to query.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setIndexReference(ObjectReference indexReference)` The reference to the index to list.
`void`	`setMaxResults(Integer maxResults)` The maximum number of results to retrieve.
`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.
`BatchListIndex`	`withIndexReference(ObjectReference indexReference)` The reference to the index to list.
`BatchListIndex`	`withMaxResults(Integer maxResults)` The maximum number of results to retrieve.
`BatchListIndex`	`withNextToken(String nextToken)` The pagination token.
`BatchListIndex`	`withRangesOnIndexedValues(Collection<ObjectAttributeRange> rangesOnIndexedValues)` Specifies the ranges of indexed values that you want to query.
`BatchListIndex`	`withRangesOnIndexedValues(ObjectAttributeRange... rangesOnIndexedValues)` Specifies the ranges of indexed values that you want to query.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BatchListIndex
```
public BatchListIndex()
```
- Method Detail
  - 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 BatchListIndex 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 BatchListIndex 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 BatchListIndex 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.
    
    Parameters:
    
    maxResults - The maximum number of results to retrieve.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of results to retrieve.
    
    Returns:
    
    The maximum number of results to retrieve.
  - withMaxResults
```
public BatchListIndex withMaxResults(Integer maxResults)
```
    The maximum number of results to retrieve.
    
    Parameters:
    
    maxResults - The maximum number of results to retrieve.
    
    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 BatchListIndex 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.
  - 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 BatchListIndex clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BatchListIndex

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchListIndex

Method Detail

getRangesOnIndexedValues

setRangesOnIndexedValues

withRangesOnIndexedValues

withRangesOnIndexedValues

setIndexReference

getIndexReference

withIndexReference

setMaxResults

getMaxResults

withMaxResults

setNextToken

getNextToken

withNextToken

toString

equals

hashCode

clone

marshall