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

Class MongoDbAtlasConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.MongoDbAtlasConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MongoDbAtlasConfiguration.Builder,MongoDbAtlasConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class MongoDbAtlasConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MongoDbAtlasConfiguration.Builder,MongoDbAtlasConfiguration>

Contains details about the storage configuration of the knowledge base in MongoDB Atlas.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MongoDbAtlasConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static MongoDbAtlasConfiguration.Builder	builder()
String	collectionName()	The collection name of the knowledge base in MongoDB Atlas.
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.
String	databaseName()	The database name in your MongoDB Atlas cluster for your knowledge base.
String	endpoint()	The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
String	endpointServiceName()	The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
MongoDbAtlasFieldMapping	fieldMapping()	Contains the names of the fields to which to map information about the vector store.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends MongoDbAtlasConfiguration.Builder>	serializableBuilderClass()
MongoDbAtlasConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vectorIndexName()	The name of the MongoDB Atlas vector search index.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

collectionName

public final String collectionName()

The collection name of the knowledge base in MongoDB Atlas.

Returns:

The collection name of the knowledge base in MongoDB Atlas.

credentialsSecretArn

public final 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.

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

public final String 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

public final String 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

public final String 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

public final MongoDbAtlasFieldMapping 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

public final String vectorIndexName()

The name of the MongoDB Atlas vector search index.

Returns:

The name of the MongoDB Atlas vector search index.

toBuilder

public MongoDbAtlasConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MongoDbAtlasConfiguration.Builder,MongoDbAtlasConfiguration>

builder

public static MongoDbAtlasConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends MongoDbAtlasConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo