Class MongoDbAtlasConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MongoDbAtlasConfiguration.Builder,
MongoDbAtlasConfiguration>
Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The collection name of the knowledge base in MongoDB Atlas.final String
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.final String
The database name in your MongoDB Atlas cluster for your knowledge base.final String
endpoint()
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.final String
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final MongoDbAtlasFieldMapping
Contains the names of the fields to which to map information about the vector store.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends MongoDbAtlasConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The name of the MongoDB Atlas vector search index.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
collectionName
The collection name of the knowledge base in MongoDB Atlas.
- Returns:
- The collection name of the knowledge base in MongoDB Atlas.
-
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:
- The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
-
databaseName
The database name in your MongoDB Atlas cluster for your knowledge base.
- Returns:
- The database name in your MongoDB Atlas cluster for your knowledge base.
-
endpoint
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
- Returns:
- The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
-
endpointServiceName
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
- Returns:
- The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
-
fieldMapping
Contains the names of the fields to which to map information about the vector store.
- Returns:
- Contains the names of the fields to which to map information about the vector store.
-
vectorIndexName
The name of the MongoDB Atlas vector search index.
- Returns:
- The name of the MongoDB Atlas vector search index.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<MongoDbAtlasConfiguration.Builder,
MongoDbAtlasConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-