Class IndexField

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

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

See Also:

  • Method Details

    • indexFieldName

      public final String indexFieldName()

      A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

      Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

      The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

      Returns:
      A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

      Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

      The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

    • indexFieldType

      public final IndexFieldType indexFieldType()
      Returns the value of the IndexFieldType property for this object.

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

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

    • indexFieldTypeAsString

      public final String indexFieldTypeAsString()
      Returns the value of the IndexFieldType property for this object.

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

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

    • intOptions

      public final IntOptions intOptions()
      Returns the value of the IntOptions property for this object.
      Returns:
      The value of the IntOptions property for this object.

    • doubleOptions

      public final DoubleOptions doubleOptions()
      Returns the value of the DoubleOptions property for this object.
      Returns:
      The value of the DoubleOptions property for this object.

    • literalOptions

      public final LiteralOptions literalOptions()
      Returns the value of the LiteralOptions property for this object.
      Returns:
      The value of the LiteralOptions property for this object.

    • textOptions

      public final TextOptions textOptions()
      Returns the value of the TextOptions property for this object.
      Returns:
      The value of the TextOptions property for this object.

    • dateOptions

      public final DateOptions dateOptions()
      Returns the value of the DateOptions property for this object.
      Returns:
      The value of the DateOptions property for this object.

    • latLonOptions

      public final LatLonOptions latLonOptions()
      Returns the value of the LatLonOptions property for this object.
      Returns:
      The value of the LatLonOptions property for this object.

    • intArrayOptions

      public final IntArrayOptions intArrayOptions()
      Returns the value of the IntArrayOptions property for this object.
      Returns:
      The value of the IntArrayOptions property for this object.

    • doubleArrayOptions

      public final DoubleArrayOptions doubleArrayOptions()
      Returns the value of the DoubleArrayOptions property for this object.
      Returns:
      The value of the DoubleArrayOptions property for this object.

    • literalArrayOptions

      public final LiteralArrayOptions literalArrayOptions()
      Returns the value of the LiteralArrayOptions property for this object.
      Returns:
      The value of the LiteralArrayOptions property for this object.

    • textArrayOptions

      public final TextArrayOptions textArrayOptions()
      Returns the value of the TextArrayOptions property for this object.
      Returns:
      The value of the TextArrayOptions property for this object.

    • dateArrayOptions

      public final DateArrayOptions dateArrayOptions()
      Returns the value of the DateArrayOptions property for this object.
      Returns:
      The value of the DateArrayOptions property for this object.

    • toBuilder

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

    • builder

      public static IndexField.Builder builder()

    • serializableBuilderClass

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