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
2019-03-27 07:50:42 +01:00
parent 81e09a71c2
commit 8f131d5a6d
26 changed files with 1072 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
api/api/ccr.follow.js
View File

@ -29,15 +29,16 @@ function buildCcrFollow (opts) {
* Perform a [ccr.follow](https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html) request
*
* @param {string} index - The name of the follower index
* @param {string} wait_for_active_shards - Sets the number of shard copies that must be active before returning. Defaults to 0. 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 {object} body - The name of the leader index and other optional ccr related parameters
*/
const acceptedQuerystring = [
'wait_for_active_shards'
]
const snakeCase = {
waitForActiveShards: 'wait_for_active_shards'
}
return function ccrFollow (params, options, callback) {

125
api/api/ccr.follow_info.js Normal file
View File

@ -0,0 +1,125 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildCcrFollowInfo (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError } = opts
/**
* Perform a [ccr.follow_info](https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html) request
*
* @param {list} index - A comma-separated list of index patterns; use `_all` to perform the operation on all indices
*/
const acceptedQuerystring = [
]
const snakeCase = {
}
return function ccrFollowInfo (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// promises support
if (callback == null) {
return new Promise((resolve, reject) => {
ccrFollowInfo(params, options, (err, body) => {
err ? reject(err) : resolve(body)
})
})
}
// 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 = null
var { method, body, index } = params
var querystring = semicopy(params, ['method', 'body', 'index'])
if (method == null) {
method = 'GET'
}
var ignore = options.ignore || null
if (typeof ignore === 'number') {
ignore = [ignore]
}
var path = ''
path = '/' + encodeURIComponent(index) + '/' + '_ccr' + '/' + 'info'
// build request object
const request = {
method,
path,
body: null,
querystring
}
const requestOptions = {
ignore,
requestTimeout: options.requestTimeout || null,
maxRetries: options.maxRetries || null,
asStream: options.asStream || false,
headers: options.headers || null,
querystring: options.querystring || null,
compression: options.compression || false,
warnings
}
return makeRequest(request, requestOptions, callback)
function semicopy (obj, exclude) {
var target = {}
var keys = Object.keys(obj)
for (var i = 0, len = keys.length; i < len; i++) {
var key = keys[i]
if (exclude.indexOf(key) === -1) {
target[snakeCase[key] || key] = obj[key]
if (acceptedQuerystring.indexOf(snakeCase[key] || key) === -1) {
warnings = warnings || []
warnings.push('Client - Unknown parameter: "' + key + '", sending it as query parameter')
}
}
}
return target
}
}
}
module.exports = buildCcrFollowInfo

136
api/api/ccr.forget_follower.js Normal file
View File

@ -0,0 +1,136 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildCcrForgetFollower (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError } = opts
/**
* Perform a [ccr.forget_follower](http://www.elastic.co/guide/en/elasticsearch/reference/current) request
*
* @param {string} index - the name of the leader index for which specified follower retention leases should be removed
* @param {object} body - the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index
*/
const acceptedQuerystring = [
]
const snakeCase = {
}
return function ccrForgetFollower (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// promises support
if (callback == null) {
return new Promise((resolve, reject) => {
ccrForgetFollower(params, options, (err, body) => {
err ? reject(err) : resolve(body)
})
})
}
// check required parameters
if (params['index'] == null) {
const err = new ConfigurationError('Missing required parameter: index')
return handleError(err, callback)
}
if (params['body'] == null) {
const err = new ConfigurationError('Missing required parameter: body')
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 = null
var { method, body, index } = params
var querystring = semicopy(params, ['method', 'body', 'index'])
if (method == null) {
method = 'POST'
}
var ignore = options.ignore || null
if (typeof ignore === 'number') {
ignore = [ignore]
}
var path = ''
path = '/' + encodeURIComponent(index) + '/' + '_ccr' + '/' + 'forget_follower'
// build request object
const request = {
method,
path,
body: body || '',
querystring
}
const requestOptions = {
ignore,
requestTimeout: options.requestTimeout || null,
maxRetries: options.maxRetries || null,
asStream: options.asStream || false,
headers: options.headers || null,
querystring: options.querystring || null,
compression: options.compression || false,
warnings
}
return makeRequest(request, requestOptions, callback)
function semicopy (obj, exclude) {
var target = {}
var keys = Object.keys(obj)
for (var i = 0, len = keys.length; i < len; i++) {
var key = keys[i]
if (exclude.indexOf(key) === -1) {
target[snakeCase[key] || key] = obj[key]
if (acceptedQuerystring.indexOf(snakeCase[key] || key) === -1) {
warnings = warnings || []
warnings.push('Client - Unknown parameter: "' + key + '", sending it as query parameter')
}
}
}
return target
}
}
}
module.exports = buildCcrForgetFollower

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

@ -29,6 +29,7 @@ function buildIndicesCreate (opts) {
* Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html) request
*
* @param {string} index - The name of the index
* @param {boolean} include_type_name - Whether a type should be expected in the body of the mappings.
* @param {string} wait_for_active_shards - Set the number of active shards to wait for before the operation returns.
* @param {time} timeout - Explicit operation timeout
* @param {time} master_timeout - Specify timeout for connection to master
@ -37,6 +38,7 @@ function buildIndicesCreate (opts) {
*/
const acceptedQuerystring = [
'include_type_name',
'wait_for_active_shards',
'timeout',
'master_timeout',
@ -49,6 +51,7 @@ function buildIndicesCreate (opts) {
]
const snakeCase = {
includeTypeName: 'include_type_name',
waitForActiveShards: 'wait_for_active_shards',
masterTimeout: 'master_timeout',
updateAllTypes: 'update_all_types',

3
api/api/indices.get.js
View File

@ -29,6 +29,7 @@ function buildIndicesGet (opts) {
* Perform a [indices.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html) request
*
* @param {list} index - A comma-separated list of index names
* @param {boolean} include_type_name - Whether to add the type name to the response (default: true)
* @param {boolean} local - Return local information, do not retrieve the state from master node (default: false)
* @param {boolean} ignore_unavailable - Ignore unavailable indexes (default: false)
* @param {boolean} allow_no_indices - Ignore if a wildcard expression resolves to no concrete indices (default: false)
@ -39,6 +40,7 @@ function buildIndicesGet (opts) {
*/
const acceptedQuerystring = [
'include_type_name',
'local',
'ignore_unavailable',
'allow_no_indices',
@ -54,6 +56,7 @@ function buildIndicesGet (opts) {
]
const snakeCase = {
includeTypeName: 'include_type_name',
ignoreUnavailable: 'ignore_unavailable',
allowNoIndices: 'allow_no_indices',
expandWildcards: 'expand_wildcards',

3
api/api/indices.get_field_mapping.js
View File

@ -31,6 +31,7 @@ function buildIndicesGetFieldMapping (opts) {
* @param {list} index - A comma-separated list of index names
* @param {list} type - A comma-separated list of document types
* @param {list} fields - A comma-separated list of fields
* @param {boolean} include_type_name - Whether a type should be returned in the body of the mappings.
* @param {boolean} include_defaults - Whether the default mapping values should be returned as well
* @param {boolean} ignore_unavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {boolean} allow_no_indices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@ -39,6 +40,7 @@ function buildIndicesGetFieldMapping (opts) {
*/
const acceptedQuerystring = [
'include_type_name',
'include_defaults',
'ignore_unavailable',
'allow_no_indices',
@ -52,6 +54,7 @@ function buildIndicesGetFieldMapping (opts) {
]
const snakeCase = {
includeTypeName: 'include_type_name',
includeDefaults: 'include_defaults',
ignoreUnavailable: 'ignore_unavailable',
allowNoIndices: 'allow_no_indices',

3
api/api/indices.get_mapping.js
View File

@ -30,6 +30,7 @@ function buildIndicesGetMapping (opts) {
*
* @param {list} index - A comma-separated list of index names
* @param {list} type - A comma-separated list of document types
* @param {boolean} include_type_name - Whether to add the type name to the response.
* @param {boolean} ignore_unavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {boolean} allow_no_indices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {enum} expand_wildcards - Whether to expand wildcard expression to concrete indices that are open, closed or both.
@ -38,6 +39,7 @@ function buildIndicesGetMapping (opts) {
*/
const acceptedQuerystring = [
'include_type_name',
'ignore_unavailable',
'allow_no_indices',
'expand_wildcards',
@ -51,6 +53,7 @@ function buildIndicesGetMapping (opts) {
]
const snakeCase = {
includeTypeName: 'include_type_name',
ignoreUnavailable: 'ignore_unavailable',
allowNoIndices: 'allow_no_indices',
expandWildcards: 'expand_wildcards',

3
api/api/indices.get_template.js
View File

@ -29,12 +29,14 @@ function buildIndicesGetTemplate (opts) {
* Perform a [indices.get_template](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
*
* @param {list} name - The comma separated names of the index templates
* @param {boolean} include_type_name - Whether a type should be returned in the body of the mappings.
* @param {boolean} flat_settings - Return settings in flat format (default: false)
* @param {time} master_timeout - Explicit operation timeout for connection to master node
* @param {boolean} local - Return local information, do not retrieve the state from master node (default: false)
*/
const acceptedQuerystring = [
'include_type_name',
'flat_settings',
'master_timeout',
'local',
@ -46,6 +48,7 @@ function buildIndicesGetTemplate (opts) {
]
const snakeCase = {
includeTypeName: 'include_type_name',
flatSettings: 'flat_settings',
masterTimeout: 'master_timeout',
errorTrace: 'error_trace',

13
api/api/indices.put_mapping.js
View File

@ -30,6 +30,7 @@ function buildIndicesPutMapping (opts) {
*
* @param {list} index - A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
* @param {string} type - The name of the document type
* @param {boolean} include_type_name - Whether a type should be expected in the body of the mappings.
* @param {time} timeout - Explicit operation timeout
* @param {time} master_timeout - Specify timeout for connection to master
* @param {boolean} ignore_unavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -40,6 +41,7 @@ function buildIndicesPutMapping (opts) {
*/
const acceptedQuerystring = [
'include_type_name',
'timeout',
'master_timeout',
'ignore_unavailable',
@ -54,6 +56,7 @@ function buildIndicesPutMapping (opts) {
]
const snakeCase = {
includeTypeName: 'include_type_name',
masterTimeout: 'master_timeout',
ignoreUnavailable: 'ignore_unavailable',
allowNoIndices: 'allow_no_indices',
@ -85,10 +88,6 @@ function buildIndicesPutMapping (opts) {
}
// check required parameters
if (params['type'] == null) {
const err = new ConfigurationError('Missing required parameter: type')
return handleError(err, callback)
}
if (params['body'] == null) {
const err = new ConfigurationError('Missing required parameter: body')
return handleError(err, callback)
@ -125,8 +124,12 @@ function buildIndicesPutMapping (opts) {
path = '/' + encodeURIComponent(index) + '/' + '_mappings' + '/' + encodeURIComponent(type)
} else if ((type) != null) {
path = '/' + '_mapping' + '/' + encodeURIComponent(type)
} else {
} else if ((type) != null) {
path = '/' + '_mappings' + '/' + encodeURIComponent(type)
} else if ((index) != null) {
path = '/' + encodeURIComponent(index) + '/' + '_mappings'
} else {
path = '/' + encodeURIComponent(index) + '/' + '_mapping'
}
// build request object

3
api/api/indices.put_template.js
View File

@ -29,6 +29,7 @@ function buildIndicesPutTemplate (opts) {
* Perform a [indices.put_template](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request
*
* @param {string} name - The name of the template
* @param {boolean} include_type_name - Whether a type should be returned in the body of the mappings.
* @param {number} order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
* @param {boolean} create - Whether the index template should only be added if new or can also replace an existing one
* @param {time} timeout - Explicit operation timeout
@ -38,6 +39,7 @@ function buildIndicesPutTemplate (opts) {
*/
const acceptedQuerystring = [
'include_type_name',
'order',
'create',
'timeout',
@ -51,6 +53,7 @@ function buildIndicesPutTemplate (opts) {
]
const snakeCase = {
includeTypeName: 'include_type_name',
masterTimeout: 'master_timeout',
flatSettings: 'flat_settings',
errorTrace: 'error_trace',

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

@ -30,6 +30,7 @@ function buildIndicesRollover (opts) {
*
* @param {string} alias - The name of the alias to rollover
* @param {string} new_index - The name of the rollover index
* @param {boolean} include_type_name - Whether a type should be included in the body of the mappings.
* @param {time} timeout - Explicit operation timeout
* @param {boolean} dry_run - If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
* @param {time} master_timeout - Specify timeout for connection to master
@ -38,6 +39,7 @@ function buildIndicesRollover (opts) {
*/
const acceptedQuerystring = [
'include_type_name',
'timeout',
'dry_run',
'master_timeout',
@ -50,6 +52,7 @@ function buildIndicesRollover (opts) {
]
const snakeCase = {
includeTypeName: 'include_type_name',
dryRun: 'dry_run',
masterTimeout: 'master_timeout',
waitForActiveShards: 'wait_for_active_shards',

3
api/api/search.js
View File

@ -65,6 +65,7 @@ function buildSearch (opts) {
* @param {boolean} allow_partial_search_results - Indicate if an error should be returned if there is a partial search failure or timeout
* @param {boolean} typed_keys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
* @param {boolean} version - Specify whether to return document version as part of a hit
* @param {boolean} seq_no_primary_term - Specify whether to return sequence number and primary term of the last modification of each hit
* @param {boolean} request_cache - Specify if request cache should be used for this request or not, defaults to index level setting
* @param {number} batched_reduce_size - The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
* @param {number} max_concurrent_shard_requests - The number of concurrent shard requests this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
@ -109,6 +110,7 @@ function buildSearch (opts) {
'allow_partial_search_results',
'typed_keys',
'version',
'seq_no_primary_term',
'request_cache',
'batched_reduce_size',
'max_concurrent_shard_requests',
@ -142,6 +144,7 @@ function buildSearch (opts) {
trackTotalHits: 'track_total_hits',
allowPartialSearchResults: 'allow_partial_search_results',
typedKeys: 'typed_keys',
seqNoPrimaryTerm: 'seq_no_primary_term',
requestCache: 'request_cache',
batchedReduceSize: 'batched_reduce_size',
maxConcurrentShardRequests: 'max_concurrent_shard_requests',

132
api/api/security.create_api_key.js Normal file
View File

@ -0,0 +1,132 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildSecurityCreateApiKey (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError } = opts
/**
* Perform a [security.create_api_key](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html) request
*
* @param {enum} refresh - If `true` (the default) then refresh the affected 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` then do nothing with refreshes.
* @param {object} body - The api key request to create an API key
*/
const acceptedQuerystring = [
'refresh'
]
const snakeCase = {
}
return function securityCreateApiKey (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// promises support
if (callback == null) {
return new Promise((resolve, reject) => {
securityCreateApiKey(params, options, (err, body) => {
err ? reject(err) : resolve(body)
})
})
}
// check required parameters
if (params['body'] == null) {
const err = new ConfigurationError('Missing required parameter: body')
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 = null
var { method, body } = params
var querystring = semicopy(params, ['method', 'body'])
if (method == null) {
method = 'PUT'
}
var ignore = options.ignore || null
if (typeof ignore === 'number') {
ignore = [ignore]
}
var path = ''
path = '/' + '_security' + '/' + 'api_key'
// build request object
const request = {
method,
path,
body: body || '',
querystring
}
const requestOptions = {
ignore,
requestTimeout: options.requestTimeout || null,
maxRetries: options.maxRetries || null,
asStream: options.asStream || false,
headers: options.headers || null,
querystring: options.querystring || null,
compression: options.compression || false,
warnings
}
return makeRequest(request, requestOptions, callback)
function semicopy (obj, exclude) {
var target = {}
var keys = Object.keys(obj)
for (var i = 0, len = keys.length; i < len; i++) {
var key = keys[i]
if (exclude.indexOf(key) === -1) {
target[snakeCase[key] || key] = obj[key]
if (acceptedQuerystring.indexOf(snakeCase[key] || key) === -1) {
warnings = warnings || []
warnings.push('Client - Unknown parameter: "' + key + '", sending it as query parameter')
}
}
}
return target
}
}
}
module.exports = buildSecurityCreateApiKey

137
api/api/security.get_api_key.js Normal file
View File

@ -0,0 +1,137 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildSecurityGetApiKey (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError } = opts
/**
* Perform a [security.get_api_key](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html) request
*
* @param {string} id - API key id of the API key to be retrieved
* @param {string} name - API key name of the API key to be retrieved
* @param {string} username - user name of the user who created this API key to be retrieved
* @param {string} realm_name - realm name of the user who created this API key to be retrieved
*/
const acceptedQuerystring = [
'id',
'name',
'username',
'realm_name'
]
const snakeCase = {
realmName: 'realm_name'
}
return function securityGetApiKey (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// promises support
if (callback == null) {
return new Promise((resolve, reject) => {
securityGetApiKey(params, options, (err, body) => {
err ? reject(err) : resolve(body)
})
})
}
// check required parameters
if (params.body != null) {
const err = new ConfigurationError('This API does not require a body')
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 = null
var { method, body } = params
var querystring = semicopy(params, ['method', 'body'])
if (method == null) {
method = 'GET'
}
var ignore = options.ignore || null
if (typeof ignore === 'number') {
ignore = [ignore]
}
var path = ''
path = '/' + '_security' + '/' + 'api_key'
// build request object
const request = {
method,
path,
body: null,
querystring
}
const requestOptions = {
ignore,
requestTimeout: options.requestTimeout || null,
maxRetries: options.maxRetries || null,
asStream: options.asStream || false,
headers: options.headers || null,
querystring: options.querystring || null,
compression: options.compression || false,
warnings
}
return makeRequest(request, requestOptions, callback)
function semicopy (obj, exclude) {
var target = {}
var keys = Object.keys(obj)
for (var i = 0, len = keys.length; i < len; i++) {
var key = keys[i]
if (exclude.indexOf(key) === -1) {
target[snakeCase[key] || key] = obj[key]
if (acceptedQuerystring.indexOf(snakeCase[key] || key) === -1) {
warnings = warnings || []
warnings.push('Client - Unknown parameter: "' + key + '", sending it as query parameter')
}
}
}
return target
}
}
}
module.exports = buildSecurityGetApiKey

131
api/api/security.invalidate_api_key.js Normal file
View File

@ -0,0 +1,131 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildSecurityInvalidateApiKey (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError } = opts
/**
* Perform a [security.invalidate_api_key](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html) request
*
* @param {object} body - The api key request to invalidate API key(s)
*/
const acceptedQuerystring = [
]
const snakeCase = {
}
return function securityInvalidateApiKey (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// promises support
if (callback == null) {
return new Promise((resolve, reject) => {
securityInvalidateApiKey(params, options, (err, body) => {
err ? reject(err) : resolve(body)
})
})
}
// check required parameters
if (params['body'] == null) {
const err = new ConfigurationError('Missing required parameter: body')
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 = null
var { method, body } = params
var querystring = semicopy(params, ['method', 'body'])
if (method == null) {
method = 'DELETE'
}
var ignore = options.ignore || null
if (typeof ignore === 'number') {
ignore = [ignore]
}
var path = ''
path = '/' + '_security' + '/' + 'api_key'
// build request object
const request = {
method,
path,
body: body || '',
querystring
}
const requestOptions = {
ignore,
requestTimeout: options.requestTimeout || null,
maxRetries: options.maxRetries || null,
asStream: options.asStream || false,
headers: options.headers || null,
querystring: options.querystring || null,
compression: options.compression || false,
warnings
}
return makeRequest(request, requestOptions, callback)
function semicopy (obj, exclude) {
var target = {}
var keys = Object.keys(obj)
for (var i = 0, len = keys.length; i < len; i++) {
var key = keys[i]
if (exclude.indexOf(key) === -1) {
target[snakeCase[key] || key] = obj[key]
if (acceptedQuerystring.indexOf(snakeCase[key] || key) === -1) {
warnings = warnings || []
warnings.push('Client - Unknown parameter: "' + key + '", sending it as query parameter')
}
}
}
return target
}
}
}
module.exports = buildSecurityInvalidateApiKey

6
api/api/update.js
View File

@ -42,6 +42,8 @@ function buildUpdate (opts) {
* @param {number} retry_on_conflict - Specify how many times should the operation be retried when a conflict occurs (default: 0)
* @param {string} routing - Specific routing value
* @param {time} timeout - Explicit operation timeout
* @param {number} if_seq_no - only perform the update operation if the last operation that has changed the document has the specified sequence number
* @param {number} if_primary_term - only perform the update operation if the last operation that has changed the document has the specified primary term
* @param {number} version - Explicit version number for concurrency control
* @param {enum} version_type - Specific version type
* @param {object} body - The request definition requires either `script` or partial `doc`
@ -59,6 +61,8 @@ function buildUpdate (opts) {
'retry_on_conflict',
'routing',
'timeout',
'if_seq_no',
'if_primary_term',
'version',
'version_type',
'pretty',
@ -73,6 +77,8 @@ function buildUpdate (opts) {
_sourceExcludes: '_source_excludes',
_sourceIncludes: '_source_includes',
retryOnConflict: 'retry_on_conflict',
ifSeqNo: 'if_seq_no',
ifPrimaryTerm: 'if_primary_term',
versionType: 'version_type',
errorTrace: 'error_trace',
filterPath: 'filter_path'

1
api/api/xpack.ml.close_job.js
View File

@ -32,6 +32,7 @@ function buildXpackMlCloseJob (opts) {
* @param {boolean} allow_no_jobs - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
* @param {boolean} force - True if the job should be forcefully closed
* @param {time} timeout - Controls the time to wait until a job has closed. Default to 30 minutes
* @param {object} body - The URL params optionally sent in the body
*/
const acceptedQuerystring = [

133
api/api/xpack.ml.set_upgrade_mode.js Normal file
View File

@ -0,0 +1,133 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
'use strict'
/* eslint camelcase: 0 */
/* eslint no-unused-vars: 0 */
function buildXpackMlSetUpgradeMode (opts) {
// eslint-disable-next-line no-unused-vars
const { makeRequest, ConfigurationError, handleError } = opts
/**
* Perform a [xpack.ml.set_upgrade_mode](http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html) request
*
* @param {boolean} enabled - Whether to enable upgrade_mode ML setting or not. Defaults to false.
* @param {time} timeout - Controls the time to wait before action times out. Defaults to 30 seconds
*/
const acceptedQuerystring = [
'enabled',
'timeout'
]
const snakeCase = {
}
return function xpackMlSetUpgradeMode (params, options, callback) {
options = options || {}
if (typeof options === 'function') {
callback = options
options = {}
}
if (typeof params === 'function' || params == null) {
callback = params
params = {}
options = {}
}
// promises support
if (callback == null) {
return new Promise((resolve, reject) => {
xpackMlSetUpgradeMode(params, options, (err, body) => {
err ? reject(err) : resolve(body)
})
})
}
// check required parameters
if (params.body != null) {
const err = new ConfigurationError('This API does not require a body')
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 = null
var { method, body } = params
var querystring = semicopy(params, ['method', 'body'])
if (method == null) {
method = 'POST'
}
var ignore = options.ignore || null
if (typeof ignore === 'number') {
ignore = [ignore]
}
var path = ''
path = '/' + '_xpack' + '/' + 'ml' + '/' + 'set_upgrade_mode'
// build request object
const request = {
method,
path,
body: '',
querystring
}
const requestOptions = {
ignore,
requestTimeout: options.requestTimeout || null,
maxRetries: options.maxRetries || null,
asStream: options.asStream || false,
headers: options.headers || null,
querystring: options.querystring || null,
compression: options.compression || false,
warnings
}
return makeRequest(request, requestOptions, callback)
function semicopy (obj, exclude) {
var target = {}
var keys = Object.keys(obj)
for (var i = 0, len = keys.length; i < len; i++) {
var key = keys[i]
if (exclude.indexOf(key) === -1) {
target[snakeCase[key] || key] = obj[key]
if (acceptedQuerystring.indexOf(snakeCase[key] || key) === -1) {
warnings = warnings || []
warnings.push('Client - Unknown parameter: "' + key + '", sending it as query parameter')
}
}
}
return target
}
}
}
module.exports = buildXpackMlSetUpgradeMode

4
api/api/xpack.security.disable_user.js
View File

@ -62,6 +62,10 @@ function buildXpackSecurityDisableUser (opts) {
}
// check required parameters
if (params['username'] == null) {
const err = new ConfigurationError('Missing required parameter: username')
return handleError(err, callback)
}
if (params.body != null) {
const err = new ConfigurationError('This API does not require a body')
return handleError(err, callback)

4
api/api/xpack.security.enable_user.js
View File

@ -62,6 +62,10 @@ function buildXpackSecurityEnableUser (opts) {
}
// check required parameters
if (params['username'] == null) {
const err = new ConfigurationError('Missing required parameter: username')
return handleError(err, callback)
}
if (params.body != null) {
const err = new ConfigurationError('This API does not require a body')
return handleError(err, callback)

4
api/api/xpack.security.get_privileges.js
View File

@ -94,9 +94,9 @@ function buildXpackSecurityGetPrivileges (opts) {
var path = ''
if (application && name) {
if ((application) != null && (name) != null) {
path = '/' + '_xpack' + '/' + 'security' + '/' + 'privilege' + '/' + encodeURIComponent(application) + '/' + encodeURIComponent(name)
} else if (application) {
} else if ((application) != null) {
path = '/' + '_xpack' + '/' + 'security' + '/' + 'privilege' + '/' + encodeURIComponent(application)
} else {
path = '/' + '_xpack' + '/' + 'security' + '/' + 'privilege'

11
api/api/xpack.watcher.put_watch.js
View File

@ -32,18 +32,23 @@ function buildXpackWatcherPutWatch (opts) {
* @param {time} master_timeout - Explicit operation timeout for connection to master node
* @param {boolean} active - Specify whether the watch is in/active by default
* @param {number} version - Explicit version number for concurrency control
* @param {number} if_seq_no - only update the watch if the last operation that has changed the watch has the specified sequence number
* @param {number} if_primary_term - only update the watch if the last operation that has changed the watch has the specified primary term
* @param {object} body - The watch
*/
const acceptedQuerystring = [
'master_timeout',
'active',
'version'
'version',
'if_seq_no',
'if_primary_term'
]
const snakeCase = {
masterTimeout: 'master_timeout'
masterTimeout: 'master_timeout',
ifSeqNo: 'if_seq_no',
ifPrimaryTerm: 'if_primary_term'
}
return function xpackWatcherPutWatch (params, options, callback) {

14
api/index.js
View File

@ -59,8 +59,12 @@ function ESAPI (opts) {
delete_auto_follow_pattern: lazyLoad('ccr.delete_auto_follow_pattern', opts),
deleteAutoFollowPattern: lazyLoad('ccr.delete_auto_follow_pattern', opts),
follow: lazyLoad('ccr.follow', opts),
follow_info: lazyLoad('ccr.follow_info', opts),
followInfo: lazyLoad('ccr.follow_info', opts),
follow_stats: lazyLoad('ccr.follow_stats', opts),
followStats: lazyLoad('ccr.follow_stats', opts),
forget_follower: lazyLoad('ccr.forget_follower', opts),
forgetFollower: lazyLoad('ccr.forget_follower', opts),
get_auto_follow_pattern: lazyLoad('ccr.get_auto_follow_pattern', opts),
getAutoFollowPattern: lazyLoad('ccr.get_auto_follow_pattern', opts),
pause_follow: lazyLoad('ccr.pause_follow', opts),
@ -235,6 +239,14 @@ function ESAPI (opts) {
searchShards: lazyLoad('search_shards', opts),
search_template: lazyLoad('search_template', opts),
searchTemplate: lazyLoad('search_template', opts),
security: {
create_api_key: lazyLoad('security.create_api_key', opts),
createApiKey: lazyLoad('security.create_api_key', opts),
get_api_key: lazyLoad('security.get_api_key', opts),
getApiKey: lazyLoad('security.get_api_key', opts),
invalidate_api_key: lazyLoad('security.invalidate_api_key', opts),
invalidateApiKey: lazyLoad('security.invalidate_api_key', opts)
},
snapshot: {
create: lazyLoad('snapshot.create', opts),
create_repository: lazyLoad('snapshot.create_repository', opts),
@ -358,6 +370,8 @@ function ESAPI (opts) {
putJob: lazyLoad('xpack.ml.put_job', opts),
revert_model_snapshot: lazyLoad('xpack.ml.revert_model_snapshot', opts),
revertModelSnapshot: lazyLoad('xpack.ml.revert_model_snapshot', opts),
set_upgrade_mode: lazyLoad('xpack.ml.set_upgrade_mode', opts),
setUpgradeMode: lazyLoad('xpack.ml.set_upgrade_mode', opts),
start_datafeed: lazyLoad('xpack.ml.start_datafeed', opts),
startDatafeed: lazyLoad('xpack.ml.start_datafeed', opts),
stop_datafeed: lazyLoad('xpack.ml.stop_datafeed', opts),

51
api/requestParams.d.ts vendored
View File

@ -582,6 +582,7 @@ export interface IndicesClose extends Generic {
export interface IndicesCreate extends Generic {
index: string;
include_type_name?: boolean;
wait_for_active_shards?: string;
timeout?: string;
master_timeout?: string;
@ -674,6 +675,7 @@ export interface IndicesForcemerge extends Generic {
export interface IndicesGet extends Generic {
index: string | string[];
include_type_name?: boolean;
local?: boolean;
ignore_unavailable?: boolean;
allow_no_indices?: boolean;
@ -696,6 +698,7 @@ export interface IndicesGetFieldMapping extends Generic {
index?: string | string[];
type?: string | string[];
fields: string | string[];
include_type_name?: boolean;
include_defaults?: boolean;
ignore_unavailable?: boolean;
allow_no_indices?: boolean;
@ -706,6 +709,7 @@ export interface IndicesGetFieldMapping extends Generic {
export interface IndicesGetMapping extends Generic {
index?: string | string[];
type?: string | string[];
include_type_name?: boolean;
ignore_unavailable?: boolean;
allow_no_indices?: boolean;
expand_wildcards?: 'open' | 'closed' | 'none' | 'all';
@ -727,6 +731,7 @@ export interface IndicesGetSettings extends Generic {
export interface IndicesGetTemplate extends Generic {
name?: string | string[];
include_type_name?: boolean;
flat_settings?: boolean;
master_timeout?: string;
local?: boolean;
@ -759,7 +764,8 @@ export interface IndicesPutAlias extends Generic {
export interface IndicesPutMapping extends Generic {
index?: string | string[];
type: string;
type?: string;
include_type_name?: boolean;
timeout?: string;
master_timeout?: string;
ignore_unavailable?: boolean;
@ -783,6 +789,7 @@ export interface IndicesPutSettings extends Generic {
export interface IndicesPutTemplate extends Generic {
name: string;
include_type_name?: boolean;
order?: number;
create?: boolean;
timeout?: string;
@ -807,6 +814,7 @@ export interface IndicesRefresh extends Generic {
export interface IndicesRollover extends Generic {
alias: string;
new_index?: string;
include_type_name?: boolean;
timeout?: string;
dry_run?: boolean;
master_timeout?: string;
@ -1110,6 +1118,7 @@ export interface Search extends Generic {
allow_partial_search_results?: boolean;
typed_keys?: boolean;
version?: boolean;
seq_no_primary_term?: boolean;
request_cache?: boolean;
batched_reduce_size?: number;
max_concurrent_shard_requests?: number;
@ -1266,6 +1275,8 @@ export interface Update extends Generic {
retry_on_conflict?: number;
routing?: string;
timeout?: string;
if_seq_no?: number;
if_primary_term?: number;
version?: number;
version_type?: 'internal' | 'force';
body: any;
@ -1322,13 +1333,23 @@ export interface CcrDeleteAutoFollowPattern extends Generic {
export interface CcrFollow extends Generic {
index: string;
wait_for_active_shards?: string;
body: any;
}
export interface CcrFollowInfo extends Generic {
index?: string | string[];
}
export interface CcrFollowStats extends Generic {
index?: string | string[];
}
export interface CcrForgetFollower extends Generic {
index: string;
body: any;
}
export interface CcrGetAutoFollowPattern extends Generic {
name?: string;
}
@ -1414,6 +1435,22 @@ export interface IndicesUnfreeze extends Generic {
wait_for_active_shards?: string;
}
export interface SecurityCreateApiKey extends Generic {
refresh?: 'true' | 'false' | 'wait_for';
body: any;
}
export interface SecurityGetApiKey extends Generic {
id?: string;
name?: string;
username?: string;
realm_name?: string;
}
export interface SecurityInvalidateApiKey extends Generic {
body: any;
}
export interface XpackGraphExplore extends Generic {
index?: string | string[];
type?: string | string[];
@ -1474,6 +1511,7 @@ export interface XpackMlCloseJob extends Generic {
allow_no_jobs?: boolean;
force?: boolean;
timeout?: string;
body?: any;
}
export interface XpackMlDeleteCalendar extends Generic {
@ -1724,6 +1762,11 @@ export interface XpackMlRevertModelSnapshot extends Generic {
body?: any;
}
export interface XpackMlSetUpgradeMode extends Generic {
enabled?: boolean;
timeout?: string;
}
export interface XpackMlStartDatafeed extends Generic {
datafeed_id: string;
start?: string;
@ -1854,12 +1897,12 @@ export interface XpackSecurityDeleteUser extends Generic {
}
export interface XpackSecurityDisableUser extends Generic {
username?: string;
username: string;
refresh?: 'true' | 'false' | 'wait_for';
}
export interface XpackSecurityEnableUser extends Generic {
username?: string;
username: string;
refresh?: 'true' | 'false' | 'wait_for';
}
@ -1975,6 +2018,8 @@ export interface XpackWatcherPutWatch extends Generic {
master_timeout?: string;
active?: boolean;
version?: number;
if_seq_no?: number;
if_primary_term?: number;
body?: any;
}

142
docs/reference.asciidoc
View File

@ -1773,6 +1773,9 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-ind
|`index`
|`string` - The name of the index
|`include_type_name` or `includeTypeName`
|`boolean` - Whether a type should be expected in the body of the mappings.
|`wait_for_active_shards` or `waitForActiveShards`
|`string` - Set the number of active shards to wait for before the operation returns.
@ -2067,6 +2070,9 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.
|`index`
|`string, string[]` - A comma-separated list of index names
|`include_type_name` or `includeTypeName`
|`boolean` - Whether to add the type name to the response (default: true)
|`local`
|`boolean` - Return local information, do not retrieve the state from master node (default: false)
@ -2137,6 +2143,9 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-
|`fields`
|`string, string[]` - A comma-separated list of fields
|`include_type_name` or `includeTypeName`
|`boolean` - Whether a type should be returned in the body of the mappings.
|`include_defaults` or `includeDefaults`
|`boolean` - Whether the default mapping values should be returned as well
@ -2169,6 +2178,9 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mappin
|`type`
|`string, string[]` - A comma-separated list of document types
|`include_type_name` or `includeTypeName`
|`boolean` - Whether to add the type name to the response.
|`ignore_unavailable` or `ignoreUnavailable`
|`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -2236,6 +2248,9 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.
|`name`
|`string, string[]` - The comma separated names of the index templates
|`include_type_name` or `includeTypeName`
|`boolean` - Whether a type should be returned in the body of the mappings.
|`flat_settings` or `flatSettings`
|`boolean` - Return settings in flat format (default: false)
@ -2341,6 +2356,9 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mappin
|`type`
|`string` - The name of the document type
|`include_type_name` or `includeTypeName`
|`boolean` - Whether a type should be expected in the body of the mappings.
|`timeout`
|`string` - Explicit operation timeout
@ -2414,6 +2432,9 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.
|`name`
|`string` - The name of the template
|`include_type_name` or `includeTypeName`
|`boolean` - Whether a type should be returned in the body of the mappings.
|`order`
|`number` - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
@ -2490,6 +2511,9 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-i
|`new_index` or `newIndex`
|`string` - The name of the rollover index
|`include_type_name` or `includeTypeName`
|`boolean` - Whether a type should be included in the body of the mappings.
|`timeout`
|`string` - Explicit operation timeout
@ -3452,6 +3476,9 @@ _Default:_ `true`
|`version`
|`boolean` - Specify whether to return document version as part of a hit
|`seq_no_primary_term` or `seqNoPrimaryTerm`
|`boolean` - Specify whether to return sequence number and primary term of the last modification of each hit
|`request_cache` or `requestCache`
|`boolean` - Specify if request cache should be used for this request or not, defaults to index level setting
@ -3946,6 +3973,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html
|`timeout`
|`string` - Explicit operation timeout
|`if_seq_no` or `ifSeqNo`
|`number` - only perform the update operation if the last operation that has changed the document has the specified sequence number
|`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
|`version`
|`number` - Explicit version number for concurrency control
@ -4124,11 +4157,28 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.h
|`index`
|`string` - The name of the follower index
|`wait_for_active_shards` or `waitForActiveShards`
|`string` - Sets the number of shard copies that must be active before returning. Defaults to 0. 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) +
_Default:_ `0`
|`body`
|`object` - The name of the leader index and other optional ccr related parameters
|===
=== ccr.followInfo
[source,js]
----
client.ccr.followInfo([params] [, options] [, callback])
----
https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html
[cols=2*]
|===
|`index`
|`string, string[]` - A comma-separated list of index patterns; use `_all` to perform the operation on all indices
|===
=== ccr.followStats
[source,js]
----
@ -4142,6 +4192,22 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-s
|===
=== ccr.forgetFollower
[source,js]
----
client.ccr.forgetFollower([params] [, options] [, callback])
----
http://www.elastic.co/guide/en/elasticsearch/reference/current
[cols=2*]
|===
|`index`
|`string` - the name of the leader index for which specified follower retention leases should be removed
|`body`
|`object` - the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index
|===
=== ccr.getAutoFollowPattern
[source,js]
----
@ -4410,6 +4476,57 @@ _Default:_ `closed`
|===
=== security.createApiKey
[source,js]
----
client.security.createApiKey([params] [, options] [, callback])
----
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
[cols=2*]
|===
|`refresh`
|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected 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` then do nothing with refreshes.
|`body`
|`object` - The api key request to create an API key
|===
=== security.getApiKey
[source,js]
----
client.security.getApiKey([params] [, options] [, callback])
----
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html
[cols=2*]
|===
|`id`
|`string` - API key id of the API key to be retrieved
|`name`
|`string` - API key name of the API key to be retrieved
|`username`
|`string` - user name of the user who created this API key to be retrieved
|`realm_name` or `realmName`
|`string` - realm name of the user who created this API key to be retrieved
|===
=== security.invalidateApiKey
[source,js]
----
client.security.invalidateApiKey([params] [, options] [, callback])
----
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html
[cols=2*]
|===
|`body`
|`object` - The api key request to invalidate API key(s)
|===
=== xpack.graph.explore
[source,js]
----
@ -4603,6 +4720,9 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html
|`timeout`
|`string` - Controls the time to wait until a job has closed. Default to 30 minutes
|`body`
|`object` - The URL params optionally sent in the body
|===
=== xpack.ml.deleteCalendar
@ -5384,6 +5504,22 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapsho
|===
=== xpack.ml.setUpgradeMode
[source,js]
----
client.xpack.ml.setUpgradeMode([params] [, options] [, callback])
----
http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html
[cols=2*]
|===
|`enabled`
|`boolean` - Whether to enable upgrade_mode ML setting or not. Defaults to false.
|`timeout`
|`string` - Controls the time to wait before action times out. Defaults to 30 seconds
|===
=== xpack.ml.startDatafeed
[source,js]
----
@ -6186,6 +6322,12 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-w
|`version`
|`number` - Explicit version number for concurrency control
|`if_seq_no` or `ifSeqNo`
|`number` - only update the watch if the last operation that has changed the watch has the specified sequence number
|`if_primary_term` or `ifPrimaryTerm`
|`number` - only update the watch if the last operation that has changed the watch has the specified primary term
|`body`
|`object` - The watch

14
index.d.ts vendored
View File

@ -130,8 +130,12 @@ declare class Client extends EventEmitter {
delete_auto_follow_pattern: ApiMethod<RequestParams.CcrDeleteAutoFollowPattern>
deleteAutoFollowPattern: ApiMethod<RequestParams.CcrDeleteAutoFollowPattern>
follow: ApiMethod<RequestParams.CcrFollow>
follow_info: ApiMethod<RequestParams.CcrFollowInfo>
followInfo: ApiMethod<RequestParams.CcrFollowInfo>
follow_stats: ApiMethod<RequestParams.CcrFollowStats>
followStats: ApiMethod<RequestParams.CcrFollowStats>
forget_follower: ApiMethod<RequestParams.CcrForgetFollower>
forgetFollower: ApiMethod<RequestParams.CcrForgetFollower>
get_auto_follow_pattern: ApiMethod<RequestParams.CcrGetAutoFollowPattern>
getAutoFollowPattern: ApiMethod<RequestParams.CcrGetAutoFollowPattern>
pause_follow: ApiMethod<RequestParams.CcrPauseFollow>
@ -306,6 +310,14 @@ declare class Client extends EventEmitter {
searchShards: ApiMethod<RequestParams.SearchShards>
search_template: ApiMethod<RequestParams.SearchTemplate>
searchTemplate: ApiMethod<RequestParams.SearchTemplate>
security: {
create_api_key: ApiMethod<RequestParams.SecurityCreateApiKey>
createApiKey: ApiMethod<RequestParams.SecurityCreateApiKey>
get_api_key: ApiMethod<RequestParams.SecurityGetApiKey>
getApiKey: ApiMethod<RequestParams.SecurityGetApiKey>
invalidate_api_key: ApiMethod<RequestParams.SecurityInvalidateApiKey>
invalidateApiKey: ApiMethod<RequestParams.SecurityInvalidateApiKey>
}
snapshot: {
create: ApiMethod<RequestParams.SnapshotCreate>
create_repository: ApiMethod<RequestParams.SnapshotCreateRepository>
@ -429,6 +441,8 @@ declare class Client extends EventEmitter {
putJob: ApiMethod<RequestParams.XpackMlPutJob>
revert_model_snapshot: ApiMethod<RequestParams.XpackMlRevertModelSnapshot>
revertModelSnapshot: ApiMethod<RequestParams.XpackMlRevertModelSnapshot>
set_upgrade_mode: ApiMethod<RequestParams.XpackMlSetUpgradeMode>
setUpgradeMode: ApiMethod<RequestParams.XpackMlSetUpgradeMode>
start_datafeed: ApiMethod<RequestParams.XpackMlStartDatafeed>
startDatafeed: ApiMethod<RequestParams.XpackMlStartDatafeed>
stop_datafeed: ApiMethod<RequestParams.XpackMlStopDatafeed>