WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› ›

indices.getFieldMapping

edit

indices.getFieldMapping

edit

client.indices.getFieldMapping({
  index: string | string[],
  type: string | string[],
  fields: string | string[],
  include_defaults: boolean,
  ignore_unavailable: boolean,
  allow_no_indices: boolean,
  expand_wildcards: 'open' | 'closed' | 'none' | 'all',
  local: boolean
})

Reference

`index`	`string \| string[]` - A comma-separated list of index names
`type`	`string \| string[]` - A comma-separated list of document types
`fields`	`string \| string[]` - A comma-separated list of fields
`include_defaults` or `includeDefaults`	`boolean` - Whether the default mapping values should be returned as well
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allow_no_indices` or `allowNoIndices`	`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
`expand_wildcards` or `expandWildcards`	`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. Default: `open`
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)

« indices.getAlias indices.getMapping »