Class ListVectorsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.s3vectors.model.S3VectorsRequest
software.amazon.awssdk.services.s3vectors.model.ListVectorsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListVectorsRequest.Builder,ListVectorsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListVectorsRequest extends S3VectorsRequest implements ToCopyableBuilder<ListVectorsRequest.Builder,ListVectorsRequest>

  • Method Details

    • vectorBucketName

      public final String vectorBucketName()

      The name of the vector bucket.

      Returns:
      The name of the vector bucket.

    • indexName

      public final String indexName()

      The name of the vector index.

      Returns:
      The name of the vector index.

    • indexArn

      public final String indexArn()

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

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

    • maxResults

      public final 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.

      Returns:
      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.

    • nextToken

      public final String nextToken()

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

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

    • segmentCount

      public final 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.

      Returns:
      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.

    • segmentIndex

      public final 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.

      Returns:
      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.

    • returnData

      public final Boolean returnData()

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

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

    • returnMetadata

      public final Boolean returnMetadata()

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

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

    • toBuilder

      public ListVectorsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListVectorsRequest.Builder,ListVectorsRequest>
      Specified by:
      toBuilder in class S3VectorsRequest
      Returns:
      a builder for type T

    • builder

      public static ListVectorsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListVectorsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.