Interface GetIndexRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetIndexRequest.Builder,GetIndexRequest>, S3VectorsRequest.Builder, SdkBuilder<GetIndexRequest.Builder,GetIndexRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetIndexRequest

@Mutable
@NotThreadSafe
public static interface GetIndexRequest.Builder
extends S3VectorsRequest.Builder, SdkPojo, CopyableBuilder<GetIndexRequest.Builder,GetIndexRequest>

Method Summary

Modifier and Type	Method	Description
GetIndexRequest.Builder	indexArn(String indexArn)	The ARN of the vector index.
GetIndexRequest.Builder	indexName(String indexName)	The name of the vector index.
GetIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetIndexRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
GetIndexRequest.Builder	vectorBucketName(String vectorBucketName)	The name of the vector bucket that contains the vector index.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.s3vectors.model.S3VectorsRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

vectorBucketName

GetIndexRequest.Builder vectorBucketName(String vectorBucketName)

The name of the vector bucket that contains the vector index.

Parameters:

vectorBucketName - The name of the vector bucket that contains the vector index.

Returns:

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

indexName

GetIndexRequest.Builder indexName(String indexName)

The name of the vector index.

Parameters:

indexName - The name of the vector index.

Returns:

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

indexArn

GetIndexRequest.Builder indexArn(String indexArn)

The ARN of the vector index.

Parameters:

indexArn - The ARN of the vector index.

Returns:

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

overrideConfiguration

GetIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetIndexRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.