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

Class OpenSearchServerlessConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.OpenSearchServerlessConfiguration

All Implemented Interfaces:

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

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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenSearchServerlessConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static OpenSearchServerlessConfiguration.Builder	builder()
String	collectionArn()	The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
OpenSearchServerlessFieldMapping	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 OpenSearchServerlessConfiguration.Builder>	serializableBuilderClass()
OpenSearchServerlessConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vectorIndexName()	The name of the vector store.

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

collectionArn

public final String collectionArn()

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

Returns:

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

fieldMapping

public final OpenSearchServerlessFieldMapping 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 vector store.

Returns:

The name of the vector store.

toBuilder

public OpenSearchServerlessConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OpenSearchServerlessConfiguration.Builder,OpenSearchServerlessConfiguration>

builder

public static OpenSearchServerlessConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends OpenSearchServerlessConfiguration.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