NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« indices.rollover indices.shardStores »

› ›

indices.segments

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

indices.segments

edit

client.indices.segments({
  index: string | string[],
  ignore_unavailable: boolean,
  allow_no_indices: boolean,
  expand_wildcards: 'open' | 'closed' | 'none' | 'all',
  verbose: boolean
})

Reference

`index`	`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`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`
`verbose`	`boolean` - Includes detailed memory usage by Lucene.

« indices.rollover indices.shardStores »