Interface MongoDbAtlasConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<MongoDbAtlasConfiguration.Builder,
,MongoDbAtlasConfiguration> SdkBuilder<MongoDbAtlasConfiguration.Builder,
,MongoDbAtlasConfiguration> SdkPojo
- Enclosing class:
MongoDbAtlasConfiguration
-
Method Summary
Modifier and TypeMethodDescriptioncollectionName
(String collectionName) The collection name of the knowledge base in MongoDB Atlas.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.databaseName
(String databaseName) The database name in your MongoDB Atlas cluster for your knowledge base.The endpoint URL of your MongoDB Atlas cluster for your knowledge base.endpointServiceName
(String endpointServiceName) The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.fieldMapping
(Consumer<MongoDbAtlasFieldMapping.Builder> fieldMapping) Contains the names of the fields to which to map information about the vector store.fieldMapping
(MongoDbAtlasFieldMapping fieldMapping) Contains the names of the fields to which to map information about the vector store.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 Details
-
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
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
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
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
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
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 theMongoDbAtlasFieldMapping.Builder
avoiding the need to create one manually viaMongoDbAtlasFieldMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofieldMapping(MongoDbAtlasFieldMapping)
.- Parameters:
fieldMapping
- a consumer that will call methods onMongoDbAtlasFieldMapping.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-