Package software.amazon.awssdk.services.clouddirectory.model

Class CreateIndexRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.clouddirectory.model.CreateIndexRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateIndexRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateIndexRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static CreateIndexRequest.Builder	builder()
String	directoryArn()	The ARN of the directory where the index should be created.
boolean	equals(Object obj)
int	hashCode()
Boolean	isUnique()	Indicates whether the attribute that is being indexed has unique values or not.
String	linkName()	The name of the link between the parent object and the index object.
List<AttributeKey>	orderedIndexedAttributeList()	Specifies the attributes that should be indexed on.
ObjectReference	parentReference()	A reference to the parent object that contains the index object.
static Class<? extends CreateIndexRequest.Builder>	serializableBuilderClass()
CreateIndexRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

directoryArn

public String directoryArn()

The ARN of the directory where the index should be created.

Returns:

The ARN of the directory where the index should be created.

orderedIndexedAttributeList

public List<AttributeKey> orderedIndexedAttributeList()

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.

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.

parentReference

public ObjectReference parentReference()

A reference to the parent object that contains the index object.

Returns:

A reference to the parent object that contains the index object.

linkName

public String linkName()

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.

toBuilder

public CreateIndexRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Returns:

a builder for type T

builder

public static CreateIndexRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateIndexRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object