Class SearchVectorsRequest

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

  • Method Details

    • tableName

      public final String tableName()

      The name or Amazon Resource Name (ARN) of the table containing the vector index.

      Returns:
      The name or Amazon Resource Name (ARN) of the table containing the vector index.

    • indexName

      public final String indexName()

      The name of the vector index to search. The index must be in the ACTIVE state.

      Returns:
      The name of the vector index to search. The index must be in the ACTIVE state.

    • returnConsumedCapacity

      public final ReturnConsumedCapacity returnConsumedCapacity()
      Returns the value of the ReturnConsumedCapacity property for this object.

      If the service returns an enum value that is not available in the current SDK version, returnConsumedCapacity will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from returnConsumedCapacityAsString().

      Returns:
      The value of the ReturnConsumedCapacity property for this object.
      See Also:

    • returnConsumedCapacityAsString

      public final String returnConsumedCapacityAsString()
      Returns the value of the ReturnConsumedCapacity property for this object.

      If the service returns an enum value that is not available in the current SDK version, returnConsumedCapacity will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from returnConsumedCapacityAsString().

      Returns:
      The value of the ReturnConsumedCapacity property for this object.
      See Also:

    • hasExpressionAttributeNames

      public final boolean hasExpressionAttributeNames()
      For responses, this returns true if the service returned a value for the ExpressionAttributeNames 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.

    • expressionAttributeNames

      public final Map<String,String> expressionAttributeNames()

      One or more substitution tokens for attribute names in an expression. Use the # character in an expression to dereference an attribute name.

      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 hasExpressionAttributeNames() method.

      Returns:
      One or more substitution tokens for attribute names in an expression. Use the # character in an expression to dereference an attribute name.

    • hasExpressionAttributeValues

      public final boolean hasExpressionAttributeValues()
      For responses, this returns true if the service returned a value for the ExpressionAttributeValues 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.

    • expressionAttributeValues

      public final Map<String,AttributeValue> expressionAttributeValues()

      One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value.

      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 hasExpressionAttributeValues() method.

      Returns:
      One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value.

    • projectionExpression

      public final String projectionExpression()

      A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.

      Only attributes projected into the vector index can be retrieved.

      Returns:
      A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.

      Only attributes projected into the vector index can be retrieved.

    • hasSearchVector

      public final boolean hasSearchVector()
      For responses, this returns true if the service returned a value for the SearchVector 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.

    • searchVector

      public final List<AttributeValue> searchVector()

      The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.

      The number of dimensions must match the number of dimensions configured for the vector index.

      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 hasSearchVector() method.

      Returns:
      The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.

      The number of dimensions must match the number of dimensions configured for the vector index.

    • searchConditionExpression

      public final String searchConditionExpression()

      A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including HASH and INLINE_FILTER key elements.

      Only the equality operator (=) is supported for HASH attributes. Comparison and range operators are supported for INLINE_FILTER attributes. Only top-level attributes from the search schema can be referenced.

      Returns:
      A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including HASH and INLINE_FILTER key elements.

      Only the equality operator (=) is supported for HASH attributes. Comparison and range operators are supported for INLINE_FILTER attributes. Only top-level attributes from the search schema can be referenced.

    • topK

      public final Integer topK()

      The number of most similar results to return.

      Returns:
      The number of most similar results to return.

    • toBuilder

      public SearchVectorsRequest.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<SearchVectorsRequest.Builder,SearchVectorsRequest>
      Specified by:
      toBuilder in class DynamoDbRequest
      Returns:
      a builder for type T

    • builder

      public static SearchVectorsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchVectorsRequest.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.