Interface UpdateIndexRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateIndexRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateIndexRequest.Builder	id(String id)	The unique identifier of the collection containing the index to update.
UpdateIndexRequest.Builder	indexName(String indexName)	The name of the index to update.
UpdateIndexRequest.Builder	indexSchema(Document indexSchema)	The updated JSON schema definition for the index, including field mappings and settings.
UpdateIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateIndexRequest.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

UpdateIndexRequest.Builder id(String id)

The unique identifier of the collection containing the index to update.

Parameters:

id - The unique identifier of the collection containing the index to update.

Returns:

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

indexName

UpdateIndexRequest.Builder indexName(String indexName)

The name of the index to update.

Parameters:

indexName - The name of the index to update.

Returns:

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

indexSchema

UpdateIndexRequest.Builder indexSchema(Document indexSchema)

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

Parameters:

indexSchema - The updated 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

UpdateIndexRequest.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

UpdateIndexRequest.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.