elasticsearch
Version:
The official low-level Elasticsearch client for Node.js and the browser.
1,426 lines (1,396 loc) • 259 kB
JavaScript
var ca = require('../client_action').makeFactoryWithModifier(function (spec) {
return require('lodash').merge(spec, {
params: {
filterPath: {
type: 'list',
name: 'filter_path'
}
}
});
});
var namespace = require('../client_action').namespaceFactory;
var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', 'tasks'];
/**
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
* @param {<<api-param-type-string,`String`>>} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-string,`String`>>} params.type - Default document type for items which don't provide one
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - Default list of fields to extract and return from the _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>} params.pipeline - The pipeline id to preprocess incoming documents with
* @param {<<api-param-type-string,`String`>>} params.index - Default index for items which don't provide one
*/
api.bulk = ca({
params: {
waitForActiveShards: {
type: 'string',
name: 'wait_for_active_shards'
},
refresh: {
type: 'enum',
options: [
'true',
'false',
'wait_for',
''
]
},
routing: {
type: 'string'
},
timeout: {
type: 'time'
},
type: {
type: 'string'
},
_source: {
type: 'list'
},
_sourceExcludes: {
type: 'list',
name: '_source_excludes'
},
_sourceIncludes: {
type: 'list',
name: '_source_includes'
},
pipeline: {
type: 'string'
}
},
urls: [
{
fmt: '/<%=index%>/<%=type%>/_bulk',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_bulk',
req: {
index: {
type: 'string'
}
}
},
{
fmt: '/_bulk'
}
],
needBody: true,
bulkBody: true,
method: 'POST'
});
api.cat = namespace();
/**
* Perform a [cat.aliases](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.name - A comma-separated list of alias names to return
*/
api.cat.prototype.aliases = ca({
params: {
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
urls: [
{
fmt: '/_cat/aliases/<%=name%>',
req: {
name: {
type: 'list'
}
}
},
{
fmt: '/_cat/aliases'
}
]
});
/**
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-allocation.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.nodeId - A comma-separated list of node IDs or names to limit the returned information
*/
api.cat.prototype.allocation = ca({
params: {
format: {
type: 'string'
},
bytes: {
type: 'enum',
options: [
'b',
'k',
'kb',
'm',
'mb',
'g',
'gb',
't',
'tb',
'p',
'pb'
]
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
urls: [
{
fmt: '/_cat/allocation/<%=nodeId%>',
req: {
nodeId: {
type: 'list'
}
}
},
{
fmt: '/_cat/allocation'
}
]
});
/**
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to limit the returned information
*/
api.cat.prototype.count = ca({
params: {
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
urls: [
{
fmt: '/_cat/count/<%=index%>',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_cat/count'
}
]
});
/**
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-fielddata.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields to return the fielddata size
*/
api.cat.prototype.fielddata = ca({
params: {
format: {
type: 'string'
},
bytes: {
type: 'enum',
options: [
'b',
'k',
'kb',
'm',
'mb',
'g',
'gb',
't',
'tb',
'p',
'pb'
]
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
},
fields: {
type: 'list'
}
},
urls: [
{
fmt: '/_cat/fielddata/<%=fields%>',
req: {
fields: {
type: 'list'
}
}
},
{
fmt: '/_cat/fielddata'
}
]
});
/**
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} [params.ts=true] - Set to false to disable timestamping
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.health = ca({
params: {
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
ts: {
type: 'boolean',
'default': true
},
v: {
type: 'boolean',
'default': false
}
},
url: {
fmt: '/_cat/health'
}
});
/**
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
*/
api.cat.prototype.help = ca({
params: {
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
}
},
url: {
fmt: '/_cat'
}
});
/**
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-indices.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-string,`String`>>} params.health - A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-boolean,`Boolean`>>} params.pri - Set to true to return stats only for primary shards
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeUnloadedSegments - If set to true segment stats will include stats for segments that are not currently loaded into memory
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to limit the returned information
*/
api.cat.prototype.indices = ca({
params: {
format: {
type: 'string'
},
bytes: {
type: 'enum',
options: [
'b',
'k',
'm',
'g'
]
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
health: {
type: 'enum',
'default': null,
options: [
'green',
'yellow',
'red'
]
},
help: {
type: 'boolean',
'default': false
},
pri: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
},
includeUnloadedSegments: {
type: 'boolean',
'default': false,
name: 'include_unloaded_segments'
}
},
urls: [
{
fmt: '/_cat/indices/<%=index%>',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_cat/indices'
}
]
});
/**
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-master.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.master = ca({
params: {
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
url: {
fmt: '/_cat/master'
}
});
/**
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-nodeattrs.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.nodeattrs = ca({
params: {
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
url: {
fmt: '/_cat/nodeattrs'
}
});
/**
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-nodes.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.fullId - Return the full node ID instead of the shortened version (default: false)
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.nodes = ca({
params: {
format: {
type: 'string'
},
fullId: {
type: 'boolean',
name: 'full_id'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
url: {
fmt: '/_cat/nodes'
}
});
/**
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-pending-tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.pendingTasks = ca({
params: {
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
url: {
fmt: '/_cat/pending_tasks'
}
});
/**
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-plugins.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.plugins = ca({
params: {
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
url: {
fmt: '/_cat/plugins'
}
});
/**
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to limit the returned information
*/
api.cat.prototype.recovery = ca({
params: {
format: {
type: 'string'
},
bytes: {
type: 'enum',
options: [
'b',
'k',
'kb',
'm',
'mb',
'g',
'gb',
't',
'tb',
'p',
'pb'
]
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
urls: [
{
fmt: '/_cat/recovery/<%=index%>',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_cat/recovery'
}
]
});
/**
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-repositories.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.repositories = ca({
params: {
format: {
type: 'string'
},
local: {
type: 'boolean',
'default': false
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
url: {
fmt: '/_cat/repositories'
}
});
/**
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to limit the returned information
*/
api.cat.prototype.segments = ca({
params: {
format: {
type: 'string'
},
bytes: {
type: 'enum',
options: [
'b',
'k',
'kb',
'm',
'mb',
'g',
'gb',
't',
'tb',
'p',
'pb'
]
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
urls: [
{
fmt: '/_cat/segments/<%=index%>',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_cat/segments'
}
]
});
/**
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to limit the returned information
*/
api.cat.prototype.shards = ca({
params: {
format: {
type: 'string'
},
bytes: {
type: 'enum',
options: [
'b',
'k',
'kb',
'm',
'mb',
'g',
'gb',
't',
'tb',
'p',
'pb'
]
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
urls: [
{
fmt: '/_cat/shards/<%=index%>',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_cat/shards'
}
]
});
/**
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Set to true to ignore unavailable snapshots
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.repository - Name of repository from which to fetch the snapshot information
*/
api.cat.prototype.snapshots = ca({
params: {
format: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
'default': false,
name: 'ignore_unavailable'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
urls: [
{
fmt: '/_cat/snapshots/<%=repository%>',
req: {
repository: {
type: 'list'
}
}
},
{
fmt: '/_cat/snapshots'
}
]
});
/**
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.actions - A comma-separated list of actions that should be returned. Leave empty to return all.
* @param {<<api-param-type-boolean,`Boolean`>>} params.detailed - Return detailed task information (default: false)
* @param {<<api-param-type-number,`Number`>>} params.parentTask - Return tasks with specified parent task id. Set to -1 to return all.
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.tasks = ca({
params: {
format: {
type: 'string'
},
nodeId: {
type: 'list',
name: 'node_id'
},
actions: {
type: 'list'
},
detailed: {
type: 'boolean'
},
parentTask: {
type: 'number',
name: 'parent_task'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
url: {
fmt: '/_cat/tasks'
}
});
/**
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>} params.name - A pattern that returned template names must match
*/
api.cat.prototype.templates = ca({
params: {
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
urls: [
{
fmt: '/_cat/templates/<%=name%>',
req: {
name: {
type: 'string'
}
}
},
{
fmt: '/_cat/templates'
}
]
});
/**
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-thread-pool.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>} params.size - The multiplier in which to display values
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.threadPoolPatterns - A comma-separated list of regular-expressions to filter the thread pools in the output
*/
api.cat.prototype.threadPool = ca({
params: {
format: {
type: 'string'
},
size: {
type: 'enum',
options: [
'',
'k',
'm',
'g',
't',
'p'
]
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
s: {
type: 'list'
},
v: {
type: 'boolean',
'default': false
}
},
urls: [
{
fmt: '/_cat/thread_pool/<%=threadPoolPatterns%>',
req: {
threadPoolPatterns: {
type: 'list'
}
}
},
{
fmt: '/_cat/thread_pool'
}
]
});
/**
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/search-request-body.html#_clear_scroll_api) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.scrollId - A comma-separated list of scroll IDs to clear
*/
api.clearScroll = ca({
url: {
fmt: '/_search/scroll'
},
paramAsBody: {
param: 'scrollId',
body: 'scroll_id'
},
method: 'DELETE'
});
api.cluster = namespace();
/**
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cluster-allocation-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeYesDecisions - Return 'YES' decisions in explanation (default: false)
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDiskInfo - Return information about disk usage and shard sizes (default: false)
*/
api.cluster.prototype.allocationExplain = ca({
params: {
includeYesDecisions: {
type: 'boolean',
name: 'include_yes_decisions'
},
includeDiskInfo: {
type: 'boolean',
name: 'include_disk_info'
}
},
url: {
fmt: '/_cluster/allocation/explain'
},
method: 'POST'
});
/**
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDefaults - Whether to return all default clusters setting.
*/
api.cluster.prototype.getSettings = ca({
params: {
flatSettings: {
type: 'boolean',
name: 'flat_settings'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
timeout: {
type: 'time'
},
includeDefaults: {
type: 'boolean',
'default': false,
name: 'include_defaults'
}
},
url: {
fmt: '/_cluster/settings'
}
});
/**
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cluster-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=all] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {<<api-param-type-string,`String`>>} [params.level=cluster] - Specify the level of detail for returned information
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Wait until the specified number of shards is active
* @param {<<api-param-type-string,`String`>>} params.waitForNodes - Wait until the specified number of nodes is available
* @param {<<api-param-type-string,`String`>>} params.waitForEvents - Wait until all currently queued events with the given priority are processed
* @param {<<api-param-type-boolean,`Boolean`>>} params.waitForNoRelocatingShards - Whether to wait until there are no relocating shards in the cluster
* @param {<<api-param-type-boolean,`Boolean`>>} params.waitForNoInitializingShards - Whether to wait until there are no initializing shards in the cluster
* @param {<<api-param-type-string,`String`>>} params.waitForStatus - Wait until cluster is in a specific state
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - Limit the information returned to a specific index
*/
api.cluster.prototype.health = ca({
params: {
expandWildcards: {
type: 'enum',
'default': 'all',
options: [
'open',
'closed',
'none',
'all'
],
name: 'expand_wildcards'
},
level: {
type: 'enum',
'default': 'cluster',
options: [
'cluster',
'indices',
'shards'
]
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
timeout: {
type: 'time'
},
waitForActiveShards: {
type: 'string',
name: 'wait_for_active_shards'
},
waitForNodes: {
type: 'string',
name: 'wait_for_nodes'
},
waitForEvents: {
type: 'enum',
options: [
'immediate',
'urgent',
'high',
'normal',
'low',
'languid'
],
name: 'wait_for_events'
},
waitForNoRelocatingShards: {
type: 'boolean',
name: 'wait_for_no_relocating_shards'
},
waitForNoInitializingShards: {
type: 'boolean',
name: 'wait_for_no_initializing_shards'
},
waitForStatus: {
type: 'enum',
'default': null,
options: [
'green',
'yellow',
'red'
],
name: 'wait_for_status'
}
},
urls: [
{
fmt: '/_cluster/health/<%=index%>',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_cluster/health'
}
]
});
/**
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cluster-pending.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
*/
api.cluster.prototype.pendingTasks = ca({
params: {
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
}
},
url: {
fmt: '/_cluster/pending_tasks'
}
});
/**
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.mast