Interface ListVectorsRequest.Builder

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

  • Method Details

    • vectorBucketName

      ListVectorsRequest.Builder vectorBucketName(String vectorBucketName)

      The name of the vector bucket.

      Parameters:
      vectorBucketName - The name of the vector bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexName

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

      ListVectorsRequest.Builder indexArn(String indexArn)

      The Amazon resource Name (ARN) of the vector index.

      Parameters:
      indexArn - The Amazon resource Name (ARN) of the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListVectorsRequest.Builder maxResults(Integer maxResults)

      The maximum number of vectors to return on a page.

      If you don't specify maxResults, the ListVectors operation uses a default value of 500.

      If the processed dataset size exceeds 1 MB before reaching the maxResults value, the operation stops and returns the vectors that are retrieved up to that point, along with a nextToken that you can use in a subsequent request to retrieve the next set of results.

      Parameters:
      maxResults - The maximum number of vectors to return on a page.

      If you don't specify maxResults, the ListVectors operation uses a default value of 500.

      If the processed dataset size exceeds 1 MB before reaching the maxResults value, the operation stops and returns the vectors that are retrieved up to that point, along with a nextToken that you can use in a subsequent request to retrieve the next set of results.

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

    • nextToken

      ListVectorsRequest.Builder nextToken(String nextToken)

      Pagination token from a previous request. The value of this field is empty for an initial request.

      Parameters:
      nextToken - Pagination token from a previous request. The value of this field is empty for an initial request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentCount

      ListVectorsRequest.Builder segmentCount(Integer segmentCount)

      For a parallel ListVectors request, segmentCount represents the total number of vector segments into which the ListVectors operation will be divided. The value of segmentCount corresponds to the number of application workers that will perform the parallel ListVectors operation. For example, if you want to use four application threads to list vectors in a vector index, specify a segmentCount value of 4.

      If you specify a segmentCount value of 1, the ListVectors operation will be sequential rather than parallel.

      If you specify segmentCount, you must also specify segmentIndex.

      Parameters:
      segmentCount - For a parallel ListVectors request, segmentCount represents the total number of vector segments into which the ListVectors operation will be divided. The value of segmentCount corresponds to the number of application workers that will perform the parallel ListVectors operation. For example, if you want to use four application threads to list vectors in a vector index, specify a segmentCount value of 4.

      If you specify a segmentCount value of 1, the ListVectors operation will be sequential rather than parallel.

      If you specify segmentCount, you must also specify segmentIndex.

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

    • segmentIndex

      ListVectorsRequest.Builder segmentIndex(Integer segmentIndex)

      For a parallel ListVectors request, segmentIndex is the index of the segment from which to list vectors in the current request. It identifies an individual segment to be listed by an application worker.

      Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to list vectors in a vector index, then the first thread specifies a segmentIndex value of 0, the second thread specifies 1, and so on.

      The value of segmentIndex must be less than the value provided for segmentCount.

      If you provide segmentIndex, you must also provide segmentCount.

      Parameters:
      segmentIndex - For a parallel ListVectors request, segmentIndex is the index of the segment from which to list vectors in the current request. It identifies an individual segment to be listed by an application worker.

      Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to list vectors in a vector index, then the first thread specifies a segmentIndex value of 0, the second thread specifies 1, and so on.

      The value of segmentIndex must be less than the value provided for segmentCount.

      If you provide segmentIndex, you must also provide segmentCount.

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

    • returnData

      ListVectorsRequest.Builder returnData(Boolean returnData)

      If true, the vector data of each vector will be included in the response. The default value is false.

      Parameters:
      returnData - If true, the vector data of each vector will be included in the response. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • returnMetadata

      ListVectorsRequest.Builder returnMetadata(Boolean returnMetadata)

      If true, the metadata associated with each vector will be included in the response. The default value is false.

      Parameters:
      returnMetadata - If true, the metadata associated with each vector will be included in the response. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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