Interface CreateIndexRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, OpenSearchServerlessRequest.Builder, SdkBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateIndexRequest

@Mutable
@NotThreadSafe
public static interface CreateIndexRequest.Builder
extends OpenSearchServerlessRequest.Builder, SdkPojo, CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Method Summary

Modifier and Type	Method	Description
CreateIndexRequest.Builder	id(String id)	The unique identifier of the collection in which to create the index.
CreateIndexRequest.Builder	indexName(String indexName)	The name of the index to create.
CreateIndexRequest.Builder	indexSchema(Document indexSchema)	The JSON schema definition for the index, including field mappings and settings.
CreateIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateIndexRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

id

CreateIndexRequest.Builder id(String id)

The unique identifier of the collection in which to create the index.

Parameters:

id - The unique identifier of the collection in which to create the index.

Returns:

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

indexName

CreateIndexRequest.Builder indexName(String indexName)

The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).

Parameters:

indexName - The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).

Returns:

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

indexSchema

CreateIndexRequest.Builder indexSchema(Document indexSchema)

The JSON schema definition for the index, including field mappings and settings.

Parameters:

indexSchema - The JSON schema definition for the index, including field mappings and settings.

Returns:

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

overrideConfiguration

CreateIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateIndexRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.