Class SearchSchemaElement

java.lang.Object
software.amazon.awssdk.services.dynamodb.model.SearchSchemaElement
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SearchSchemaElement.Builder,SearchSchemaElement>
@Generated("software.amazon.awssdk:codegen") public final class SearchSchemaElement extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SearchSchemaElement.Builder,SearchSchemaElement>

An element in the search schema of a vector index.

See Also:

  • Method Details

    • attributeName

      public final String attributeName()

      The name of the attribute.

      Returns:
      The name of the attribute.

    • searchSchemaElementType

      public final SearchSchemaElementType searchSchemaElementType()

      The role of the attribute in the search schema. Valid values:

      • HASH - A partition key that partitions the vector index for independent scaling. When specified, you must provide this attribute's value in the SearchConditionExpression.

      • INLINE_FILTER - An attribute projected into the vector index for filtering at the storage layer during search. Inline filters are optional in the SearchConditionExpression.

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

      Returns:
      The role of the attribute in the search schema. Valid values:

      • HASH - A partition key that partitions the vector index for independent scaling. When specified, you must provide this attribute's value in the SearchConditionExpression.

      • INLINE_FILTER - An attribute projected into the vector index for filtering at the storage layer during search. Inline filters are optional in the SearchConditionExpression.

      See Also:

    • searchSchemaElementTypeAsString

      public final String searchSchemaElementTypeAsString()

      The role of the attribute in the search schema. Valid values:

      • HASH - A partition key that partitions the vector index for independent scaling. When specified, you must provide this attribute's value in the SearchConditionExpression.

      • INLINE_FILTER - An attribute projected into the vector index for filtering at the storage layer during search. Inline filters are optional in the SearchConditionExpression.

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

      Returns:
      The role of the attribute in the search schema. Valid values:

      • HASH - A partition key that partitions the vector index for independent scaling. When specified, you must provide this attribute's value in the SearchConditionExpression.

      • INLINE_FILTER - An attribute projected into the vector index for filtering at the storage layer during search. Inline filters are optional in the SearchConditionExpression.

      See Also:

    • toBuilder

      public SearchSchemaElement.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<SearchSchemaElement.Builder,SearchSchemaElement>
      Returns:
      a builder for type T

    • builder

      public static SearchSchemaElement.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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