Types: `Data Types Data Type Field Config`
data-types.DataTypeFieldConfig
The configuration for an individual field
Indexable
▪ [extra: string
]: unknown
Table of contents
Properties
Properties
array
• Optional
array: boolean
Indicates whether the field is an array
Defined in
description
• Optional
description: string
A description for the fields
Defined in
format
• Optional
format: string
Specify the format for a specific fields. Currently this is only support with FieldType.Date
Defined in
indexed
• Optional
indexed: boolean
Specifies whether the field is index in elasticsearch
(Not supported by some field types... see indexedRequiredFieldTypes for types that cannot be false)
Default
true
Defined in
is_primary_date
• Optional
is_primary_date: boolean
The default date field used primarily for naming timeseries indices
Defined in
locale
• Optional
locale: string
Specify the locale for the field (not compatible with all fields) Must be represented in a Language Tags (BCP 47)
Defined in
time_resolution
• Optional
time_resolution: TimeResolution
Indicates whether the data has second or millisecond resolutions
used with the is_primary_date
Defined in
type
• type: DeprecatedFieldType
| FieldType
The type of field
Defined in
use_fields_hack
• Optional
use_fields_hack: boolean
A temporary flag to fix KeywordCaseInsensitive to be a type keyword with case insensitive .text fields