com.amazonaws.services.bedrockagent.model

Class OpenSearchServerlessConfiguration

java.lang.Object

com.amazonaws.services.bedrockagent.model.OpenSearchServerlessConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OpenSearchServerlessConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OpenSearchServerlessConfiguration()

Method Summary

Modifier and Type	Method and Description
OpenSearchServerlessConfiguration	clone()
boolean	equals(Object obj)
String	getCollectionArn() The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
OpenSearchServerlessFieldMapping	getFieldMapping() Contains the names of the fields to which to map information about the vector store.
String	getVectorIndexName() The name of the vector store.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCollectionArn(String collectionArn) The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
void	setFieldMapping(OpenSearchServerlessFieldMapping fieldMapping) Contains the names of the fields to which to map information about the vector store.
void	setVectorIndexName(String vectorIndexName) The name of the vector store.
String	toString() Returns a string representation of this object.
OpenSearchServerlessConfiguration	withCollectionArn(String collectionArn) The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
OpenSearchServerlessConfiguration	withFieldMapping(OpenSearchServerlessFieldMapping fieldMapping) Contains the names of the fields to which to map information about the vector store.
OpenSearchServerlessConfiguration	withVectorIndexName(String vectorIndexName) The name of the vector store.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenSearchServerlessConfiguration

public OpenSearchServerlessConfiguration()

Method Detail

setCollectionArn

public void setCollectionArn(String collectionArn)

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

Parameters:

collectionArn - The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

getCollectionArn

public String getCollectionArn()

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

Returns:

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

withCollectionArn

public OpenSearchServerlessConfiguration withCollectionArn(String collectionArn)

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

Parameters:

collectionArn - The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

Returns:

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

setFieldMapping

public void setFieldMapping(OpenSearchServerlessFieldMapping 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 OpenSearchServerlessFieldMapping 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 OpenSearchServerlessConfiguration withFieldMapping(OpenSearchServerlessFieldMapping 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 vector store.

Parameters:

vectorIndexName - The name of the vector store.

getVectorIndexName

public String getVectorIndexName()

The name of the vector store.

Returns:

The name of the vector store.

withVectorIndexName

public OpenSearchServerlessConfiguration withVectorIndexName(String vectorIndexName)

The name of the vector store.

Parameters:

vectorIndexName - The name of the vector store.

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 OpenSearchServerlessConfiguration 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.