Package software.amazon.awssdk.services.bedrockagent.model

Interface MongoDbAtlasConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

MongoDbAtlasConfiguration

public static interface MongoDbAtlasConfiguration.Builder
extends SdkPojo, CopyableBuilder<MongoDbAtlasConfiguration.Builder,MongoDbAtlasConfiguration>

Method Summary

Modifier and Type	Method	Description
MongoDbAtlasConfiguration.Builder	collectionName(String collectionName)	The collection name of the knowledge base in MongoDB Atlas.
MongoDbAtlasConfiguration.Builder	credentialsSecretArn(String credentialsSecretArn)	The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
MongoDbAtlasConfiguration.Builder	databaseName(String databaseName)	The database name in your MongoDB Atlas cluster for your knowledge base.
MongoDbAtlasConfiguration.Builder	endpoint(String endpoint)	The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
MongoDbAtlasConfiguration.Builder	endpointServiceName(String endpointServiceName)	The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
default MongoDbAtlasConfiguration.Builder	fieldMapping(Consumer<MongoDbAtlasFieldMapping.Builder> fieldMapping)	Contains the names of the fields to which to map information about the vector store.
MongoDbAtlasConfiguration.Builder	fieldMapping(MongoDbAtlasFieldMapping fieldMapping)	Contains the names of the fields to which to map information about the vector store.
MongoDbAtlasConfiguration.Builder	vectorIndexName(String vectorIndexName)	The name of the MongoDB Atlas vector search index.

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, sdkFields

Method Detail

collectionName

MongoDbAtlasConfiguration.Builder collectionName(String collectionName)

The collection name of the knowledge base in MongoDB Atlas.

Parameters:

collectionName - The collection name of the knowledge base in MongoDB Atlas.

Returns:

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

credentialsSecretArn

MongoDbAtlasConfiguration.Builder credentialsSecretArn(String credentialsSecretArn)

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.

Parameters:

credentialsSecretArn - The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.

Returns:

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

databaseName

MongoDbAtlasConfiguration.Builder databaseName(String databaseName)

The database name in your MongoDB Atlas cluster for your knowledge base.

Parameters:

databaseName - The database name in your MongoDB Atlas cluster for your knowledge base.

Returns:

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

endpoint

MongoDbAtlasConfiguration.Builder endpoint(String endpoint)

The endpoint URL of your MongoDB Atlas cluster for your knowledge base.

Parameters:

endpoint - The endpoint URL of your MongoDB Atlas cluster for your knowledge base.

Returns:

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

endpointServiceName

MongoDbAtlasConfiguration.Builder endpointServiceName(String endpointServiceName)

The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.

Parameters:

endpointServiceName - The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.

Returns:

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

fieldMapping

MongoDbAtlasConfiguration.Builder fieldMapping(MongoDbAtlasFieldMapping 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 MongoDbAtlasConfiguration.Builder fieldMapping(Consumer<MongoDbAtlasFieldMapping.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 MongoDbAtlasFieldMapping.Builder avoiding the need to create one manually via MongoDbAtlasFieldMapping.builder().

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

Parameters:

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

Returns:

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

See Also:

fieldMapping(MongoDbAtlasFieldMapping)

vectorIndexName

MongoDbAtlasConfiguration.Builder vectorIndexName(String vectorIndexName)

The name of the MongoDB Atlas vector search index.

Parameters:

vectorIndexName - The name of the MongoDB Atlas vector search index.

Returns:

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