113 lines
6.2 KiB
Plaintext
113 lines
6.2 KiB
Plaintext
[[reference-shared-types--global-field-caps]]
|
||
|
||
////////
|
||
===========================================================================================================================
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||
|| ||
|
||
|| ||
|
||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||
|| You should update the script that does the generation, which can be found in: ||
|
||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||
|| ||
|
||
|| You can run the script with the following command: ||
|
||
|| npm run elasticsearch -- --version <version> ||
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
===========================================================================================================================
|
||
////////
|
||
|
||
|
||
|
||
== Shared FieldCaps types
|
||
|
||
|
||
[discrete]
|
||
[[FieldCapsFieldCapability]]
|
||
=== FieldCapsFieldCapability
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface FieldCapsFieldCapability {
|
||
pass:[/**] @property aggregatable Whether this field can be aggregated on all indices. */
|
||
aggregatable: boolean
|
||
pass:[/**] @property indices The list of indices where this field has the same type family, or null if all indices have the same type family for the field. */
|
||
indices?: <<Indices>>
|
||
pass:[/**] @property meta Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key. */
|
||
meta?: <<Metadata>>
|
||
pass:[/**] @property non_aggregatable_indices The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field. */
|
||
non_aggregatable_indices?: <<Indices>>
|
||
pass:[/**] @property non_searchable_indices The list of indices where this field is not searchable, or null if all indices have the same definition for the field. */
|
||
non_searchable_indices?: <<Indices>>
|
||
pass:[/**] @property searchable Whether this field is indexed for search on all indices. */
|
||
searchable: boolean
|
||
type: string
|
||
pass:[/**] @property metadata_field Whether this field is registered as a metadata field. */
|
||
metadata_field?: boolean
|
||
pass:[/**] @property time_series_dimension Whether this field is used as a time series dimension. */
|
||
time_series_dimension?: boolean
|
||
pass:[/**] @property time_series_metric Contains metric type if this fields is used as a time series metrics, absent if the field is not used as metric. */
|
||
time_series_metric?: <<MappingTimeSeriesMetricType>>
|
||
pass:[/**] @property non_dimension_indices If this list is present in response then some indices have the field marked as a dimension and other indices, the ones in this list, do not. */
|
||
non_dimension_indices?: <<IndexName>>[]
|
||
pass:[/**] @property metric_conflicts_indices The list of indices where this field is present if these indices don’t have the same `time_series_metric` value for this field. */
|
||
metric_conflicts_indices?: <<IndexName>>[]
|
||
}
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|
||
|
||
[discrete]
|
||
[[FieldCapsRequest]]
|
||
=== FieldCapsRequest
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface FieldCapsRequest extends <<RequestBase>> {
|
||
index?: <<Indices>>
|
||
allow_no_indices?: boolean
|
||
expand_wildcards?: <<ExpandWildcards>>
|
||
ignore_unavailable?: boolean
|
||
include_unmapped?: boolean
|
||
filters?: string
|
||
types?: string[]
|
||
include_empty_fields?: boolean
|
||
fields?: <<Fields>>
|
||
index_filter?: <<QueryDslQueryContainer>>
|
||
runtime_mappings?: <<MappingRuntimeFields>>
|
||
}
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|
||
|
||
[discrete]
|
||
[[FieldCapsResponse]]
|
||
=== FieldCapsResponse
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface FieldCapsResponse {
|
||
indices: <<Indices>>
|
||
fields: Record<<<Field>>, Record<string, <<FieldCapsFieldCapability>>>>
|
||
}
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|