Field (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.search.models.Field

```
public final class Field
extends Object
```
Represents a field in an index definition, which describes the name, data type, and search behavior of a field.

Constructor Summary

Constructors
Constructor and Description

Field()

Constructors
Constructor and Description
`Field()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAnalyzer()` Get the analyzer property: The name of the language analyzer to use for the field.
`List<Field>`	`getFields()` Get the fields property: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType).
`String`	`getIndexAnalyzer()` Get the indexAnalyzer property: The name of the analyzer used at indexing time for the field.
`String`	`getName()` Get the name property: The name of the field, which must be unique within the fields collection of the index or parent field.
`String`	`getSearchAnalyzer()` Get the searchAnalyzer property: The name of the analyzer used at search time for the field.
`List<String>`	`getSynonymMaps()` Get the synonymMaps property: A list of the names of synonym maps to associate with this field.
`DataType`	`getType()` Get the type property: The data type of the field.
`Boolean`	`isFacetable()` Get the facetable property: A value indicating whether to enable the field to be referenced in facet queries.
`Boolean`	`isFilterable()` Get the filterable property: A value indicating whether to enable the field to be referenced in $filter queries.
`Boolean`	`isKey()` Get the key property: A value indicating whether the field uniquely identifies documents in the index.
`Boolean`	`isRetrievable()` Get the retrievable property: A value indicating whether the field can be returned in a search result.
`Boolean`	`isSearchable()` Get the searchable property: A value indicating whether the field is full-text searchable.
`Boolean`	`isSortable()` Get the sortable property: A value indicating whether to enable the field to be referenced in $orderby expressions.
`Field`	`setAnalyzer(String analyzer)` Set the analyzer property: The name of the language analyzer to use for the field.
`Field`	`setFacetable(Boolean facetable)` Set the facetable property: A value indicating whether to enable the field to be referenced in facet queries.
`Field`	`setFields(List<Field> fields)` Set the fields property: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType).
`Field`	`setFilterable(Boolean filterable)` Set the filterable property: A value indicating whether to enable the field to be referenced in $filter queries.
`Field`	`setIndexAnalyzer(String indexAnalyzer)` Set the indexAnalyzer property: The name of the analyzer used at indexing time for the field.
`Field`	`setKey(Boolean key)` Set the key property: A value indicating whether the field uniquely identifies documents in the index.
`Field`	`setName(String name)` Set the name property: The name of the field, which must be unique within the fields collection of the index or parent field.
`Field`	`setRetrievable(Boolean retrievable)` Set the retrievable property: A value indicating whether the field can be returned in a search result.
`Field`	`setSearchable(Boolean searchable)` Set the searchable property: A value indicating whether the field is full-text searchable.
`Field`	`setSearchAnalyzer(String searchAnalyzer)` Set the searchAnalyzer property: The name of the analyzer used at search time for the field.
`Field`	`setSortable(Boolean sortable)` Set the sortable property: A value indicating whether to enable the field to be referenced in $orderby expressions.
`Field`	`setSynonymMaps(List<String> synonymMaps)` Set the synonymMaps property: A list of the names of synonym maps to associate with this field.
`Field`	`setType(DataType type)` Set the type property: The data type of the field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Field
```
public Field()
```
- Method Detail
  - getName
```
public String getName()
```
    Get the name property: The name of the field, which must be unique within the fields collection of the index or parent field.
    
    Returns:
    
    the name value.
  - setName
```
public Field setName(String name)
```
    Set the name property: The name of the field, which must be unique within the fields collection of the index or parent field.
    
    Parameters:
    
    name - the name value to set.
    
    Returns:
    
    the Field object itself.
  - getType
```
public DataType getType()
```
    Get the type property: The data type of the field. Possible values include: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Edm.ComplexType'.
    
    Returns:
    
    the type value.
  - setType
```
public Field setType(DataType type)
```
    Set the type property: The data type of the field. Possible values include: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Edm.ComplexType'.
    
    Parameters:
    
    type - the type value to set.
    
    Returns:
    
    the Field object itself.
  - isKey
```
public Boolean isKey()
```
    Get the key property: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields.
    
    Returns:
    
    the key value.
  - setKey
```
public Field setKey(Boolean key)
```
    Set the key property: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields.
    
    Parameters:
    
    key - the key value to set.
    
    Returns:
    
    the Field object itself.
  - isRetrievable
```
public Boolean isRetrievable()
```
    Get the retrievable property: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields.
    
    Returns:
    
    the retrievable value.
  - setRetrievable
```
public Field setRetrievable(Boolean retrievable)
```
    Set the retrievable property: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields.
    
    Parameters:
    
    retrievable - the retrievable value to set.
    
    Returns:
    
    the Field object itself.
  - isSearchable
```
public Boolean isSearchable()
```
    Get the searchable property: A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index since Azure Cognitive Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false.
    
    Returns:
    
    the searchable value.
  - setSearchable
```
public Field setSearchable(Boolean searchable)
```
    Set the searchable property: A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index since Azure Cognitive Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false.
    
    Parameters:
    
    searchable - the searchable value to set.
    
    Returns:
    
    the Field object itself.
  - isFilterable
```
public Boolean isFilterable()
```
    Get the filterable property: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields.
    
    Returns:
    
    the filterable value.
  - setFilterable
```
public Field setFilterable(Boolean filterable)
```
    Set the filterable property: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields.
    
    Parameters:
    
    filterable - the filterable value to set.
    
    Returns:
    
    the Field object itself.
  - isSortable
```
public Boolean isSortable()
```
    Get the sortable property: A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Cognitive Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields.
    
    Returns:
    
    the sortable value.
  - setSortable
```
public Field setSortable(Boolean sortable)
```
    Set the sortable property: A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Cognitive Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields.
    
    Parameters:
    
    sortable - the sortable value to set.
    
    Returns:
    
    the Field object itself.
  - isFacetable
```
public Boolean isFacetable()
```
    Get the facetable property: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields.
    
    Returns:
    
    the facetable value.
  - setFacetable
```
public Field setFacetable(Boolean facetable)
```
    Set the facetable property: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields.
    
    Parameters:
    
    facetable - the facetable value to set.
    
    Returns:
    
    the Field object itself.
  - getAnalyzer
```
public String getAnalyzer()
```
    Get the analyzer property: The name of the language analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.
    
    Returns:
    
    the analyzer value.
  - setAnalyzer
```
public Field setAnalyzer(String analyzer)
```
    Set the analyzer property: The name of the language analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.
    
    Parameters:
    
    analyzer - the analyzer value to set.
    
    Returns:
    
    the Field object itself.
  - getSearchAnalyzer
```
public String getSearchAnalyzer()
```
    Get the searchAnalyzer property: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. Must be null for complex fields.
    
    Returns:
    
    the searchAnalyzer value.
  - setSearchAnalyzer
```
public Field setSearchAnalyzer(String searchAnalyzer)
```
    Set the searchAnalyzer property: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. Must be null for complex fields.
    
    Parameters:
    
    searchAnalyzer - the searchAnalyzer value to set.
    
    Returns:
    
    the Field object itself.
  - getIndexAnalyzer
```
public String getIndexAnalyzer()
```
    Get the indexAnalyzer property: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.
    
    Returns:
    
    the indexAnalyzer value.
  - setIndexAnalyzer
```
public Field setIndexAnalyzer(String indexAnalyzer)
```
    Set the indexAnalyzer property: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.
    
    Parameters:
    
    indexAnalyzer - the indexAnalyzer value to set.
    
    Returns:
    
    the Field object itself.
  - getSynonymMaps
```
public List<String> getSynonymMaps()
```
    Get the synonymMaps property: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields.
    
    Returns:
    
    the synonymMaps value.
  - setSynonymMaps
```
public Field setSynonymMaps(List<String> synonymMaps)
```
    Set the synonymMaps property: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields.
    
    Parameters:
    
    synonymMaps - the synonymMaps value to set.
    
    Returns:
    
    the Field object itself.
  - getFields
```
public List<Field> getFields()
```
    Get the fields property: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields.
    
    Returns:
    
    the fields value.
  - setFields
```
public Field setFields(List<Field> fields)
```
    Set the fields property: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields.
    
    Parameters:
    
    fields - the fields value to set.
    
    Returns:
    
    the Field object itself.

Class Field

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Field

Method Detail

getName

setName

getType

setType

isKey

setKey

isRetrievable

setRetrievable

isSearchable

setSearchable

isFilterable

setFilterable

isSortable

setSortable

isFacetable

setFacetable

getAnalyzer

setAnalyzer

getSearchAnalyzer

setSearchAnalyzer

getIndexAnalyzer

setIndexAnalyzer

getSynonymMaps

setSynonymMaps

getFields

setFields