Class SearchFieldDataType

java.lang.Object
com.azure.core.util.ExpandableStringEnum<SearchFieldDataType>
com.azure.search.documents.indexes.models.SearchFieldDataType
All Implemented Interfaces:
com.azure.core.util.ExpandableEnum<String>
public final class SearchFieldDataType extends com.azure.core.util.ExpandableStringEnum<SearchFieldDataType>
Defines the data type of a field in a search index.

  • Field Details

    • STRING

      public static final SearchFieldDataType STRING
      Indicates that a field contains a string.

    • INT32

      public static final SearchFieldDataType INT32
      Indicates that a field contains a 32-bit signed integer.

    • INT64

      public static final SearchFieldDataType INT64
      Indicates that a field contains a 64-bit signed integer.

    • DOUBLE

      public static final SearchFieldDataType DOUBLE
      Indicates that a field contains an IEEE double-precision floating point number.

    • BOOLEAN

      public static final SearchFieldDataType BOOLEAN
      Indicates that a field contains a Boolean value (true or false).

    • DATE_TIME_OFFSET

      public static final SearchFieldDataType DATE_TIME_OFFSET
      Indicates that a field contains a date/time value, including timezone information.

    • GEOGRAPHY_POINT

      public static final SearchFieldDataType GEOGRAPHY_POINT
      Indicates that a field contains a geo-location in terms of longitude and latitude.

    • COMPLEX

      public static final SearchFieldDataType COMPLEX
      Indicates that a field contains one or more complex objects that in turn have sub-fields of other types.

    • SINGLE

      public static final SearchFieldDataType SINGLE
      Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single).

    • HALF

      public static final SearchFieldDataType HALF
      Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half).

    • INT16

      public static final SearchFieldDataType INT16
      Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16).

    • SBYTE

      public static final SearchFieldDataType SBYTE
      Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte).

    • BYTE

      public static final SearchFieldDataType BYTE
      Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte).

  • Constructor Details

    • SearchFieldDataType

      @Deprecated public SearchFieldDataType()
      Deprecated.
      Use the fromString(String) factory method.
      Creates a new instance of SearchFieldDataType value.

  • Method Details

    • fromString

      public static SearchFieldDataType fromString(String name)
      Creates or finds a SearchFieldDataType from its string representation.
      Parameters:
      name - a name to look for.
      Returns:
      the corresponding SearchFieldDataType.

    • values

      public static Collection<SearchFieldDataType> values()
      Gets known SearchFieldDataType values.
      Returns:
      known SearchFieldDataType values.

    • collection

      public static SearchFieldDataType collection(SearchFieldDataType dataType)
      Returns a collection of a specific SearchFieldDataType.
      Parameters:
      dataType - the corresponding SearchFieldDataType
      Returns:
      a Collection of the corresponding SearchFieldDataType