Interface UpdateCollectionRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateCollectionRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateCollectionRequest.Builder	clientToken(String clientToken)	Unique, case-sensitive identifier to ensure idempotency of the request.
UpdateCollectionRequest.Builder	deletionProtection(String deletionProtection)	Indicates whether to enable or disable deletion protection for the collection.
UpdateCollectionRequest.Builder	deletionProtection(DeletionProtection deletionProtection)	Indicates whether to enable or disable deletion protection for the collection.
UpdateCollectionRequest.Builder	description(String description)	A description of the collection.
UpdateCollectionRequest.Builder	id(String id)	The unique identifier of the collection.
UpdateCollectionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateCollectionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateCollectionRequest.Builder	vectorOptions(Consumer<VectorOptions.Builder> vectorOptions)	Configuration options for vector search capabilities in the collection.
UpdateCollectionRequest.Builder	vectorOptions(VectorOptions vectorOptions)	Configuration options for vector search capabilities in the collection.

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

UpdateCollectionRequest.Builder id(String id)

The unique identifier of the collection.

Parameters:

id - The unique identifier of the collection.

Returns:

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

description

UpdateCollectionRequest.Builder description(String description)

A description of the collection.

Parameters:

description - A description of the collection.

Returns:

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

vectorOptions

UpdateCollectionRequest.Builder vectorOptions(VectorOptions vectorOptions)

Configuration options for vector search capabilities in the collection.

Parameters:

vectorOptions - Configuration options for vector search capabilities in the collection.

Returns:

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

vectorOptions

default UpdateCollectionRequest.Builder vectorOptions(Consumer<VectorOptions.Builder> vectorOptions)

Configuration options for vector search capabilities in the collection.

This is a convenience method that creates an instance of the VectorOptions.Builder avoiding the need to create one manually via VectorOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vectorOptions(VectorOptions).

Parameters:

vectorOptions - a consumer that will call methods on VectorOptions.Builder

Returns:

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

See Also:

• vectorOptions(VectorOptions)

deletionProtection

UpdateCollectionRequest.Builder deletionProtection(String deletionProtection)

Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.

Parameters:

deletionProtection - Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.

Returns:

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

See Also:

• DeletionProtection
• DeletionProtection

deletionProtection

UpdateCollectionRequest.Builder deletionProtection(DeletionProtection deletionProtection)

Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.

Parameters:

deletionProtection - Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.

Returns:

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

See Also:

• DeletionProtection
• DeletionProtection

clientToken

UpdateCollectionRequest.Builder clientToken(String clientToken)

Unique, case-sensitive identifier to ensure idempotency of the request.

Parameters:

clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

Returns:

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

overrideConfiguration

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

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