Interface GetVectorsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetVectorsRequest.Builder,GetVectorsRequest>, S3VectorsRequest.Builder, SdkBuilder<GetVectorsRequest.Builder,GetVectorsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetVectorsRequest
@Mutable @NotThreadSafe public static interface GetVectorsRequest.Builder extends S3VectorsRequest.Builder, SdkPojo, CopyableBuilder<GetVectorsRequest.Builder,GetVectorsRequest>

  • Method Details

    • vectorBucketName

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

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

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

    • keys

      GetVectorsRequest.Builder keys(Collection<String> keys)

      The names of the vectors you want to return attributes for.

      Parameters:
      keys - The names of the vectors you want to return attributes for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keys

      GetVectorsRequest.Builder keys(String... keys)

      The names of the vectors you want to return attributes for.

      Parameters:
      keys - The names of the vectors you want to return attributes for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • returnData

      GetVectorsRequest.Builder returnData(Boolean returnData)

      Indicates whether to include the vector data in the response. The default value is false.

      Parameters:
      returnData - Indicates whether to include the vector data in the response. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • returnMetadata

      GetVectorsRequest.Builder returnMetadata(Boolean returnMetadata)

      Indicates whether to include metadata in the response. The default value is false.

      Parameters:
      returnMetadata - Indicates whether to include metadata in the response. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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