Field (Spring Data Elasticsearch 4.4.1 API)

```
@Retention(value=RUNTIME)
 @Target(value={FIELD,ANNOTATION_TYPE})
 @Documented
 @Inherited
public @interface Field
```
Author:

Rizwan Idrees, Mohsin Husen, Artur Konczak, Jonathan Yan, Jakub Vavrik, Kevin Leturc, Peter-Josef Meisch, Xiao Yu, Aleksei Arsenev, Brian Kimmig, Morgan Lutz, Sascha Woo

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`String`	`analyzer`
`boolean`	`coerce`
`String[]`	`copyTo`
`int`	`dims` to be used in combination with `FieldType.Dense_Vector`
`boolean`	`docValues`
`Dynamic`	`dynamic` Controls how Elasticsearch dynamically adds fields to the inner object within the document.
`boolean`	`eagerGlobalOrdinals`
`boolean`	`enabled` to be used in combination with `FieldType.Object`
`boolean`	`excludeFromSource` marks this field to be excluded from the _source in Elasticsearch (https://www.elastic.co/guide/en/elasticsearch/reference/7.15/mapping-source-field.html#include-exclude)
`boolean`	`fielddata`
`DateFormat[]`	`format`
`int`	`ignoreAbove`
`String[]`	`ignoreFields`
`boolean`	`ignoreMalformed`
`boolean`	`includeInParent`
`boolean`	`index`
`IndexOptions`	`indexOptions`
`boolean`	`indexPhrases`
`IndexPrefixes[]`	`indexPrefixes` implemented as array to enable the empty default value
`int`	`maxShingleSize`
`String`	`name` The name to be used to store the field inside the document.
`String`	`normalizer`
`boolean`	`norms`
`String`	`nullValue`
`NullValueType`	`nullValueType`
`String[]`	`pattern`
`int`	`positionIncrementGap`
`boolean`	`positiveScoreImpact` to be used in combination with `FieldType.Rank_Feature`
`double`	`scalingFactor`
`String`	`searchAnalyzer`
`Similarity`	`similarity`
`boolean`	`store`
`boolean`	`storeNullValue` if true, the field will be stored in Elasticsearch even if it has a null value
`TermVector`	`termVector`
`FieldType`	`type`
`String`	`value` Alias for `name()`.

- Element Detail
  - value
```
@AliasFor(value="name")
public abstract String value
```
    Alias for name().
    
    Since:
    
    3.2
    
    Default:
    
    ""
- - name
```
@AliasFor(value="value")
public abstract String name
```
    The name to be used to store the field inside the document.
    √5 If not set, the name of the annotated property is used.
    
    Since:
    
    3.2
    
    Default:
    
    ""
- - type
```
public abstract FieldType type
```
    Default:
    
    org.springframework.data.elasticsearch.annotations.FieldType.Auto
- - index
```
public abstract boolean index
```
    Default:
    
    true
- - format
```
public abstract DateFormat[] format
```
    Default:
    
    {org.springframework.data.elasticsearch.annotations.DateFormat.date_optional_time, org.springframework.data.elasticsearch.annotations.DateFormat.epoch_millis}
- - pattern
```
public abstract String[] pattern
```
    Default:
    
    {}
- - store
```
public abstract boolean store
```
    Default:
    
    false
- - fielddata
```
public abstract boolean fielddata
```
    Default:
    
    false
- - searchAnalyzer
```
public abstract String searchAnalyzer
```
    Default:
    
    ""
- - analyzer
```
public abstract String analyzer
```
    Default:
    
    ""
- - normalizer
```
public abstract String normalizer
```
    Default:
    
    ""
- - ignoreFields
```
public abstract String[] ignoreFields
```
    Default:
    
    {}
- - includeInParent
```
public abstract boolean includeInParent
```
    Default:
    
    false
- - copyTo
```
public abstract String[] copyTo
```
    Default:
    
    {}
- - ignoreAbove
```
public abstract int ignoreAbove
```
    Since:
    
    4.0
    
    Default:
    
    -1
- - coerce
```
public abstract boolean coerce
```
    Since:
    
    4.0
    
    Default:
    
    true
- - docValues
```
public abstract boolean docValues
```
    Since:
    
    4.0
    
    Default:
    
    true
- - ignoreMalformed
```
public abstract boolean ignoreMalformed
```
    Since:
    
    4.0
    
    Default:
    
    false
- - indexOptions
```
public abstract IndexOptions indexOptions
```
    Since:
    
    4.0
    
    Default:
    
    org.springframework.data.elasticsearch.annotations.IndexOptions.none
- - indexPhrases
```
public abstract boolean indexPhrases
```
    Since:
    
    4.0
    
    Default:
    
    false
- - indexPrefixes
```
public abstract IndexPrefixes[] indexPrefixes
```
    implemented as array to enable the empty default value
    
    Since:
    
    4.0
    
    Default:
    
    {}
- - norms
```
public abstract boolean norms
```
    Since:
    
    4.0
    
    Default:
    
    true
- - nullValue
```
public abstract String nullValue
```
    Since:
    
    4.0
    
    Default:
    
    ""
- - positionIncrementGap
```
public abstract int positionIncrementGap
```
    Since:
    
    4.0
    
    Default:
    
    -1
- - similarity
```
public abstract Similarity similarity
```
    Since:
    
    4.0
    
    Default:
    
    org.springframework.data.elasticsearch.annotations.Similarity.Default
- - termVector
```
public abstract TermVector termVector
```
    Since:
    
    4.0
    
    Default:
    
    org.springframework.data.elasticsearch.annotations.TermVector.none
- - scalingFactor
```
public abstract double scalingFactor
```
    Since:
    
    4.0
    
    Default:
    
    1.0
- - maxShingleSize
```
public abstract int maxShingleSize
```
    Since:
    
    4.0
    
    Default:
    
    -1
- - storeNullValue
```
public abstract boolean storeNullValue
```
    if true, the field will be stored in Elasticsearch even if it has a null value
    
    Since:
    
    4.1
    
    Default:
    
    false
- - positiveScoreImpact
```
public abstract boolean positiveScoreImpact
```
    to be used in combination with FieldType.Rank_Feature
    
    Since:
    
    4.1
    
    Default:
    
    true
- - enabled
```
public abstract boolean enabled
```
    to be used in combination with FieldType.Object
    
    Since:
    
    4.1
    
    Default:
    
    true
- - eagerGlobalOrdinals
```
public abstract boolean eagerGlobalOrdinals
```
    Since:
    
    4.1
    
    Default:
    
    false
- - nullValueType
```
public abstract NullValueType nullValueType
```
    Since:
    
    4.1
    
    Default:
    
    org.springframework.data.elasticsearch.annotations.NullValueType.String
- - dims
```
public abstract int dims
```
    to be used in combination with FieldType.Dense_Vector
    
    Since:
    
    4.2
    
    Default:
    
    -1
- - dynamic
```
public abstract Dynamic dynamic
```
    Controls how Elasticsearch dynamically adds fields to the inner object within the document.
    To be used in combination with FieldType.Object or FieldType.Nested
    
    Since:
    
    4.3
    
    Default:
    
    org.springframework.data.elasticsearch.annotations.Dynamic.INHERIT
- - excludeFromSource
```
public abstract boolean excludeFromSource
```
    marks this field to be excluded from the _source in Elasticsearch (https://www.elastic.co/guide/en/elasticsearch/reference/7.15/mapping-source-field.html#include-exclude)
    
    Since:
    
    4.3
    
    Default:
    
    false

Annotation Type Field

Optional Element Summary

Element Detail

value

name

type

index

format

pattern

store

fielddata

searchAnalyzer

analyzer

normalizer

ignoreFields

includeInParent

copyTo

ignoreAbove

coerce

docValues

ignoreMalformed

indexOptions

indexPhrases

indexPrefixes

norms

nullValue

positionIncrementGap

similarity

termVector

scalingFactor

maxShingleSize

storeNullValue

positiveScoreImpact

enabled

eagerGlobalOrdinals

nullValueType

dims

dynamic

excludeFromSource