habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API generation

Browse Source
This commit is contained in:
delvedor
2020-04-30 11:28:37 +02:00
parent 5db574a576
commit 0d5c7a880f
22 changed files with 541 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
api/api/autoscaling.delete_autoscaling_policy.js
View File

@ -21,6 +21,7 @@ function buildAutoscalingDeleteAutoscalingPolicy (opts) {
/**
* Perform a autoscaling.delete_autoscaling_policy request
* Deletes an autoscaling policy.
* https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html
*/
return function autoscalingDeleteAutoscalingPolicy (params, options, callback) {

1
api/api/autoscaling.get_autoscaling_policy.js
View File

@ -21,6 +21,7 @@ function buildAutoscalingGetAutoscalingPolicy (opts) {
/**
* Perform a autoscaling.get_autoscaling_policy request
* Retrieves an autoscaling policy.
* https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html
*/
return function autoscalingGetAutoscalingPolicy (params, options, callback) {

1
api/api/autoscaling.put_autoscaling_policy.js
View File

@ -21,6 +21,7 @@ function buildAutoscalingPutAutoscalingPolicy (opts) {
/**
* Perform a autoscaling.put_autoscaling_policy request
* Creates a new autoscaling policy.
* https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html
*/
return function autoscalingPutAutoscalingPolicy (params, options, callback) {

2
api/api/bulk.js
View File

@ -23,6 +23,7 @@ function buildBulk (opts) {
'_source_includes',
'_source_include',
'pipeline',
'prefer_v2_templates',
'pretty',
'human',
'error_trace',
@ -36,6 +37,7 @@ function buildBulk (opts) {
_sourceExclude: '_source_exclude',
_sourceIncludes: '_source_includes',
_sourceInclude: '_source_include',
preferV2Templates: 'prefer_v2_templates',
errorTrace: 'error_trace',
filterPath: 'filter_path'
}

79
api/api/cluster.delete_voting_config_exclusions.js Normal file
View File

@ -0,0 +1,79 @@
// Licensed to Elasticsearch B.V under one or more agreements.
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildClusterDeleteVotingConfigExclusions (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [
'wait_for_removal',
'pretty',
'human',
'error_trace',
'source',
'filter_path'
]
const snakeCase = {
waitForRemoval: 'wait_for_removal',
errorTrace: 'error_trace',
filterPath: 'filter_path'
}
/**
* Perform a cluster.delete_voting_config_exclusions request
* Clears cluster voting config exclusions.
* https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html
*/
return function clusterDeleteVotingConfigExclusions (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// validate headers object
if (options.headers != null && typeof options.headers !== 'object') {
const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
return handleError(err, callback)
}
var warnings = []
var { method, body, ...querystring } = params
querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
var ignore = options.ignore
if (typeof ignore === 'number') {
options.ignore = [ignore]
}
var path = ''
if (method == null) method = 'DELETE'
path = '/' + '_cluster' + '/' + 'voting_config_exclusions'
// build request object
const request = {
method,
path,
body: body || '',
querystring
}
options.warnings = warnings.length === 0 ? null : warnings
return makeRequest(request, options, callback)
}
}
module.exports = buildClusterDeleteVotingConfigExclusions

82
api/api/cluster.post_voting_config_exclusions.js Normal file
View File

@ -0,0 +1,82 @@
// Licensed to Elasticsearch B.V under one or more agreements.
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildClusterPostVotingConfigExclusions (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [
'node_ids',
'node_names',
'timeout',
'pretty',
'human',
'error_trace',
'source',
'filter_path'
]
const snakeCase = {
nodeIds: 'node_ids',
nodeNames: 'node_names',
errorTrace: 'error_trace',
filterPath: 'filter_path'
}
/**
* Perform a cluster.post_voting_config_exclusions request
* Updates the cluster voting config exclusions by node ids or node names.
* https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html
*/
return function clusterPostVotingConfigExclusions (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// validate headers object
if (options.headers != null && typeof options.headers !== 'object') {
const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
return handleError(err, callback)
}
var warnings = []
var { method, body, ...querystring } = params
querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
var ignore = options.ignore
if (typeof ignore === 'number') {
options.ignore = [ignore]
}
var path = ''
if (method == null) method = 'POST'
path = '/' + '_cluster' + '/' + 'voting_config_exclusions'
// build request object
const request = {
method,
path,
body: body || '',
querystring
}
options.warnings = warnings.length === 0 ? null : warnings
return makeRequest(request, options, callback)
}
}
module.exports = buildClusterPostVotingConfigExclusions

2
api/api/create.js
View File

@ -19,6 +19,7 @@ function buildCreate (opts) {
'version',
'version_type',
'pipeline',
'prefer_v2_templates',
'pretty',
'human',
'error_trace',
@ -29,6 +30,7 @@ function buildCreate (opts) {
const snakeCase = {
waitForActiveShards: 'wait_for_active_shards',
versionType: 'version_type',
preferV2Templates: 'prefer_v2_templates',
errorTrace: 'error_trace',
filterPath: 'filter_path'
}

2
api/api/eql.search.js
View File

@ -22,7 +22,7 @@ function buildEqlSearch (opts) {
/**
* Perform a eql.search request
* Returns results matching a query expressed in Event Query Language (EQL)
* https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html
* https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html
*/
return function eqlSearch (params, options, callback) {
options = options || {}

2
api/api/index.js
View File

@ -22,6 +22,7 @@ function buildIndex (opts) {
'if_seq_no',
'if_primary_term',
'pipeline',
'prefer_v2_templates',
'pretty',
'human',
'error_trace',
@ -35,6 +36,7 @@ function buildIndex (opts) {
versionType: 'version_type',
ifSeqNo: 'if_seq_no',
ifPrimaryTerm: 'if_primary_term',
preferV2Templates: 'prefer_v2_templates',
errorTrace: 'error_trace',
filterPath: 'filter_path'
}

2
api/api/indices.create.js
View File

@ -15,6 +15,7 @@ function buildIndicesCreate (opts) {
'wait_for_active_shards',
'timeout',
'master_timeout',
'prefer_v2_templates',
'pretty',
'human',
'error_trace',
@ -25,6 +26,7 @@ function buildIndicesCreate (opts) {
const snakeCase = {
waitForActiveShards: 'wait_for_active_shards',
masterTimeout: 'master_timeout',
preferV2Templates: 'prefer_v2_templates',
errorTrace: 'error_trace',
filterPath: 'filter_path'
}

2
api/api/indices.rollover.js
View File

@ -16,6 +16,7 @@ function buildIndicesRollover (opts) {
'dry_run',
'master_timeout',
'wait_for_active_shards',
'prefer_v2_templates',
'pretty',
'human',
'error_trace',
@ -27,6 +28,7 @@ function buildIndicesRollover (opts) {
dryRun: 'dry_run',
masterTimeout: 'master_timeout',
waitForActiveShards: 'wait_for_active_shards',
preferV2Templates: 'prefer_v2_templates',
errorTrace: 'error_trace',
filterPath: 'filter_path'
}

85
api/api/indices.simulate_index_template.js Normal file
View File

@ -0,0 +1,85 @@
// Licensed to Elasticsearch B.V under one or more agreements.
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildIndicesSimulateIndexTemplate (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [
'master_timeout',
'pretty',
'human',
'error_trace',
'source',
'filter_path'
]
const snakeCase = {
masterTimeout: 'master_timeout',
errorTrace: 'error_trace',
filterPath: 'filter_path'
}
/**
* Perform a indices.simulate_index_template request
* Simulate matching the given index name against the index templates in the system
* https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html
*/
return function indicesSimulateIndexTemplate (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// check required parameters
if (params['name'] == null) {
const err = new ConfigurationError('Missing required parameter: name')
return handleError(err, callback)
}
// validate headers object
if (options.headers != null && typeof options.headers !== 'object') {
const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
return handleError(err, callback)
}
var warnings = []
var { method, body, name, ...querystring } = params
querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
var ignore = options.ignore
if (typeof ignore === 'number') {
options.ignore = [ignore]
}
var path = ''
if (method == null) method = 'POST'
path = '/' + '_index_template' + '/' + '_simulate_index' + '/' + encodeURIComponent(name)
// build request object
const request = {
method,
path,
body: body || '',
querystring
}
options.warnings = warnings.length === 0 ? null : warnings
return makeRequest(request, options, callback)
}
}
module.exports = buildIndicesSimulateIndexTemplate

9
api/api/nodes.hot_threads.js
View File

@ -68,15 +68,6 @@ function buildNodesHotThreads (opts) {
if ((node_id || nodeId) != null) {
if (method == null) method = 'GET'
path = '/' + '_nodes' + '/' + encodeURIComponent(node_id || nodeId) + '/' + 'hot_threads'
} else if ((node_id || nodeId) != null) {
if (method == null) method = 'GET'
path = '/' + '_cluster' + '/' + 'nodes' + '/' + encodeURIComponent(node_id || nodeId) + '/' + 'hotthreads'
} else if ((node_id || nodeId) != null) {
if (method == null) method = 'GET'
path = '/' + '_nodes' + '/' + encodeURIComponent(node_id || nodeId) + '/' + 'hotthreads'
} else if ((node_id || nodeId) != null) {
if (method == null) method = 'GET'
path = '/' + '_cluster' + '/' + 'nodes' + '/' + encodeURIComponent(node_id || nodeId) + '/' + 'hot_threads'
} else {
if (method == null) method = 'GET'
path = '/' + '_nodes' + '/' + 'hot_threads'

1
api/api/searchable_snapshots.clear_cache.js
View File

@ -27,6 +27,7 @@ function buildSearchableSnapshotsClearCache (opts) {
/**
* Perform a searchable_snapshots.clear_cache request
* Clear the cache of searchable snapshots.
* https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-clear-cache.html
*/
return function searchableSnapshotsClearCache (params, options, callback) {

1
api/api/searchable_snapshots.mount.js
View File

@ -23,6 +23,7 @@ function buildSearchableSnapshotsMount (opts) {
/**
* Perform a searchable_snapshots.mount request
* Mount a snapshot as a searchable index.
* https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html
*/
return function searchableSnapshotsMount (params, options, callback) {

78
api/api/searchable_snapshots.repository_stats.js Normal file
View File

@ -0,0 +1,78 @@
// Licensed to Elasticsearch B.V under one or more agreements.
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildSearchableSnapshotsRepositoryStats (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [
]
const snakeCase = {
}
/**
* Perform a searchable_snapshots.repository_stats request
* Retrieve usage statistics about a snapshot repository.
* https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-repository-stats.html
*/
return function searchableSnapshotsRepositoryStats (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// check required parameters
if (params['repository'] == null) {
const err = new ConfigurationError('Missing required parameter: repository')
return handleError(err, callback)
}
// validate headers object
if (options.headers != null && typeof options.headers !== 'object') {
const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
return handleError(err, callback)
}
var warnings = []
var { method, body, repository, ...querystring } = params
querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
var ignore = options.ignore
if (typeof ignore === 'number') {
options.ignore = [ignore]
}
var path = ''
if (method == null) method = 'GET'
path = '/' + '_snapshot' + '/' + encodeURIComponent(repository) + '/' + '_stats'
// build request object
const request = {
method,
path,
body: null,
querystring
}
options.warnings = warnings.length === 0 ? null : warnings
return makeRequest(request, options, callback)
}
}
module.exports = buildSearchableSnapshotsRepositoryStats

1
api/api/searchable_snapshots.stats.js
View File

@ -21,6 +21,7 @@ function buildSearchableSnapshotsStats (opts) {
/**
* Perform a searchable_snapshots.stats request
* Retrieve various statistics about searchable snapshots.
* https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-stats.html
*/
return function searchableSnapshotsStats (params, options, callback) {

2
api/api/update.js
View File

@ -25,6 +25,7 @@ function buildUpdate (opts) {
'timeout',
'if_seq_no',
'if_primary_term',
'prefer_v2_templates',
'pretty',
'human',
'error_trace',
@ -41,6 +42,7 @@ function buildUpdate (opts) {
retryOnConflict: 'retry_on_conflict',
ifSeqNo: 'if_seq_no',
ifPrimaryTerm: 'if_primary_term',
preferV2Templates: 'prefer_v2_templates',
errorTrace: 'error_trace',
filterPath: 'filter_path'
}

10
api/index.js
View File

@ -102,6 +102,8 @@ function ESAPI (opts) {
allocationExplain: lazyLoad('cluster.allocation_explain', opts),
delete_component_template: lazyLoad('cluster.delete_component_template', opts),
deleteComponentTemplate: lazyLoad('cluster.delete_component_template', opts),
delete_voting_config_exclusions: lazyLoad('cluster.delete_voting_config_exclusions', opts),
deleteVotingConfigExclusions: lazyLoad('cluster.delete_voting_config_exclusions', opts),
exists_component_template: lazyLoad('cluster.exists_component_template', opts),
existsComponentTemplate: lazyLoad('cluster.exists_component_template', opts),
get_component_template: lazyLoad('cluster.get_component_template', opts),
@ -111,6 +113,8 @@ function ESAPI (opts) {
health: lazyLoad('cluster.health', opts),
pending_tasks: lazyLoad('cluster.pending_tasks', opts),
pendingTasks: lazyLoad('cluster.pending_tasks', opts),
post_voting_config_exclusions: lazyLoad('cluster.post_voting_config_exclusions', opts),
postVotingConfigExclusions: lazyLoad('cluster.post_voting_config_exclusions', opts),
put_component_template: lazyLoad('cluster.put_component_template', opts),
putComponentTemplate: lazyLoad('cluster.put_component_template', opts),
put_settings: lazyLoad('cluster.put_settings', opts),
@ -285,6 +289,8 @@ function ESAPI (opts) {
shard_stores: lazyLoad('indices.shard_stores', opts),
shardStores: lazyLoad('indices.shard_stores', opts),
shrink: lazyLoad('indices.shrink', opts),
simulate_index_template: lazyLoad('indices.simulate_index_template', opts),
simulateIndexTemplate: lazyLoad('indices.simulate_index_template', opts),
split: lazyLoad('indices.split', opts),
stats: lazyLoad('indices.stats', opts),
unfreeze: lazyLoad('indices.unfreeze', opts),
@ -496,12 +502,16 @@ function ESAPI (opts) {
clear_cache: lazyLoad('searchable_snapshots.clear_cache', opts),
clearCache: lazyLoad('searchable_snapshots.clear_cache', opts),
mount: lazyLoad('searchable_snapshots.mount', opts),
repository_stats: lazyLoad('searchable_snapshots.repository_stats', opts),
repositoryStats: lazyLoad('searchable_snapshots.repository_stats', opts),
stats: lazyLoad('searchable_snapshots.stats', opts)
},
searchableSnapshots: {
clear_cache: lazyLoad('searchable_snapshots.clear_cache', opts),
clearCache: lazyLoad('searchable_snapshots.clear_cache', opts),
mount: lazyLoad('searchable_snapshots.mount', opts),
repository_stats: lazyLoad('searchable_snapshots.repository_stats', opts),
repositoryStats: lazyLoad('searchable_snapshots.repository_stats', opts),
stats: lazyLoad('searchable_snapshots.stats', opts)
},
security: {

29
api/requestParams.d.ts vendored
View File

@ -27,6 +27,7 @@ export interface Bulk<T = RequestNDBody> extends Generic {
_source_excludes?: string | string[];
_source_includes?: string | string[];
pipeline?: string;
prefer_v2_templates?: boolean;
body: T;
}
@ -268,6 +269,10 @@ export interface ClusterDeleteComponentTemplate extends Generic {
master_timeout?: string;
}
export interface ClusterDeleteVotingConfigExclusions extends Generic {
wait_for_removal?: boolean;
}
export interface ClusterExistsComponentTemplate extends Generic {
name: string;
master_timeout?: string;
@ -307,6 +312,12 @@ export interface ClusterPendingTasks extends Generic {
master_timeout?: string;
}
export interface ClusterPostVotingConfigExclusions extends Generic {
node_ids?: string;
node_names?: string;
timeout?: string;
}
export interface ClusterPutComponentTemplate<T = RequestBody> extends Generic {
name: string;
create?: boolean;
@ -384,6 +395,7 @@ export interface Create<T = RequestBody> extends Generic {
version?: number;
version_type?: 'internal' | 'external' | 'external_gte';
pipeline?: string;
prefer_v2_templates?: boolean;
body: T;
}
@ -571,6 +583,7 @@ export interface Index<T = RequestBody> extends Generic {
if_seq_no?: number;
if_primary_term?: number;
pipeline?: string;
prefer_v2_templates?: boolean;
body: T;
}
@ -614,6 +627,7 @@ export interface IndicesCreate<T = RequestBody> extends Generic {
wait_for_active_shards?: string;
timeout?: string;
master_timeout?: string;
prefer_v2_templates?: boolean;
body?: T;
}
@ -867,6 +881,7 @@ export interface IndicesRollover<T = RequestBody> extends Generic {
dry_run?: boolean;
master_timeout?: string;
wait_for_active_shards?: string;
prefer_v2_templates?: boolean;
body?: T;
}
@ -895,6 +910,12 @@ export interface IndicesShrink<T = RequestBody> extends Generic {
body?: T;
}
export interface IndicesSimulateIndexTemplate<T = RequestBody> extends Generic {
name: string;
master_timeout?: string;
body?: T;
}
export interface IndicesSplit<T = RequestBody> extends Generic {
index: string;
target: string;
@ -1053,9 +1074,10 @@ export interface NodesInfo extends Generic {
timeout?: string;
}
export interface NodesReloadSecureSettings extends Generic {
export interface NodesReloadSecureSettings<T = RequestBody> extends Generic {
node_id?: string | string[];
timeout?: string;
body?: T;
}
export interface NodesStats extends Generic {
@ -1335,6 +1357,7 @@ export interface Update<T = RequestBody> extends Generic {
timeout?: string;
if_seq_no?: number;
if_primary_term?: number;
prefer_v2_templates?: boolean;
body: T;
}
@ -2209,6 +2232,10 @@ export interface SearchableSnapshotsMount<T = RequestBody> extends Generic {
body: T;
}
export interface SearchableSnapshotsRepositoryStats extends Generic {
repository: string;
}
export interface SearchableSnapshotsStats extends Generic {
index?: string | string[];
}

114
docs/reference.asciidoc
View File

@ -110,6 +110,7 @@ client.bulk({
_source_excludes: string | string[],
_source_includes: string | string[],
pipeline: string,
prefer_v2_templates: boolean,
body: object
})
----
@ -147,6 +148,9 @@ link:{ref}/docs-bulk.html[Documentation] +
|`pipeline`
|`string` - The pipeline id to preprocess incoming documents with
|`prefer_v2_templates` or `preferV2Templates`
|`boolean` - favor V2 templates instead of V1 templates during automatic index creation
|`body`
|`object` - The operation definition and data (action-data pairs), separated by newlines
@ -1109,6 +1113,23 @@ link:{ref}/indices-component-templates.html[Documentation] +
|===
=== cluster.deleteVotingConfigExclusions
[source,ts]
----
client.cluster.deleteVotingConfigExclusions({
wait_for_removal: boolean
})
----
link:{ref}/voting-config-exclusions.html[Documentation] +
[cols=2*]
|===
|`wait_for_removal` or `waitForRemoval`
|`boolean` - Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. +
_Default:_ `true`
|===
=== cluster.existsComponentTemplate
[source,ts]
@ -1267,6 +1288,31 @@ link:{ref}/cluster-pending.html[Documentation] +
|===
=== cluster.postVotingConfigExclusions
[source,ts]
----
client.cluster.postVotingConfigExclusions({
node_ids: string,
node_names: string,
timeout: string
})
----
link:{ref}/voting-config-exclusions.html[Documentation] +
[cols=2*]
|===
|`node_ids` or `nodeIds`
|`string` - A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names.
|`node_names` or `nodeNames`
|`string` - A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids.
|`timeout`
|`string` - Explicit operation timeout +
_Default:_ `30s`
|===
=== cluster.putComponentTemplate
[source,ts]
@ -1546,6 +1592,7 @@ client.create({
version: number,
version_type: 'internal' | 'external' | 'external_gte',
pipeline: string,
prefer_v2_templates: boolean,
body: object
})
----
@ -1584,6 +1631,9 @@ WARNING: This parameter has been deprecated.
|`pipeline`
|`string` - The pipeline id to preprocess incoming documents with
|`prefer_v2_templates` or `preferV2Templates`
|`boolean` - favor V2 templates instead of V1 templates during automatic index creation
|`body`
|`object` - The document
@ -2251,6 +2301,7 @@ client.index({
if_seq_no: number,
if_primary_term: number,
pipeline: string,
prefer_v2_templates: boolean,
body: object
})
----
@ -2293,6 +2344,9 @@ link:{ref}/docs-index_.html[Documentation] +
|`pipeline`
|`string` - The pipeline id to preprocess incoming documents with
|`prefer_v2_templates` or `preferV2Templates`
|`boolean` - favor V2 templates instead of V1 templates during automatic index creation
|`body`
|`object` - The document
@ -2449,6 +2503,7 @@ client.indices.create({
wait_for_active_shards: string,
timeout: string,
master_timeout: string,
prefer_v2_templates: boolean,
body: object
})
----
@ -2467,6 +2522,9 @@ link:{ref}/indices-create-index.html[Documentation] +
|`master_timeout` or `masterTimeout`
|`string` - Specify timeout for connection to master
|`prefer_v2_templates` or `preferV2Templates`
|`boolean` - favor V2 templates instead of V1 templates during index creation
|`body`
|`object` - The configuration for the index (`settings` and `mappings`)
@ -3471,6 +3529,7 @@ client.indices.rollover({
dry_run: boolean,
master_timeout: string,
wait_for_active_shards: string,
prefer_v2_templates: boolean,
body: object
})
----
@ -3495,6 +3554,9 @@ link:{ref}/indices-rollover-index.html[Documentation] +
|`wait_for_active_shards` or `waitForActiveShards`
|`string` - Set the number of active shards to wait for on the newly created rollover index before the operation returns.
|`prefer_v2_templates` or `preferV2Templates`
|`boolean` - favor V2 templates instead of V1 templates during automatic index creation
|`body`
|`object` - The conditions that needs to be met for executing rollover
@ -3602,6 +3664,30 @@ link:{ref}/indices-shrink-index.html[Documentation] +
|===
=== indices.simulateIndexTemplate
[source,ts]
----
client.indices.simulateIndexTemplate({
name: string,
master_timeout: string,
body: object
})
----
link:{ref}/indices-templates.html[Documentation] +
[cols=2*]
|===
|`name`
|`string` - The name of the index (it must be a concrete index name)
|`master_timeout` or `masterTimeout`
|`string` - Specify timeout for connection to master
|`body`
|`object` - New index template definition, which will be included in the simulation, as if it already exists in the system
|===
=== indices.split
[source,ts]
@ -4242,7 +4328,8 @@ link:{ref}/cluster-nodes-info.html[Documentation] +
----
client.nodes.reloadSecureSettings({
node_id: string | string[],
timeout: string
timeout: string,
body: object
})
----
link:{ref}/secure-settings.html#reloadable-secure-settings[Documentation] +
@ -4254,6 +4341,9 @@ link:{ref}/secure-settings.html#reloadable-secure-settings[Documentation] +
|`timeout`
|`string` - Explicit operation timeout
|`body`
|`object` - An object containing the password for the elasticsearch keystore
|===
=== nodes.stats
@ -5330,6 +5420,7 @@ client.update({
timeout: string,
if_seq_no: number,
if_primary_term: number,
prefer_v2_templates: boolean,
body: object
})
----
@ -5381,6 +5472,9 @@ WARNING: This parameter has been deprecated.
|`if_primary_term` or `ifPrimaryTerm`
|`number` - only perform the update operation if the last operation that has changed the document has the specified primary term
|`prefer_v2_templates` or `preferV2Templates`
|`boolean` - favor V2 templates instead of V1 templates during automatic index creation
|`body`
|`object` - The request definition requires either `script` or partial `doc`
@ -6618,7 +6712,7 @@ client.eql.search({
body: object
})
----
link:{ref}/eql.html[Documentation] +
link:{ref}/eql-search-api.html[Documentation] +
[cols=2*]
|===
|`index`
@ -8862,6 +8956,22 @@ link:{ref}/searchable-snapshots-api-mount-snapshot.html[Documentation] +
|===
=== searchableSnapshots.repositoryStats
*Stability:* experimental
[source,ts]
----
client.searchableSnapshots.repositoryStats({
repository: string
})
----
link:{ref}/searchable-snapshots-repository-stats.html[Documentation] +
[cols=2*]
|===
|`repository`
|`string` - The repository for which to get the stats for
|===
=== searchableSnapshots.stats
*Stability:* experimental
[source,ts]

56
index.d.ts vendored
View File

@ -423,6 +423,14 @@ declare class Client extends EventEmitter {
deleteComponentTemplate<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
deleteComponentTemplate<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterDeleteComponentTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
deleteComponentTemplate<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterDeleteComponentTemplate, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
delete_voting_config_exclusions<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.ClusterDeleteVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
delete_voting_config_exclusions<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
delete_voting_config_exclusions<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterDeleteVotingConfigExclusions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
delete_voting_config_exclusions<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterDeleteVotingConfigExclusions, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
deleteVotingConfigExclusions<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.ClusterDeleteVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
deleteVotingConfigExclusions<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
deleteVotingConfigExclusions<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterDeleteVotingConfigExclusions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
deleteVotingConfigExclusions<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterDeleteVotingConfigExclusions, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
exists_component_template<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.ClusterExistsComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
exists_component_template<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
exists_component_template<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterExistsComponentTemplate, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
@ -459,6 +467,14 @@ declare class Client extends EventEmitter {
pendingTasks<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
pendingTasks<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterPendingTasks, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
pendingTasks<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterPendingTasks, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
post_voting_config_exclusions<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.ClusterPostVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
post_voting_config_exclusions<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
post_voting_config_exclusions<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterPostVotingConfigExclusions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
post_voting_config_exclusions<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterPostVotingConfigExclusions, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
postVotingConfigExclusions<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.ClusterPostVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
postVotingConfigExclusions<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
postVotingConfigExclusions<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterPostVotingConfigExclusions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
postVotingConfigExclusions<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterPostVotingConfigExclusions, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
put_component_template<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.ClusterPutComponentTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
put_component_template<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
put_component_template<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.ClusterPutComponentTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
@ -1113,6 +1129,14 @@ declare class Client extends EventEmitter {
shrink<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
shrink<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.IndicesShrink<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
shrink<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.IndicesShrink<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
simulate_index_template<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.IndicesSimulateIndexTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
simulate_index_template<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
simulate_index_template<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.IndicesSimulateIndexTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
simulate_index_template<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.IndicesSimulateIndexTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
simulateIndexTemplate<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.IndicesSimulateIndexTemplate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
simulateIndexTemplate<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
simulateIndexTemplate<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.IndicesSimulateIndexTemplate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
simulateIndexTemplate<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.IndicesSimulateIndexTemplate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
split<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.IndicesSplit<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
split<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
split<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.IndicesSplit<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
@ -1741,14 +1765,14 @@ declare class Client extends EventEmitter {
info<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
info<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.NodesInfo, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
info<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.NodesInfo, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reload_secure_settings<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.NodesReloadSecureSettings, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
reload_secure_settings<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reload_secure_settings<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.NodesReloadSecureSettings, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reload_secure_settings<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.NodesReloadSecureSettings, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reloadSecureSettings<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.NodesReloadSecureSettings, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
reloadSecureSettings<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reloadSecureSettings<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.NodesReloadSecureSettings, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reloadSecureSettings<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.NodesReloadSecureSettings, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reload_secure_settings<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.NodesReloadSecureSettings<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
reload_secure_settings<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reload_secure_settings<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.NodesReloadSecureSettings<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reload_secure_settings<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.NodesReloadSecureSettings<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reloadSecureSettings<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.NodesReloadSecureSettings<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
reloadSecureSettings<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reloadSecureSettings<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.NodesReloadSecureSettings<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
reloadSecureSettings<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.NodesReloadSecureSettings<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stats<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.NodesStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
stats<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.NodesStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
@ -1909,6 +1933,14 @@ declare class Client extends EventEmitter {
mount<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
mount<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsMount<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
mount<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsMount<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repository_stats<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.SearchableSnapshotsRepositoryStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
repository_stats<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repository_stats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsRepositoryStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repository_stats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsRepositoryStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repositoryStats<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.SearchableSnapshotsRepositoryStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
repositoryStats<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repositoryStats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsRepositoryStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repositoryStats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsRepositoryStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stats<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.SearchableSnapshotsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
stats<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
@ -1927,6 +1959,14 @@ declare class Client extends EventEmitter {
mount<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
mount<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsMount<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
mount<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsMount<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repository_stats<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.SearchableSnapshotsRepositoryStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
repository_stats<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repository_stats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsRepositoryStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repository_stats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsRepositoryStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repositoryStats<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.SearchableSnapshotsRepositoryStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
repositoryStats<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repositoryStats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsRepositoryStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
repositoryStats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsRepositoryStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stats<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.SearchableSnapshotsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
stats<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stats<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.SearchableSnapshotsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback