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

Interface CreateIndexRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, SdkBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Enclosing class:

CreateIndexRequest

public static interface CreateIndexRequest.Builder
extends CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Method Summary

Modifier and Type	Method	Description
CreateIndexRequest.Builder	directoryArn(String directoryArn)	The ARN of the directory where the index should be created.
CreateIndexRequest.Builder	isUnique(Boolean isUnique)	Indicates whether the attribute that is being indexed has unique values or not.
CreateIndexRequest.Builder	linkName(String linkName)	The name of the link between the parent object and the index object.
CreateIndexRequest.Builder	orderedIndexedAttributeList(Collection<AttributeKey> orderedIndexedAttributeList)	Specifies the attributes that should be indexed on.
CreateIndexRequest.Builder	orderedIndexedAttributeList(AttributeKey... orderedIndexedAttributeList)	Specifies the attributes that should be indexed on.
CreateIndexRequest.Builder	parentReference(ObjectReference parentReference)	A reference to the parent object that contains the index object.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

directoryArn

CreateIndexRequest.Builder directoryArn(String directoryArn)

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

Parameters:

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

Returns:

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

orderedIndexedAttributeList

CreateIndexRequest.Builder orderedIndexedAttributeList(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.

orderedIndexedAttributeList

CreateIndexRequest.Builder orderedIndexedAttributeList(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.

isUnique

CreateIndexRequest.Builder isUnique(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.

parentReference

CreateIndexRequest.Builder parentReference(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.

linkName

CreateIndexRequest.Builder linkName(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.