Interface OpenSearchServerlessConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OpenSearchServerlessConfiguration.Builder,OpenSearchServerlessConfiguration>, SdkBuilder<OpenSearchServerlessConfiguration.Builder,OpenSearchServerlessConfiguration>, SdkPojo

Enclosing class:

OpenSearchServerlessConfiguration

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

Method Summary

Modifier and Type	Method	Description
OpenSearchServerlessConfiguration.Builder	collectionArn(String collectionArn)	The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
default OpenSearchServerlessConfiguration.Builder	fieldMapping(Consumer<OpenSearchServerlessFieldMapping.Builder> fieldMapping)	Contains the names of the fields to which to map information about the vector store.
OpenSearchServerlessConfiguration.Builder	fieldMapping(OpenSearchServerlessFieldMapping fieldMapping)	Contains the names of the fields to which to map information about the vector store.
OpenSearchServerlessConfiguration.Builder	vectorIndexName(String vectorIndexName)	The name of the vector store.

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

copy

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

collectionArn

OpenSearchServerlessConfiguration.Builder collectionArn(String collectionArn)

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

Parameters:

collectionArn - The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

Returns:

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

fieldMapping

OpenSearchServerlessConfiguration.Builder fieldMapping(OpenSearchServerlessFieldMapping fieldMapping)

Contains the names of the fields to which to map information about the vector store.

Parameters:

fieldMapping - Contains the names of the fields to which to map information about the vector store.

Returns:

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

fieldMapping

default OpenSearchServerlessConfiguration.Builder fieldMapping(Consumer<OpenSearchServerlessFieldMapping.Builder> fieldMapping)

Contains the names of the fields to which to map information about the vector store.

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

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

Parameters:

fieldMapping - a consumer that will call methods on OpenSearchServerlessFieldMapping.Builder

Returns:

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

See Also:

• fieldMapping(OpenSearchServerlessFieldMapping)

vectorIndexName

OpenSearchServerlessConfiguration.Builder vectorIndexName(String vectorIndexName)

The name of the vector store.

Parameters:

vectorIndexName - The name of the vector store.

Returns:

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