SearchFieldDataType Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3

public final class SearchFieldDataType
extends ExpandableStringEnum<SearchFieldDataType>

Defines the data type of a field in a search index.

Field Summary

Modifier and Type Field and Description
static final SearchFieldDataType BOOLEAN

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

Indicates that a field contains a 8-bit unsigned integer.
static final SearchFieldDataType COMPLEX

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

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

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

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

Indicates that a field contains a half-precision floating point number.
static final SearchFieldDataType INT16

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

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

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

Indicates that a field contains a 8-bit signed integer.
static final SearchFieldDataType SINGLE

Indicates that a field contains a single-precision floating point number.
static final SearchFieldDataType STRING

Indicates that a field contains a string.

Constructor Summary

Constructor Description
SearchFieldDataType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of SearchFieldDataType value.

Method Summary

Modifier and Type Method and Description
static SearchFieldDataType collection(SearchFieldDataType dataType)

Returns a collection of a specific SearchFieldDataType.
static SearchFieldDataType fromString(String name)

Creates or finds a SearchFieldDataType from its string representation.
static Collection<SearchFieldDataType> values()

Gets known SearchFieldDataType values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

BOOLEAN

public static final SearchFieldDataType BOOLEAN

Indicates that a field contains a Boolean value (true or false).

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

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.

DATE_TIME_OFFSET

public static final SearchFieldDataType DATE_TIME_OFFSET

Indicates that a field contains a date/time value, including timezone information.

DOUBLE

public static final SearchFieldDataType DOUBLE

Indicates that a field contains an IEEE double-precision floating point number.

GEOGRAPHY_POINT

public static final SearchFieldDataType GEOGRAPHY_POINT

Indicates that a field contains a geo-location in terms of longitude and latitude.

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

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.

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

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

STRING

public static final SearchFieldDataType STRING

Indicates that a field contains a string.

Constructor Details

SearchFieldDataType

@Deprecated
public SearchFieldDataType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of SearchFieldDataType value.

Method Details

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

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 values()

Gets known SearchFieldDataType values.

Returns:

known SearchFieldDataType values.

Applies to