Interface PutVectorsRequest.Builder

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

  • Method Details

    • vectorBucketName

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

      PutVectorsRequest.Builder indexName(String indexName)

      The name of the vector index where you want to write vectors.

      Parameters:
      indexName - The name of the vector index where you want to write vectors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexArn

      PutVectorsRequest.Builder indexArn(String indexArn)

      The ARN of the vector index where you want to write vectors.

      Parameters:
      indexArn - The ARN of the vector index where you want to write vectors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectors

      PutVectorsRequest.Builder vectors(Collection<PutInputVector> vectors)

      The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error ServiceUnavailableException with the error message "Currently unable to handle the request".

      Parameters:
      vectors - The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error ServiceUnavailableException with the error message "Currently unable to handle the request".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectors

      PutVectorsRequest.Builder vectors(PutInputVector... vectors)

      The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error ServiceUnavailableException with the error message "Currently unable to handle the request".

      Parameters:
      vectors - The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error ServiceUnavailableException with the error message "Currently unable to handle the request".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectors

      PutVectorsRequest.Builder vectors(Consumer<PutInputVector.Builder>... vectors)

      The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error ServiceUnavailableException with the error message "Currently unable to handle the request".

      This is a convenience method that creates an instance of the PutInputVector.Builder avoiding the need to create one manually via PutInputVector.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vectors(List<PutInputVector>).

      Parameters:
      vectors - a consumer that will call methods on PutInputVector.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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