MongoDbAtlasConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.bedrockagent.model.MongoDbAtlasConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MongoDbAtlasConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains details about the storage configuration of the knowledge base in MongoDB Atlas.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MongoDbAtlasConfiguration()

Constructors
Constructor and Description
`MongoDbAtlasConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MongoDbAtlasConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCollectionName()` The collection name of the knowledge base in MongoDB Atlas.
`String`	`getCredentialsSecretArn()` The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
`String`	`getDatabaseName()` The database name in your MongoDB Atlas cluster for your knowledge base.
`String`	`getEndpoint()` The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
`String`	`getEndpointServiceName()` The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
`MongoDbAtlasFieldMapping`	`getFieldMapping()` Contains the names of the fields to which to map information about the vector store.
`String`	`getVectorIndexName()` The name of the MongoDB Atlas vector search index.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCollectionName(String collectionName)` The collection name of the knowledge base in MongoDB Atlas.
`void`	`setCredentialsSecretArn(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.
`void`	`setDatabaseName(String databaseName)` The database name in your MongoDB Atlas cluster for your knowledge base.
`void`	`setEndpoint(String endpoint)` The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
`void`	`setEndpointServiceName(String endpointServiceName)` The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
`void`	`setFieldMapping(MongoDbAtlasFieldMapping fieldMapping)` Contains the names of the fields to which to map information about the vector store.
`void`	`setVectorIndexName(String vectorIndexName)` The name of the MongoDB Atlas vector search index.
`String`	`toString()` Returns a string representation of this object.
`MongoDbAtlasConfiguration`	`withCollectionName(String collectionName)` The collection name of the knowledge base in MongoDB Atlas.
`MongoDbAtlasConfiguration`	`withCredentialsSecretArn(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`	`withDatabaseName(String databaseName)` The database name in your MongoDB Atlas cluster for your knowledge base.
`MongoDbAtlasConfiguration`	`withEndpoint(String endpoint)` The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
`MongoDbAtlasConfiguration`	`withEndpointServiceName(String endpointServiceName)` The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
`MongoDbAtlasConfiguration`	`withFieldMapping(MongoDbAtlasFieldMapping fieldMapping)` Contains the names of the fields to which to map information about the vector store.
`MongoDbAtlasConfiguration`	`withVectorIndexName(String vectorIndexName)` The name of the MongoDB Atlas vector search index.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MongoDbAtlasConfiguration
```
public MongoDbAtlasConfiguration()
```
- Method Detail
  - setCollectionName
```
public void setCollectionName(String collectionName)
```
    The collection name of the knowledge base in MongoDB Atlas.
    
    Parameters:
    
    collectionName - The collection name of the knowledge base in MongoDB Atlas.
  - getCollectionName
```
public String getCollectionName()
```
    The collection name of the knowledge base in MongoDB Atlas.
    
    Returns:
    
    The collection name of the knowledge base in MongoDB Atlas.
  - withCollectionName
```
public MongoDbAtlasConfiguration withCollectionName(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.
  - setCredentialsSecretArn
```
public void setCredentialsSecretArn(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.
  - getCredentialsSecretArn
```
public String getCredentialsSecretArn()
```
    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.
  - withCredentialsSecretArn
```
public MongoDbAtlasConfiguration withCredentialsSecretArn(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.
  - setDatabaseName
```
public void setDatabaseName(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.
  - getDatabaseName
```
public String getDatabaseName()
```
    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.
  - withDatabaseName
```
public MongoDbAtlasConfiguration withDatabaseName(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.
  - setEndpoint
```
public void setEndpoint(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.
  - getEndpoint
```
public String getEndpoint()
```
    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.
  - withEndpoint
```
public MongoDbAtlasConfiguration withEndpoint(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.
  - setEndpointServiceName
```
public void setEndpointServiceName(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.
  - getEndpointServiceName
```
public String getEndpointServiceName()
```
    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.
  - withEndpointServiceName
```
public MongoDbAtlasConfiguration withEndpointServiceName(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.
  - setFieldMapping
```
public void setFieldMapping(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.
  - getFieldMapping
```
public MongoDbAtlasFieldMapping getFieldMapping()
```
    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.
  - withFieldMapping
```
public MongoDbAtlasConfiguration withFieldMapping(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.
  - setVectorIndexName
```
public void setVectorIndexName(String vectorIndexName)
```
    The name of the MongoDB Atlas vector search index.
    
    Parameters:
    
    vectorIndexName - The name of the MongoDB Atlas vector search index.
  - getVectorIndexName
```
public String getVectorIndexName()
```
    The name of the MongoDB Atlas vector search index.
    
    Returns:
    
    The name of the MongoDB Atlas vector search index.
  - withVectorIndexName
```
public MongoDbAtlasConfiguration withVectorIndexName(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MongoDbAtlasConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class MongoDbAtlasConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MongoDbAtlasConfiguration

Method Detail

setCollectionName

getCollectionName

withCollectionName

setCredentialsSecretArn

getCredentialsSecretArn

withCredentialsSecretArn

setDatabaseName

getDatabaseName

withDatabaseName

setEndpoint

getEndpoint

withEndpoint

setEndpointServiceName

getEndpointServiceName

withEndpointServiceName

setFieldMapping

getFieldMapping

withFieldMapping

setVectorIndexName

getVectorIndexName

withVectorIndexName

toString

equals

hashCode

clone

marshall