software.amazon.awssdk.services.clouddirectory.model

Interface CreateIndexRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CloudDirectoryRequest.Builder, CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, SdkBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, SdkRequest.Builder

Enclosing class:

CreateIndexRequest

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

Method Summary

Modifier and Type	Method and 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(AttributeKey... orderedIndexedAttributeList) Specifies the attributes that should be indexed on.
CreateIndexRequest.Builder	orderedIndexedAttributeList(Collection<AttributeKey> orderedIndexedAttributeList) Specifies the attributes that should be indexed on.
CreateIndexRequest.Builder	orderedIndexedAttributeList(Consumer<AttributeKey.Builder>... orderedIndexedAttributeList) Specifies the attributes that should be indexed on.
default CreateIndexRequest.Builder	parentReference(Consumer<ObjectReference.Builder> parentReference) A reference to the parent object that contains the index object.
CreateIndexRequest.Builder	parentReference(ObjectReference parentReference) A reference to the parent object that contains the index object.
CreateIndexRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
CreateIndexRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.clouddirectory.model.CloudDirectoryRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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.

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(Consumer<AttributeKey.Builder>... orderedIndexedAttributeList)

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #orderedIndexedAttributeList(List).

Parameters:

orderedIndexedAttributeList - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#orderedIndexedAttributeList(List)

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.

parentReference

default CreateIndexRequest.Builder parentReference(Consumer<ObjectReference.Builder> parentReference)

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

This is a convenience that creates an instance of the ObjectReference.Builder avoiding the need to create one manually via ObjectReference.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parentReference(ObjectReference).

Parameters:

parentReference - a consumer that will call methods on ObjectReference.Builder

Returns:

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

See Also:

parentReference(ObjectReference)

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.

requestOverrideConfig

CreateIndexRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

CreateIndexRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.