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

Class S3VectorsConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.S3VectorsConfiguration

All Implemented Interfaces:

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

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

Contains the storage configuration of the knowledge base for S3 vectors.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3VectorsConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static S3VectorsConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexArn()	The Amazon Resource Name (ARN) of the vector index used for the knowledge base.
String	indexName()	The name of the vector index used for the knowledge base.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends S3VectorsConfiguration.Builder>	serializableBuilderClass()
S3VectorsConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vectorBucketArn()	The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored.

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

vectorBucketArn

public final String vectorBucketArn()

The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base.

Returns:

The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base.

indexArn

public final String indexArn()

The Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock.

Returns:

The Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock.

indexName

public final String indexName()

The name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service.

Returns:

The name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service.

toBuilder

public S3VectorsConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3VectorsConfiguration.Builder,S3VectorsConfiguration>

builder

public static S3VectorsConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo