BatchCreateIndex (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchCreateIndex
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BatchCreateIndex()

Constructors
Constructor and Description
`BatchCreateIndex()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchCreateIndex`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBatchReferenceName()` The batch reference name.
`Boolean`	`getIsUnique()` Indicates whether the attribute that is being indexed has unique values or not.
`String`	`getLinkName()` The name of the link between the parent object and the index object.
`List<AttributeKey>`	`getOrderedIndexedAttributeList()` Specifies the attributes that should be indexed on.
`ObjectReference`	`getParentReference()` A reference to the parent object that contains the index object.
`int`	`hashCode()`
`Boolean`	`isUnique()` Indicates whether the attribute that is being indexed has unique values or not.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBatchReferenceName(String batchReferenceName)` The batch reference name.
`void`	`setIsUnique(Boolean isUnique)` Indicates whether the attribute that is being indexed has unique values or not.
`void`	`setLinkName(String linkName)` The name of the link between the parent object and the index object.
`void`	`setOrderedIndexedAttributeList(Collection<AttributeKey> orderedIndexedAttributeList)` Specifies the attributes that should be indexed on.
`void`	`setParentReference(ObjectReference parentReference)` A reference to the parent object that contains the index object.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`BatchCreateIndex`	`withBatchReferenceName(String batchReferenceName)` The batch reference name.
`BatchCreateIndex`	`withIsUnique(Boolean isUnique)` Indicates whether the attribute that is being indexed has unique values or not.
`BatchCreateIndex`	`withLinkName(String linkName)` The name of the link between the parent object and the index object.
`BatchCreateIndex`	`withOrderedIndexedAttributeList(AttributeKey... orderedIndexedAttributeList)` Specifies the attributes that should be indexed on.
`BatchCreateIndex`	`withOrderedIndexedAttributeList(Collection<AttributeKey> orderedIndexedAttributeList)` Specifies the attributes that should be indexed on.
`BatchCreateIndex`	`withParentReference(ObjectReference parentReference)` A reference to the parent object that contains the index object.

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

- Constructor Detail
  - BatchCreateIndex
```
public BatchCreateIndex()
```
- Method Detail
  - getOrderedIndexedAttributeList
```
public List<AttributeKey> getOrderedIndexedAttributeList()
```
    Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
    
    Returns:
    
    Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
  - setOrderedIndexedAttributeList
```
public void setOrderedIndexedAttributeList(Collection<AttributeKey> orderedIndexedAttributeList)
```
    Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
    
    Parameters:
    
    orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
  - withOrderedIndexedAttributeList
```
public BatchCreateIndex withOrderedIndexedAttributeList(AttributeKey... orderedIndexedAttributeList)
```
    Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
    
    NOTE: This method appends the values to the existing list (if any). Use setOrderedIndexedAttributeList(java.util.Collection) or withOrderedIndexedAttributeList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOrderedIndexedAttributeList
```
public BatchCreateIndex withOrderedIndexedAttributeList(Collection<AttributeKey> orderedIndexedAttributeList)
```
    Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
    
    Parameters:
    
    orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsUnique
```
public void setIsUnique(Boolean isUnique)
```
    Indicates whether the attribute that is being indexed has unique values or not.
    
    Parameters:
    
    isUnique - Indicates whether the attribute that is being indexed has unique values or not.
  - getIsUnique
```
public Boolean getIsUnique()
```
    Indicates whether the attribute that is being indexed has unique values or not.
    
    Returns:
    
    Indicates whether the attribute that is being indexed has unique values or not.
  - withIsUnique
```
public BatchCreateIndex withIsUnique(Boolean isUnique)
```
    Indicates whether the attribute that is being indexed has unique values or not.
    
    Parameters:
    
    isUnique - Indicates whether the attribute that is being indexed has unique values or not.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUnique
```
public Boolean isUnique()
```
    Indicates whether the attribute that is being indexed has unique values or not.
    
    Returns:
    
    Indicates whether the attribute that is being indexed has unique values or not.
  - setParentReference
```
public void setParentReference(ObjectReference parentReference)
```
    A reference to the parent object that contains the index object.
    
    Parameters:
    
    parentReference - A reference to the parent object that contains the index object.
  - getParentReference
```
public ObjectReference getParentReference()
```
    A reference to the parent object that contains the index object.
    
    Returns:
    
    A reference to the parent object that contains the index object.
  - withParentReference
```
public BatchCreateIndex withParentReference(ObjectReference parentReference)
```
    A reference to the parent object that contains the index object.
    
    Parameters:
    
    parentReference - A reference to the parent object that contains the index object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLinkName
```
public void setLinkName(String linkName)
```
    The name of the link between the parent object and the index object.
    
    Parameters:
    
    linkName - The name of the link between the parent object and the index object.
  - getLinkName
```
public String getLinkName()
```
    The name of the link between the parent object and the index object.
    
    Returns:
    
    The name of the link between the parent object and the index object.
  - withLinkName
```
public BatchCreateIndex withLinkName(String linkName)
```
    The name of the link between the parent object and the index object.
    
    Parameters:
    
    linkName - The name of the link between the parent object and the index object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBatchReferenceName
```
public void setBatchReferenceName(String batchReferenceName)
```
    The batch reference name. See Batches for more information.
    
    Parameters:
    
    batchReferenceName - The batch reference name. See Batches for more information.
  - getBatchReferenceName
```
public String getBatchReferenceName()
```
    The batch reference name. See Batches for more information.
    
    Returns:
    
    The batch reference name. See Batches for more information.
  - withBatchReferenceName
```
public BatchCreateIndex withBatchReferenceName(String batchReferenceName)
```
    The batch reference name. See Batches for more information.
    
    Parameters:
    
    batchReferenceName - The batch reference name. See Batches for more information.
    
    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 BatchCreateIndex 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 BatchCreateIndex

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchCreateIndex

Method Detail

getOrderedIndexedAttributeList

setOrderedIndexedAttributeList

withOrderedIndexedAttributeList

withOrderedIndexedAttributeList

setIsUnique

getIsUnique

withIsUnique

isUnique

setParentReference

getParentReference

withParentReference

setLinkName

getLinkName

withLinkName

setBatchReferenceName

getBatchReferenceName

withBatchReferenceName

toString

equals

hashCode

clone

marshall