Package software.amazon.awssdk.services.dynamodb.model

Class SearchVectorsResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse
software.amazon.awssdk.services.dynamodb.model.SearchVectorsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchVectorsResponse.Builder,SearchVectorsResponse>
@Generated("software.amazon.awssdk:codegen") public final class SearchVectorsResponse extends DynamoDbResponse implements ToCopyableBuilder<SearchVectorsResponse.Builder,SearchVectorsResponse>

  • Method Details

    • consumedCapacity

      public final VectorCapacity consumedCapacity()

      The capacity units consumed by the SearchVectors operation. Contains VectorSearchRequestBytes, which represents the vector search capacity consumed.

      Returns:
      The capacity units consumed by the SearchVectors operation. Contains VectorSearchRequestBytes, which represents the vector search capacity consumed.

    • hasSearchResults

      public final boolean hasSearchResults()
      For responses, this returns true if the service returned a value for the SearchResults property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • searchResults

      public final List<SearchResultItem> searchResults()

      A list of items returned by the vector similarity search, sorted by similarity with the most similar item first. Each item contains the projected attributes and a similarity score.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSearchResults() method.

      Returns:
      A list of items returned by the vector similarity search, sorted by similarity with the most similar item first. Each item contains the projected attributes and a similarity score.

    • toBuilder

      public SearchVectorsResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchVectorsResponse.Builder,SearchVectorsResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static SearchVectorsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo