diff --git a/api/api/async_search.delete.js b/api/api/async_search.delete.js index 74b0e8ffe..909f3a230 100644 --- a/api/api/async_search.delete.js +++ b/api/api/async_search.delete.js @@ -21,6 +21,7 @@ function buildAsyncSearchDelete (opts) { /** * Perform a async_search.delete request + * Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. * https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html */ return function asyncSearchDelete (params, options, callback) { diff --git a/api/api/async_search.get.js b/api/api/async_search.get.js index 87fa60cf9..e512e5ce3 100644 --- a/api/api/async_search.get.js +++ b/api/api/async_search.get.js @@ -25,6 +25,7 @@ function buildAsyncSearchGet (opts) { /** * Perform a async_search.get request + * Retrieves the results of a previously submitted async search request given its ID. * https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html */ return function asyncSearchGet (params, options, callback) { diff --git a/api/api/async_search.submit.js b/api/api/async_search.submit.js index 8ff473d18..e46a1785f 100644 --- a/api/api/async_search.submit.js +++ b/api/api/async_search.submit.js @@ -91,6 +91,7 @@ function buildAsyncSearchSubmit (opts) { /** * Perform a async_search.submit request + * Executes a search request asynchronously. * https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html */ return function asyncSearchSubmit (params, options, callback) { diff --git a/api/api/autoscaling.get_autoscaling_decision.js b/api/api/autoscaling.get_autoscaling_decision.js index cf4530c1a..9bd7388a7 100644 --- a/api/api/autoscaling.get_autoscaling_decision.js +++ b/api/api/autoscaling.get_autoscaling_decision.js @@ -21,6 +21,7 @@ function buildAutoscalingGetAutoscalingDecision (opts) { /** * Perform a autoscaling.get_autoscaling_decision request + * Gets the current autoscaling decision based on the configured autoscaling policy, indicating whether or not autoscaling is needed. * https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-decision.html */ return function autoscalingGetAutoscalingDecision (params, options, callback) { diff --git a/api/api/autoscaling.put_autoscaling_policy.js b/api/api/autoscaling.put_autoscaling_policy.js new file mode 100644 index 000000000..b7751339e --- /dev/null +++ b/api/api/autoscaling.put_autoscaling_policy.js @@ -0,0 +1,81 @@ +// 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 buildAutoscalingPutAutoscalingPolicy (opts) { + // eslint-disable-next-line no-unused-vars + const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts + + const acceptedQuerystring = [ + + ] + + const snakeCase = { + + } + + /** + * Perform a autoscaling.put_autoscaling_policy request + * https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html + */ + return function autoscalingPutAutoscalingPolicy (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) + } + 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 = [] + 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 = 'PUT' + path = '/' + '_autoscaling' + '/' + 'policy' + '/' + 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 = buildAutoscalingPutAutoscalingPolicy diff --git a/api/api/cat.ml_data_frame_analytics.js b/api/api/cat.ml_data_frame_analytics.js index 74fff5ffb..18b071636 100644 --- a/api/api/cat.ml_data_frame_analytics.js +++ b/api/api/cat.ml_data_frame_analytics.js @@ -29,6 +29,7 @@ function buildCatMlDataFrameAnalytics (opts) { /** * Perform a cat.ml_data_frame_analytics request + * Gets configuration and usage information about data frame analytics jobs. * http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html */ return function catMlDataFrameAnalytics (params, options, callback) { diff --git a/api/api/cat.ml_datafeeds.js b/api/api/cat.ml_datafeeds.js index 879a9c9db..988d0b094 100644 --- a/api/api/cat.ml_datafeeds.js +++ b/api/api/cat.ml_datafeeds.js @@ -28,6 +28,7 @@ function buildCatMlDatafeeds (opts) { /** * Perform a cat.ml_datafeeds request + * Gets configuration and usage information about datafeeds. * http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html */ return function catMlDatafeeds (params, options, callback) { diff --git a/api/api/cat.ml_jobs.js b/api/api/cat.ml_jobs.js index 26badad5d..2311c796b 100644 --- a/api/api/cat.ml_jobs.js +++ b/api/api/cat.ml_jobs.js @@ -29,6 +29,7 @@ function buildCatMlJobs (opts) { /** * Perform a cat.ml_jobs request + * Gets configuration and usage information about anomaly detection jobs. * http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html */ return function catMlJobs (params, options, callback) { diff --git a/api/api/cat.ml_trained_models.js b/api/api/cat.ml_trained_models.js index df66dfa32..4249d5f19 100644 --- a/api/api/cat.ml_trained_models.js +++ b/api/api/cat.ml_trained_models.js @@ -31,6 +31,7 @@ function buildCatMlTrainedModels (opts) { /** * Perform a cat.ml_trained_models request + * Gets configuration and usage information about inference trained models. * https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html */ return function catMlTrainedModels (params, options, callback) { diff --git a/api/api/cat.transform.js b/api/api/cat.transform.js index a650e49b8..35c7e93cd 100644 --- a/api/api/cat.transform.js +++ b/api/api/cat.transform.js @@ -30,6 +30,7 @@ function buildCatTransform (opts) { /** * Perform a cat.transform request + * Gets configuration and usage information about transforms. * https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html */ return function catTransform (params, options, callback) { diff --git a/api/api/ccr.delete_auto_follow_pattern.js b/api/api/ccr.delete_auto_follow_pattern.js index a154118ca..df97e2bbb 100644 --- a/api/api/ccr.delete_auto_follow_pattern.js +++ b/api/api/ccr.delete_auto_follow_pattern.js @@ -21,6 +21,7 @@ function buildCcrDeleteAutoFollowPattern (opts) { /** * Perform a ccr.delete_auto_follow_pattern request + * Deletes auto-follow patterns. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html */ return function ccrDeleteAutoFollowPattern (params, options, callback) { diff --git a/api/api/ccr.follow.js b/api/api/ccr.follow.js index ba81e133d..a193fe80c 100644 --- a/api/api/ccr.follow.js +++ b/api/api/ccr.follow.js @@ -21,6 +21,7 @@ function buildCcrFollow (opts) { /** * Perform a ccr.follow request + * Creates a new follower index configured to follow the referenced leader index. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html */ return function ccrFollow (params, options, callback) { diff --git a/api/api/ccr.follow_info.js b/api/api/ccr.follow_info.js index 4e9bec55d..d0c0c329a 100644 --- a/api/api/ccr.follow_info.js +++ b/api/api/ccr.follow_info.js @@ -21,6 +21,7 @@ function buildCcrFollowInfo (opts) { /** * Perform a ccr.follow_info request + * Retrieves information about all follower indices, including parameters and status for each follower index * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html */ return function ccrFollowInfo (params, options, callback) { diff --git a/api/api/ccr.follow_stats.js b/api/api/ccr.follow_stats.js index efc0727fd..1a66b8645 100644 --- a/api/api/ccr.follow_stats.js +++ b/api/api/ccr.follow_stats.js @@ -21,6 +21,7 @@ function buildCcrFollowStats (opts) { /** * Perform a ccr.follow_stats request + * Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html */ return function ccrFollowStats (params, options, callback) { diff --git a/api/api/ccr.forget_follower.js b/api/api/ccr.forget_follower.js index a1345978f..b340ef9d2 100644 --- a/api/api/ccr.forget_follower.js +++ b/api/api/ccr.forget_follower.js @@ -21,6 +21,7 @@ function buildCcrForgetFollower (opts) { /** * Perform a ccr.forget_follower request + * Removes the follower retention leases from the leader. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html */ return function ccrForgetFollower (params, options, callback) { diff --git a/api/api/ccr.get_auto_follow_pattern.js b/api/api/ccr.get_auto_follow_pattern.js index 2470e23c1..fbc05aaba 100644 --- a/api/api/ccr.get_auto_follow_pattern.js +++ b/api/api/ccr.get_auto_follow_pattern.js @@ -21,6 +21,7 @@ function buildCcrGetAutoFollowPattern (opts) { /** * Perform a ccr.get_auto_follow_pattern request + * Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html */ return function ccrGetAutoFollowPattern (params, options, callback) { diff --git a/api/api/ccr.pause_auto_follow_pattern.js b/api/api/ccr.pause_auto_follow_pattern.js index 5782467f9..1d3f2dbad 100644 --- a/api/api/ccr.pause_auto_follow_pattern.js +++ b/api/api/ccr.pause_auto_follow_pattern.js @@ -21,6 +21,7 @@ function buildCcrPauseAutoFollowPattern (opts) { /** * Perform a ccr.pause_auto_follow_pattern request + * Pauses an auto-follow pattern * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html */ return function ccrPauseAutoFollowPattern (params, options, callback) { diff --git a/api/api/ccr.pause_follow.js b/api/api/ccr.pause_follow.js index cfcc949c7..9756389e9 100644 --- a/api/api/ccr.pause_follow.js +++ b/api/api/ccr.pause_follow.js @@ -21,6 +21,7 @@ function buildCcrPauseFollow (opts) { /** * Perform a ccr.pause_follow request + * Pauses a follower index. The follower index will not fetch any additional operations from the leader index. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html */ return function ccrPauseFollow (params, options, callback) { diff --git a/api/api/ccr.put_auto_follow_pattern.js b/api/api/ccr.put_auto_follow_pattern.js index 5454cb8d3..55e2bde6e 100644 --- a/api/api/ccr.put_auto_follow_pattern.js +++ b/api/api/ccr.put_auto_follow_pattern.js @@ -21,6 +21,7 @@ function buildCcrPutAutoFollowPattern (opts) { /** * Perform a ccr.put_auto_follow_pattern request + * Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html */ return function ccrPutAutoFollowPattern (params, options, callback) { diff --git a/api/api/ccr.resume_auto_follow_pattern.js b/api/api/ccr.resume_auto_follow_pattern.js index d8adf6dc0..d2139af1e 100644 --- a/api/api/ccr.resume_auto_follow_pattern.js +++ b/api/api/ccr.resume_auto_follow_pattern.js @@ -21,6 +21,7 @@ function buildCcrResumeAutoFollowPattern (opts) { /** * Perform a ccr.resume_auto_follow_pattern request + * Resumes an auto-follow pattern that has been paused * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html */ return function ccrResumeAutoFollowPattern (params, options, callback) { diff --git a/api/api/ccr.resume_follow.js b/api/api/ccr.resume_follow.js index ad37afb9b..164bdd453 100644 --- a/api/api/ccr.resume_follow.js +++ b/api/api/ccr.resume_follow.js @@ -21,6 +21,7 @@ function buildCcrResumeFollow (opts) { /** * Perform a ccr.resume_follow request + * Resumes a follower index that has been paused * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html */ return function ccrResumeFollow (params, options, callback) { diff --git a/api/api/ccr.stats.js b/api/api/ccr.stats.js index 7f8d265d5..fc067a5cb 100644 --- a/api/api/ccr.stats.js +++ b/api/api/ccr.stats.js @@ -21,6 +21,7 @@ function buildCcrStats (opts) { /** * Perform a ccr.stats request + * Gets all stats related to cross-cluster replication. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html */ return function ccrStats (params, options, callback) { diff --git a/api/api/ccr.unfollow.js b/api/api/ccr.unfollow.js index 93c85f669..629d73352 100644 --- a/api/api/ccr.unfollow.js +++ b/api/api/ccr.unfollow.js @@ -21,6 +21,7 @@ function buildCcrUnfollow (opts) { /** * Perform a ccr.unfollow request + * Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html */ return function ccrUnfollow (params, options, callback) { diff --git a/api/api/data_frame_transform_deprecated.delete_transform.js b/api/api/data_frame_transform_deprecated.delete_transform.js index beaf9a387..a0de655cd 100644 --- a/api/api/data_frame_transform_deprecated.delete_transform.js +++ b/api/api/data_frame_transform_deprecated.delete_transform.js @@ -21,6 +21,7 @@ function buildDataFrameTransformDeprecatedDeleteTransform (opts) { /** * Perform a data_frame_transform_deprecated.delete_transform request + * Deletes an existing transform. * https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html */ return function dataFrameTransformDeprecatedDeleteTransform (params, options, callback) { diff --git a/api/api/data_frame_transform_deprecated.get_transform.js b/api/api/data_frame_transform_deprecated.get_transform.js index a2eb48f66..d1ace6cdd 100644 --- a/api/api/data_frame_transform_deprecated.get_transform.js +++ b/api/api/data_frame_transform_deprecated.get_transform.js @@ -23,6 +23,7 @@ function buildDataFrameTransformDeprecatedGetTransform (opts) { /** * Perform a data_frame_transform_deprecated.get_transform request + * Retrieves configuration information for transforms. * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html */ return function dataFrameTransformDeprecatedGetTransform (params, options, callback) { diff --git a/api/api/data_frame_transform_deprecated.get_transform_stats.js b/api/api/data_frame_transform_deprecated.get_transform_stats.js index fa23121a3..c0eea1fe4 100644 --- a/api/api/data_frame_transform_deprecated.get_transform_stats.js +++ b/api/api/data_frame_transform_deprecated.get_transform_stats.js @@ -23,6 +23,7 @@ function buildDataFrameTransformDeprecatedGetTransformStats (opts) { /** * Perform a data_frame_transform_deprecated.get_transform_stats request + * Retrieves usage information for transforms. * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html */ return function dataFrameTransformDeprecatedGetTransformStats (params, options, callback) { diff --git a/api/api/data_frame_transform_deprecated.preview_transform.js b/api/api/data_frame_transform_deprecated.preview_transform.js index 24c26c166..3a601c48c 100644 --- a/api/api/data_frame_transform_deprecated.preview_transform.js +++ b/api/api/data_frame_transform_deprecated.preview_transform.js @@ -21,6 +21,7 @@ function buildDataFrameTransformDeprecatedPreviewTransform (opts) { /** * Perform a data_frame_transform_deprecated.preview_transform request + * Previews a transform. * https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html */ return function dataFrameTransformDeprecatedPreviewTransform (params, options, callback) { diff --git a/api/api/data_frame_transform_deprecated.put_transform.js b/api/api/data_frame_transform_deprecated.put_transform.js index e57e8f04e..636d656a3 100644 --- a/api/api/data_frame_transform_deprecated.put_transform.js +++ b/api/api/data_frame_transform_deprecated.put_transform.js @@ -21,6 +21,7 @@ function buildDataFrameTransformDeprecatedPutTransform (opts) { /** * Perform a data_frame_transform_deprecated.put_transform request + * Instantiates a transform. * https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html */ return function dataFrameTransformDeprecatedPutTransform (params, options, callback) { diff --git a/api/api/data_frame_transform_deprecated.start_transform.js b/api/api/data_frame_transform_deprecated.start_transform.js index 933e2bc28..eac2c67ad 100644 --- a/api/api/data_frame_transform_deprecated.start_transform.js +++ b/api/api/data_frame_transform_deprecated.start_transform.js @@ -21,6 +21,7 @@ function buildDataFrameTransformDeprecatedStartTransform (opts) { /** * Perform a data_frame_transform_deprecated.start_transform request + * Starts one or more transforms. * https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html */ return function dataFrameTransformDeprecatedStartTransform (params, options, callback) { diff --git a/api/api/data_frame_transform_deprecated.stop_transform.js b/api/api/data_frame_transform_deprecated.stop_transform.js index fcc8a0140..48403d42b 100644 --- a/api/api/data_frame_transform_deprecated.stop_transform.js +++ b/api/api/data_frame_transform_deprecated.stop_transform.js @@ -24,6 +24,7 @@ function buildDataFrameTransformDeprecatedStopTransform (opts) { /** * Perform a data_frame_transform_deprecated.stop_transform request + * Stops one or more transforms. * https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html */ return function dataFrameTransformDeprecatedStopTransform (params, options, callback) { diff --git a/api/api/data_frame_transform_deprecated.update_transform.js b/api/api/data_frame_transform_deprecated.update_transform.js index 3c276c974..2f4a887fe 100644 --- a/api/api/data_frame_transform_deprecated.update_transform.js +++ b/api/api/data_frame_transform_deprecated.update_transform.js @@ -21,6 +21,7 @@ function buildDataFrameTransformDeprecatedUpdateTransform (opts) { /** * Perform a data_frame_transform_deprecated.update_transform request + * Updates certain properties of a transform. * https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html */ return function dataFrameTransformDeprecatedUpdateTransform (params, options, callback) { diff --git a/api/api/enrich.delete_policy.js b/api/api/enrich.delete_policy.js index 461275a87..790e0aec4 100644 --- a/api/api/enrich.delete_policy.js +++ b/api/api/enrich.delete_policy.js @@ -21,6 +21,7 @@ function buildEnrichDeletePolicy (opts) { /** * Perform a enrich.delete_policy request + * Deletes an existing enrich policy and its enrich index. * https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html */ return function enrichDeletePolicy (params, options, callback) { diff --git a/api/api/enrich.execute_policy.js b/api/api/enrich.execute_policy.js index ebc46b7b7..76dc6555b 100644 --- a/api/api/enrich.execute_policy.js +++ b/api/api/enrich.execute_policy.js @@ -21,6 +21,7 @@ function buildEnrichExecutePolicy (opts) { /** * Perform a enrich.execute_policy request + * Creates the enrich index for an existing enrich policy. * https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html */ return function enrichExecutePolicy (params, options, callback) { diff --git a/api/api/enrich.get_policy.js b/api/api/enrich.get_policy.js index 23a0fca29..66dc936c3 100644 --- a/api/api/enrich.get_policy.js +++ b/api/api/enrich.get_policy.js @@ -21,6 +21,7 @@ function buildEnrichGetPolicy (opts) { /** * Perform a enrich.get_policy request + * Gets information about an enrich policy. * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html */ return function enrichGetPolicy (params, options, callback) { diff --git a/api/api/enrich.put_policy.js b/api/api/enrich.put_policy.js index 9b6e2c039..8e5ce4423 100644 --- a/api/api/enrich.put_policy.js +++ b/api/api/enrich.put_policy.js @@ -21,6 +21,7 @@ function buildEnrichPutPolicy (opts) { /** * Perform a enrich.put_policy request + * Creates a new enrich policy. * https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html */ return function enrichPutPolicy (params, options, callback) { diff --git a/api/api/enrich.stats.js b/api/api/enrich.stats.js index cc3da67b1..eef1acb3a 100644 --- a/api/api/enrich.stats.js +++ b/api/api/enrich.stats.js @@ -21,6 +21,7 @@ function buildEnrichStats (opts) { /** * Perform a enrich.stats request + * Gets enrich coordinator statistics and information about enrich policies that are currently executing. * https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html */ return function enrichStats (params, options, callback) { diff --git a/api/api/eql.search.js b/api/api/eql.search.js index d2194f436..b171517b4 100644 --- a/api/api/eql.search.js +++ b/api/api/eql.search.js @@ -21,6 +21,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 */ return function eqlSearch (params, options, callback) { diff --git a/api/api/get_script_context.js b/api/api/get_script_context.js index 67301b982..1edc10047 100644 --- a/api/api/get_script_context.js +++ b/api/api/get_script_context.js @@ -27,6 +27,7 @@ function buildGetScriptContext (opts) { /** * Perform a get_script_context request * Returns all script contexts. + * https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html */ return function getScriptContext (params, options, callback) { options = options || {} diff --git a/api/api/get_script_languages.js b/api/api/get_script_languages.js index 2875249ba..38f70452b 100644 --- a/api/api/get_script_languages.js +++ b/api/api/get_script_languages.js @@ -27,6 +27,7 @@ function buildGetScriptLanguages (opts) { /** * Perform a get_script_languages request * Returns available script types, languages and contexts + * https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html */ return function getScriptLanguages (params, options, callback) { options = options || {} diff --git a/api/api/graph.explore.js b/api/api/graph.explore.js index b4a662a29..31a1ed011 100644 --- a/api/api/graph.explore.js +++ b/api/api/graph.explore.js @@ -22,6 +22,7 @@ function buildGraphExplore (opts) { /** * Perform a graph.explore request + * Explore extracted and summarized information about the documents and terms in an index. * https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html */ return function graphExplore (params, options, callback) { diff --git a/api/api/ilm.delete_lifecycle.js b/api/api/ilm.delete_lifecycle.js index 41cf8622c..798cf7871 100644 --- a/api/api/ilm.delete_lifecycle.js +++ b/api/api/ilm.delete_lifecycle.js @@ -21,6 +21,7 @@ function buildIlmDeleteLifecycle (opts) { /** * Perform a ilm.delete_lifecycle request + * Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html */ return function ilmDeleteLifecycle (params, options, callback) { diff --git a/api/api/ilm.explain_lifecycle.js b/api/api/ilm.explain_lifecycle.js index d78c8c843..d2e85be72 100644 --- a/api/api/ilm.explain_lifecycle.js +++ b/api/api/ilm.explain_lifecycle.js @@ -23,6 +23,7 @@ function buildIlmExplainLifecycle (opts) { /** * Perform a ilm.explain_lifecycle request + * Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html */ return function ilmExplainLifecycle (params, options, callback) { diff --git a/api/api/ilm.get_lifecycle.js b/api/api/ilm.get_lifecycle.js index 7b5c3cf9a..bd82e7423 100644 --- a/api/api/ilm.get_lifecycle.js +++ b/api/api/ilm.get_lifecycle.js @@ -21,6 +21,7 @@ function buildIlmGetLifecycle (opts) { /** * Perform a ilm.get_lifecycle request + * Returns the specified policy definition. Includes the policy version and last modified date. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html */ return function ilmGetLifecycle (params, options, callback) { diff --git a/api/api/ilm.get_status.js b/api/api/ilm.get_status.js index af7a563cc..13a26bfd8 100644 --- a/api/api/ilm.get_status.js +++ b/api/api/ilm.get_status.js @@ -21,6 +21,7 @@ function buildIlmGetStatus (opts) { /** * Perform a ilm.get_status request + * Retrieves the current index lifecycle management (ILM) status. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html */ return function ilmGetStatus (params, options, callback) { diff --git a/api/api/ilm.move_to_step.js b/api/api/ilm.move_to_step.js index d26c0edf0..5ce32fcd9 100644 --- a/api/api/ilm.move_to_step.js +++ b/api/api/ilm.move_to_step.js @@ -21,6 +21,7 @@ function buildIlmMoveToStep (opts) { /** * Perform a ilm.move_to_step request + * Manually moves an index into the specified step and executes that step. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html */ return function ilmMoveToStep (params, options, callback) { diff --git a/api/api/ilm.put_lifecycle.js b/api/api/ilm.put_lifecycle.js index 7c75b50d6..301484462 100644 --- a/api/api/ilm.put_lifecycle.js +++ b/api/api/ilm.put_lifecycle.js @@ -21,6 +21,7 @@ function buildIlmPutLifecycle (opts) { /** * Perform a ilm.put_lifecycle request + * Creates a lifecycle policy * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html */ return function ilmPutLifecycle (params, options, callback) { diff --git a/api/api/ilm.remove_policy.js b/api/api/ilm.remove_policy.js index 28f1d073d..cf3d650af 100644 --- a/api/api/ilm.remove_policy.js +++ b/api/api/ilm.remove_policy.js @@ -21,6 +21,7 @@ function buildIlmRemovePolicy (opts) { /** * Perform a ilm.remove_policy request + * Removes the assigned lifecycle policy and stops managing the specified index * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html */ return function ilmRemovePolicy (params, options, callback) { diff --git a/api/api/ilm.retry.js b/api/api/ilm.retry.js index 6c45d8c33..92c2441ff 100644 --- a/api/api/ilm.retry.js +++ b/api/api/ilm.retry.js @@ -21,6 +21,7 @@ function buildIlmRetry (opts) { /** * Perform a ilm.retry request + * Retries executing the policy for an index that is in the ERROR step. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html */ return function ilmRetry (params, options, callback) { diff --git a/api/api/ilm.start.js b/api/api/ilm.start.js index 6cac65dc2..0cfa45824 100644 --- a/api/api/ilm.start.js +++ b/api/api/ilm.start.js @@ -21,6 +21,7 @@ function buildIlmStart (opts) { /** * Perform a ilm.start request + * Start the index lifecycle management (ILM) plugin. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html */ return function ilmStart (params, options, callback) { diff --git a/api/api/ilm.stop.js b/api/api/ilm.stop.js index 167cd59f2..1d28947e7 100644 --- a/api/api/ilm.stop.js +++ b/api/api/ilm.stop.js @@ -21,6 +21,7 @@ function buildIlmStop (opts) { /** * Perform a ilm.stop request + * Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin * https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html */ return function ilmStop (params, options, callback) { diff --git a/api/api/indices.freeze.js b/api/api/indices.freeze.js index d18e0e92a..033335bc3 100644 --- a/api/api/indices.freeze.js +++ b/api/api/indices.freeze.js @@ -30,7 +30,8 @@ function buildIndicesFreeze (opts) { /** * Perform a indices.freeze request - * https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html + * Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/freeze-index-api.html */ return function indicesFreeze (params, options, callback) { options = options || {} diff --git a/api/api/indices.reload_search_analyzers.js b/api/api/indices.reload_search_analyzers.js index 3487e3a8d..f0284d279 100644 --- a/api/api/indices.reload_search_analyzers.js +++ b/api/api/indices.reload_search_analyzers.js @@ -25,6 +25,7 @@ function buildIndicesReloadSearchAnalyzers (opts) { /** * Perform a indices.reload_search_analyzers request + * Reloads an index's search analyzers and their resources. * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html */ return function indicesReloadSearchAnalyzers (params, options, callback) { diff --git a/api/api/indices.unfreeze.js b/api/api/indices.unfreeze.js index f67fec2af..00a31a84d 100644 --- a/api/api/indices.unfreeze.js +++ b/api/api/indices.unfreeze.js @@ -30,7 +30,8 @@ function buildIndicesUnfreeze (opts) { /** * Perform a indices.unfreeze request - * https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html + * Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html */ return function indicesUnfreeze (params, options, callback) { options = options || {} diff --git a/api/api/license.delete.js b/api/api/license.delete.js index 574c7e4b9..c099da457 100644 --- a/api/api/license.delete.js +++ b/api/api/license.delete.js @@ -21,6 +21,7 @@ function buildLicenseDelete (opts) { /** * Perform a license.delete request + * Deletes licensing information for the cluster * https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html */ return function licenseDelete (params, options, callback) { diff --git a/api/api/license.get.js b/api/api/license.get.js index df5d326fb..75ef90a54 100644 --- a/api/api/license.get.js +++ b/api/api/license.get.js @@ -22,6 +22,7 @@ function buildLicenseGet (opts) { /** * Perform a license.get request + * Retrieves licensing information for the cluster * https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html */ return function licenseGet (params, options, callback) { diff --git a/api/api/license.get_basic_status.js b/api/api/license.get_basic_status.js index 388337796..2d8fdde52 100644 --- a/api/api/license.get_basic_status.js +++ b/api/api/license.get_basic_status.js @@ -21,6 +21,7 @@ function buildLicenseGetBasicStatus (opts) { /** * Perform a license.get_basic_status request + * Retrieves information about the status of the basic license. * https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html */ return function licenseGetBasicStatus (params, options, callback) { diff --git a/api/api/license.get_trial_status.js b/api/api/license.get_trial_status.js index 6de809c89..e7b16218c 100644 --- a/api/api/license.get_trial_status.js +++ b/api/api/license.get_trial_status.js @@ -21,6 +21,7 @@ function buildLicenseGetTrialStatus (opts) { /** * Perform a license.get_trial_status request + * Retrieves information about the status of the trial license. * https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html */ return function licenseGetTrialStatus (params, options, callback) { diff --git a/api/api/license.post.js b/api/api/license.post.js index 40d12357c..d4463f5a8 100644 --- a/api/api/license.post.js +++ b/api/api/license.post.js @@ -21,6 +21,7 @@ function buildLicensePost (opts) { /** * Perform a license.post request + * Updates the license for the cluster. * https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html */ return function licensePost (params, options, callback) { diff --git a/api/api/license.post_start_basic.js b/api/api/license.post_start_basic.js index d5434ad68..7b9a1dec1 100644 --- a/api/api/license.post_start_basic.js +++ b/api/api/license.post_start_basic.js @@ -21,6 +21,7 @@ function buildLicensePostStartBasic (opts) { /** * Perform a license.post_start_basic request + * Starts an indefinite basic license. * https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html */ return function licensePostStartBasic (params, options, callback) { diff --git a/api/api/license.post_start_trial.js b/api/api/license.post_start_trial.js index 85178c48b..08e876df2 100644 --- a/api/api/license.post_start_trial.js +++ b/api/api/license.post_start_trial.js @@ -22,6 +22,7 @@ function buildLicensePostStartTrial (opts) { /** * Perform a license.post_start_trial request + * starts a limited time trial license. * https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html */ return function licensePostStartTrial (params, options, callback) { diff --git a/api/api/migration.deprecations.js b/api/api/migration.deprecations.js index 3847e2d97..1a0efca36 100644 --- a/api/api/migration.deprecations.js +++ b/api/api/migration.deprecations.js @@ -21,6 +21,7 @@ function buildMigrationDeprecations (opts) { /** * Perform a migration.deprecations request + * Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. * https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html */ return function migrationDeprecations (params, options, callback) { diff --git a/api/api/ml.close_job.js b/api/api/ml.close_job.js index 8b62210f7..fb853a188 100644 --- a/api/api/ml.close_job.js +++ b/api/api/ml.close_job.js @@ -24,6 +24,7 @@ function buildMlCloseJob (opts) { /** * Perform a ml.close_job request + * Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html */ return function mlCloseJob (params, options, callback) { diff --git a/api/api/ml.delete_calendar.js b/api/api/ml.delete_calendar.js index 4ea094143..7ce88dbac 100644 --- a/api/api/ml.delete_calendar.js +++ b/api/api/ml.delete_calendar.js @@ -21,6 +21,8 @@ function buildMlDeleteCalendar (opts) { /** * Perform a ml.delete_calendar request + * Deletes a calendar. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html */ return function mlDeleteCalendar (params, options, callback) { options = options || {} diff --git a/api/api/ml.delete_calendar_event.js b/api/api/ml.delete_calendar_event.js index 58674c5d9..027c8ebaf 100644 --- a/api/api/ml.delete_calendar_event.js +++ b/api/api/ml.delete_calendar_event.js @@ -21,6 +21,8 @@ function buildMlDeleteCalendarEvent (opts) { /** * Perform a ml.delete_calendar_event request + * Deletes scheduled events from a calendar. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html */ return function mlDeleteCalendarEvent (params, options, callback) { options = options || {} diff --git a/api/api/ml.delete_calendar_job.js b/api/api/ml.delete_calendar_job.js index ac8c37817..cd9cee576 100644 --- a/api/api/ml.delete_calendar_job.js +++ b/api/api/ml.delete_calendar_job.js @@ -21,6 +21,8 @@ function buildMlDeleteCalendarJob (opts) { /** * Perform a ml.delete_calendar_job request + * Deletes anomaly detection jobs from a calendar. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html */ return function mlDeleteCalendarJob (params, options, callback) { options = options || {} diff --git a/api/api/ml.delete_data_frame_analytics.js b/api/api/ml.delete_data_frame_analytics.js index 61d0357e7..a067f15ba 100644 --- a/api/api/ml.delete_data_frame_analytics.js +++ b/api/api/ml.delete_data_frame_analytics.js @@ -21,6 +21,7 @@ function buildMlDeleteDataFrameAnalytics (opts) { /** * Perform a ml.delete_data_frame_analytics request + * Deletes an existing data frame analytics job. * https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html */ return function mlDeleteDataFrameAnalytics (params, options, callback) { diff --git a/api/api/ml.delete_datafeed.js b/api/api/ml.delete_datafeed.js index e41b27944..ecf9a4f92 100644 --- a/api/api/ml.delete_datafeed.js +++ b/api/api/ml.delete_datafeed.js @@ -21,6 +21,7 @@ function buildMlDeleteDatafeed (opts) { /** * Perform a ml.delete_datafeed request + * Deletes an existing datafeed. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html */ return function mlDeleteDatafeed (params, options, callback) { diff --git a/api/api/ml.delete_expired_data.js b/api/api/ml.delete_expired_data.js index 2fb061b83..a9fa3368d 100644 --- a/api/api/ml.delete_expired_data.js +++ b/api/api/ml.delete_expired_data.js @@ -21,6 +21,8 @@ function buildMlDeleteExpiredData (opts) { /** * Perform a ml.delete_expired_data request + * Deletes expired and unused machine learning data. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html */ return function mlDeleteExpiredData (params, options, callback) { options = options || {} diff --git a/api/api/ml.delete_filter.js b/api/api/ml.delete_filter.js index 35ac05eea..439346fcd 100644 --- a/api/api/ml.delete_filter.js +++ b/api/api/ml.delete_filter.js @@ -21,6 +21,8 @@ function buildMlDeleteFilter (opts) { /** * Perform a ml.delete_filter request + * Deletes a filter. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html */ return function mlDeleteFilter (params, options, callback) { options = options || {} diff --git a/api/api/ml.delete_forecast.js b/api/api/ml.delete_forecast.js index 3c85b3d94..4f2e7f46f 100644 --- a/api/api/ml.delete_forecast.js +++ b/api/api/ml.delete_forecast.js @@ -23,6 +23,7 @@ function buildMlDeleteForecast (opts) { /** * Perform a ml.delete_forecast request + * Deletes forecasts from a machine learning job. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html */ return function mlDeleteForecast (params, options, callback) { diff --git a/api/api/ml.delete_job.js b/api/api/ml.delete_job.js index f23098bb2..31122255c 100644 --- a/api/api/ml.delete_job.js +++ b/api/api/ml.delete_job.js @@ -22,6 +22,7 @@ function buildMlDeleteJob (opts) { /** * Perform a ml.delete_job request + * Deletes an existing anomaly detection job. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html */ return function mlDeleteJob (params, options, callback) { diff --git a/api/api/ml.delete_model_snapshot.js b/api/api/ml.delete_model_snapshot.js index 7371395b9..5768d1d6a 100644 --- a/api/api/ml.delete_model_snapshot.js +++ b/api/api/ml.delete_model_snapshot.js @@ -21,6 +21,7 @@ function buildMlDeleteModelSnapshot (opts) { /** * Perform a ml.delete_model_snapshot request + * Deletes an existing model snapshot. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html */ return function mlDeleteModelSnapshot (params, options, callback) { diff --git a/api/api/ml.delete_trained_model.js b/api/api/ml.delete_trained_model.js index 163f1b2b1..0aacc49ba 100644 --- a/api/api/ml.delete_trained_model.js +++ b/api/api/ml.delete_trained_model.js @@ -21,6 +21,7 @@ function buildMlDeleteTrainedModel (opts) { /** * Perform a ml.delete_trained_model request + * Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. * https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-inference.html */ return function mlDeleteTrainedModel (params, options, callback) { diff --git a/api/api/ml.estimate_model_memory.js b/api/api/ml.estimate_model_memory.js index 5af98cfdb..4287cfec6 100644 --- a/api/api/ml.estimate_model_memory.js +++ b/api/api/ml.estimate_model_memory.js @@ -21,6 +21,8 @@ function buildMlEstimateModelMemory (opts) { /** * Perform a ml.estimate_model_memory request + * Estimates the model memory + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html */ return function mlEstimateModelMemory (params, options, callback) { options = options || {} diff --git a/api/api/ml.evaluate_data_frame.js b/api/api/ml.evaluate_data_frame.js index cf9f42e74..24ca8e3d2 100644 --- a/api/api/ml.evaluate_data_frame.js +++ b/api/api/ml.evaluate_data_frame.js @@ -21,6 +21,7 @@ function buildMlEvaluateDataFrame (opts) { /** * Perform a ml.evaluate_data_frame request + * Evaluates the data frame analytics for an annotated index. * https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html */ return function mlEvaluateDataFrame (params, options, callback) { diff --git a/api/api/ml.explain_data_frame_analytics.js b/api/api/ml.explain_data_frame_analytics.js index b443fba6c..dec8dcf79 100644 --- a/api/api/ml.explain_data_frame_analytics.js +++ b/api/api/ml.explain_data_frame_analytics.js @@ -21,6 +21,7 @@ function buildMlExplainDataFrameAnalytics (opts) { /** * Perform a ml.explain_data_frame_analytics request + * Explains a data frame analytics config. * http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html */ return function mlExplainDataFrameAnalytics (params, options, callback) { diff --git a/api/api/ml.find_file_structure.js b/api/api/ml.find_file_structure.js index 155ad4e73..e8002c15d 100644 --- a/api/api/ml.find_file_structure.js +++ b/api/api/ml.find_file_structure.js @@ -42,6 +42,7 @@ function buildMlFindFileStructure (opts) { /** * Perform a ml.find_file_structure request + * Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html */ return function mlFindFileStructure (params, options, callback) { diff --git a/api/api/ml.flush_job.js b/api/api/ml.flush_job.js index 8dc00346c..4ca50f6bd 100644 --- a/api/api/ml.flush_job.js +++ b/api/api/ml.flush_job.js @@ -27,6 +27,7 @@ function buildMlFlushJob (opts) { /** * Perform a ml.flush_job request + * Forces any buffered data to be processed by the job. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html */ return function mlFlushJob (params, options, callback) { diff --git a/api/api/ml.forecast.js b/api/api/ml.forecast.js index cafb128ac..35fe59d56 100644 --- a/api/api/ml.forecast.js +++ b/api/api/ml.forecast.js @@ -22,6 +22,8 @@ function buildMlForecast (opts) { /** * Perform a ml.forecast request + * Predicts the future behavior of a time series by using its historical behavior. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html */ return function mlForecast (params, options, callback) { options = options || {} diff --git a/api/api/ml.get_buckets.js b/api/api/ml.get_buckets.js index aef8e898a..3e7585a5f 100644 --- a/api/api/ml.get_buckets.js +++ b/api/api/ml.get_buckets.js @@ -31,6 +31,7 @@ function buildMlGetBuckets (opts) { /** * Perform a ml.get_buckets request + * Retrieves anomaly detection job results for one or more buckets. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html */ return function mlGetBuckets (params, options, callback) { diff --git a/api/api/ml.get_calendar_events.js b/api/api/ml.get_calendar_events.js index 831447e15..6bb299b77 100644 --- a/api/api/ml.get_calendar_events.js +++ b/api/api/ml.get_calendar_events.js @@ -26,6 +26,8 @@ function buildMlGetCalendarEvents (opts) { /** * Perform a ml.get_calendar_events request + * Retrieves information about the scheduled events in calendars. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html */ return function mlGetCalendarEvents (params, options, callback) { options = options || {} diff --git a/api/api/ml.get_calendars.js b/api/api/ml.get_calendars.js index 92fbe2a97..53440e052 100644 --- a/api/api/ml.get_calendars.js +++ b/api/api/ml.get_calendars.js @@ -22,6 +22,8 @@ function buildMlGetCalendars (opts) { /** * Perform a ml.get_calendars request + * Retrieves configuration information for calendars. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html */ return function mlGetCalendars (params, options, callback) { options = options || {} diff --git a/api/api/ml.get_categories.js b/api/api/ml.get_categories.js index e988fd7e3..68250b7c9 100644 --- a/api/api/ml.get_categories.js +++ b/api/api/ml.get_categories.js @@ -22,6 +22,7 @@ function buildMlGetCategories (opts) { /** * Perform a ml.get_categories request + * Retrieves anomaly detection job results for one or more categories. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html */ return function mlGetCategories (params, options, callback) { diff --git a/api/api/ml.get_data_frame_analytics.js b/api/api/ml.get_data_frame_analytics.js index a6707d392..0d3d99008 100644 --- a/api/api/ml.get_data_frame_analytics.js +++ b/api/api/ml.get_data_frame_analytics.js @@ -24,6 +24,7 @@ function buildMlGetDataFrameAnalytics (opts) { /** * Perform a ml.get_data_frame_analytics request + * Retrieves configuration information for data frame analytics jobs. * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html */ return function mlGetDataFrameAnalytics (params, options, callback) { diff --git a/api/api/ml.get_data_frame_analytics_stats.js b/api/api/ml.get_data_frame_analytics_stats.js index 0dd6a05bc..82f4d71d5 100644 --- a/api/api/ml.get_data_frame_analytics_stats.js +++ b/api/api/ml.get_data_frame_analytics_stats.js @@ -24,6 +24,7 @@ function buildMlGetDataFrameAnalyticsStats (opts) { /** * Perform a ml.get_data_frame_analytics_stats request + * Retrieves usage information for data frame analytics jobs. * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html */ return function mlGetDataFrameAnalyticsStats (params, options, callback) { diff --git a/api/api/ml.get_datafeed_stats.js b/api/api/ml.get_datafeed_stats.js index 1099b3bc4..9935f16f4 100644 --- a/api/api/ml.get_datafeed_stats.js +++ b/api/api/ml.get_datafeed_stats.js @@ -21,6 +21,7 @@ function buildMlGetDatafeedStats (opts) { /** * Perform a ml.get_datafeed_stats request + * Retrieves usage information for datafeeds. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html */ return function mlGetDatafeedStats (params, options, callback) { diff --git a/api/api/ml.get_datafeeds.js b/api/api/ml.get_datafeeds.js index 90b13dcfa..66b0cde5c 100644 --- a/api/api/ml.get_datafeeds.js +++ b/api/api/ml.get_datafeeds.js @@ -21,6 +21,7 @@ function buildMlGetDatafeeds (opts) { /** * Perform a ml.get_datafeeds request + * Retrieves configuration information for datafeeds. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html */ return function mlGetDatafeeds (params, options, callback) { diff --git a/api/api/ml.get_filters.js b/api/api/ml.get_filters.js index 2ec0d0a87..0d5c36973 100644 --- a/api/api/ml.get_filters.js +++ b/api/api/ml.get_filters.js @@ -22,6 +22,8 @@ function buildMlGetFilters (opts) { /** * Perform a ml.get_filters request + * Retrieves filters. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html */ return function mlGetFilters (params, options, callback) { options = options || {} diff --git a/api/api/ml.get_influencers.js b/api/api/ml.get_influencers.js index b1c73fac8..91d8269bd 100644 --- a/api/api/ml.get_influencers.js +++ b/api/api/ml.get_influencers.js @@ -30,6 +30,7 @@ function buildMlGetInfluencers (opts) { /** * Perform a ml.get_influencers request + * Retrieves anomaly detection job results for one or more influencers. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html */ return function mlGetInfluencers (params, options, callback) { diff --git a/api/api/ml.get_job_stats.js b/api/api/ml.get_job_stats.js index 2de104410..6827cff93 100644 --- a/api/api/ml.get_job_stats.js +++ b/api/api/ml.get_job_stats.js @@ -21,6 +21,7 @@ function buildMlGetJobStats (opts) { /** * Perform a ml.get_job_stats request + * Retrieves usage information for anomaly detection jobs. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html */ return function mlGetJobStats (params, options, callback) { diff --git a/api/api/ml.get_jobs.js b/api/api/ml.get_jobs.js index 2cdb2e768..30c78f4e5 100644 --- a/api/api/ml.get_jobs.js +++ b/api/api/ml.get_jobs.js @@ -21,6 +21,7 @@ function buildMlGetJobs (opts) { /** * Perform a ml.get_jobs request + * Retrieves configuration information for anomaly detection jobs. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html */ return function mlGetJobs (params, options, callback) { diff --git a/api/api/ml.get_model_snapshots.js b/api/api/ml.get_model_snapshots.js index ace7736f3..26e1e1574 100644 --- a/api/api/ml.get_model_snapshots.js +++ b/api/api/ml.get_model_snapshots.js @@ -26,6 +26,7 @@ function buildMlGetModelSnapshots (opts) { /** * Perform a ml.get_model_snapshots request + * Retrieves information about model snapshots. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html */ return function mlGetModelSnapshots (params, options, callback) { diff --git a/api/api/ml.get_overall_buckets.js b/api/api/ml.get_overall_buckets.js index 4bd27a0e5..a22f47ddf 100644 --- a/api/api/ml.get_overall_buckets.js +++ b/api/api/ml.get_overall_buckets.js @@ -31,6 +31,7 @@ function buildMlGetOverallBuckets (opts) { /** * Perform a ml.get_overall_buckets request + * Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html */ return function mlGetOverallBuckets (params, options, callback) { diff --git a/api/api/ml.get_records.js b/api/api/ml.get_records.js index 612aeb792..6f160cb24 100644 --- a/api/api/ml.get_records.js +++ b/api/api/ml.get_records.js @@ -30,6 +30,7 @@ function buildMlGetRecords (opts) { /** * Perform a ml.get_records request + * Retrieves anomaly records for an anomaly detection job. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html */ return function mlGetRecords (params, options, callback) { diff --git a/api/api/ml.get_trained_models.js b/api/api/ml.get_trained_models.js index 2d89b9cb4..75c3e99e5 100644 --- a/api/api/ml.get_trained_models.js +++ b/api/api/ml.get_trained_models.js @@ -29,6 +29,7 @@ function buildMlGetTrainedModels (opts) { /** * Perform a ml.get_trained_models request + * Retrieves configuration information for a trained inference model. * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference.html */ return function mlGetTrainedModels (params, options, callback) { diff --git a/api/api/ml.get_trained_models_stats.js b/api/api/ml.get_trained_models_stats.js index 459c8ac57..a06558cf9 100644 --- a/api/api/ml.get_trained_models_stats.js +++ b/api/api/ml.get_trained_models_stats.js @@ -24,6 +24,7 @@ function buildMlGetTrainedModelsStats (opts) { /** * Perform a ml.get_trained_models_stats request + * Retrieves usage information for trained inference models. * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference-stats.html */ return function mlGetTrainedModelsStats (params, options, callback) { diff --git a/api/api/ml.info.js b/api/api/ml.info.js index 9561bbcce..67f1c5254 100644 --- a/api/api/ml.info.js +++ b/api/api/ml.info.js @@ -21,6 +21,8 @@ function buildMlInfo (opts) { /** * Perform a ml.info request + * Returns defaults and limits used by machine learning. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html */ return function mlInfo (params, options, callback) { options = options || {} diff --git a/api/api/ml.open_job.js b/api/api/ml.open_job.js index 6c57731dd..fd7199a7e 100644 --- a/api/api/ml.open_job.js +++ b/api/api/ml.open_job.js @@ -21,6 +21,7 @@ function buildMlOpenJob (opts) { /** * Perform a ml.open_job request + * Opens one or more anomaly detection jobs. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html */ return function mlOpenJob (params, options, callback) { diff --git a/api/api/ml.post_calendar_events.js b/api/api/ml.post_calendar_events.js index 2c6b240a4..1586d6e88 100644 --- a/api/api/ml.post_calendar_events.js +++ b/api/api/ml.post_calendar_events.js @@ -21,6 +21,8 @@ function buildMlPostCalendarEvents (opts) { /** * Perform a ml.post_calendar_events request + * Posts scheduled events in a calendar. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html */ return function mlPostCalendarEvents (params, options, callback) { options = options || {} diff --git a/api/api/ml.post_data.js b/api/api/ml.post_data.js index 24649f8ce..ee13a736f 100644 --- a/api/api/ml.post_data.js +++ b/api/api/ml.post_data.js @@ -23,6 +23,7 @@ function buildMlPostData (opts) { /** * Perform a ml.post_data request + * Sends data to an anomaly detection job for analysis. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html */ return function mlPostData (params, options, callback) { diff --git a/api/api/ml.preview_datafeed.js b/api/api/ml.preview_datafeed.js index f72225a2d..cd9807027 100644 --- a/api/api/ml.preview_datafeed.js +++ b/api/api/ml.preview_datafeed.js @@ -21,6 +21,7 @@ function buildMlPreviewDatafeed (opts) { /** * Perform a ml.preview_datafeed request + * Previews a datafeed. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html */ return function mlPreviewDatafeed (params, options, callback) { diff --git a/api/api/ml.put_calendar.js b/api/api/ml.put_calendar.js index 9001b042d..d81be26fe 100644 --- a/api/api/ml.put_calendar.js +++ b/api/api/ml.put_calendar.js @@ -21,6 +21,8 @@ function buildMlPutCalendar (opts) { /** * Perform a ml.put_calendar request + * Instantiates a calendar. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html */ return function mlPutCalendar (params, options, callback) { options = options || {} diff --git a/api/api/ml.put_calendar_job.js b/api/api/ml.put_calendar_job.js index 48d064429..b6ff7a902 100644 --- a/api/api/ml.put_calendar_job.js +++ b/api/api/ml.put_calendar_job.js @@ -21,6 +21,8 @@ function buildMlPutCalendarJob (opts) { /** * Perform a ml.put_calendar_job request + * Adds an anomaly detection job to a calendar. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html */ return function mlPutCalendarJob (params, options, callback) { options = options || {} diff --git a/api/api/ml.put_data_frame_analytics.js b/api/api/ml.put_data_frame_analytics.js index d3c9d6c50..4e01baa44 100644 --- a/api/api/ml.put_data_frame_analytics.js +++ b/api/api/ml.put_data_frame_analytics.js @@ -21,6 +21,7 @@ function buildMlPutDataFrameAnalytics (opts) { /** * Perform a ml.put_data_frame_analytics request + * Instantiates a data frame analytics job. * https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html */ return function mlPutDataFrameAnalytics (params, options, callback) { diff --git a/api/api/ml.put_datafeed.js b/api/api/ml.put_datafeed.js index 1ffef3ff0..7f87ea306 100644 --- a/api/api/ml.put_datafeed.js +++ b/api/api/ml.put_datafeed.js @@ -27,6 +27,7 @@ function buildMlPutDatafeed (opts) { /** * Perform a ml.put_datafeed request + * Instantiates a datafeed. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html */ return function mlPutDatafeed (params, options, callback) { diff --git a/api/api/ml.put_filter.js b/api/api/ml.put_filter.js index 8caf9f31d..a82fffd70 100644 --- a/api/api/ml.put_filter.js +++ b/api/api/ml.put_filter.js @@ -21,6 +21,8 @@ function buildMlPutFilter (opts) { /** * Perform a ml.put_filter request + * Instantiates a filter. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html */ return function mlPutFilter (params, options, callback) { options = options || {} diff --git a/api/api/ml.put_job.js b/api/api/ml.put_job.js index ecf94cc2d..0ad56a8aa 100644 --- a/api/api/ml.put_job.js +++ b/api/api/ml.put_job.js @@ -21,6 +21,7 @@ function buildMlPutJob (opts) { /** * Perform a ml.put_job request + * Instantiates an anomaly detection job. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html */ return function mlPutJob (params, options, callback) { diff --git a/api/api/ml.put_trained_model.js b/api/api/ml.put_trained_model.js index 4aae4e867..1d460ae35 100644 --- a/api/api/ml.put_trained_model.js +++ b/api/api/ml.put_trained_model.js @@ -21,7 +21,8 @@ function buildMlPutTrainedModel (opts) { /** * Perform a ml.put_trained_model request - * TODO + * Creates an inference trained model. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/put-inference.html */ return function mlPutTrainedModel (params, options, callback) { options = options || {} diff --git a/api/api/ml.revert_model_snapshot.js b/api/api/ml.revert_model_snapshot.js index 89b9d0d8e..b5ac7a714 100644 --- a/api/api/ml.revert_model_snapshot.js +++ b/api/api/ml.revert_model_snapshot.js @@ -21,6 +21,7 @@ function buildMlRevertModelSnapshot (opts) { /** * Perform a ml.revert_model_snapshot request + * Reverts to a specific snapshot. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html */ return function mlRevertModelSnapshot (params, options, callback) { diff --git a/api/api/ml.set_upgrade_mode.js b/api/api/ml.set_upgrade_mode.js index 910c2f2da..6d5a03f06 100644 --- a/api/api/ml.set_upgrade_mode.js +++ b/api/api/ml.set_upgrade_mode.js @@ -22,6 +22,7 @@ function buildMlSetUpgradeMode (opts) { /** * Perform a ml.set_upgrade_mode request + * Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html */ return function mlSetUpgradeMode (params, options, callback) { diff --git a/api/api/ml.start_data_frame_analytics.js b/api/api/ml.start_data_frame_analytics.js index d941e1a84..7ba5210b3 100644 --- a/api/api/ml.start_data_frame_analytics.js +++ b/api/api/ml.start_data_frame_analytics.js @@ -21,6 +21,7 @@ function buildMlStartDataFrameAnalytics (opts) { /** * Perform a ml.start_data_frame_analytics request + * Starts a data frame analytics job. * https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html */ return function mlStartDataFrameAnalytics (params, options, callback) { diff --git a/api/api/ml.start_datafeed.js b/api/api/ml.start_datafeed.js index 5886b2c4d..45725dfbf 100644 --- a/api/api/ml.start_datafeed.js +++ b/api/api/ml.start_datafeed.js @@ -23,6 +23,7 @@ function buildMlStartDatafeed (opts) { /** * Perform a ml.start_datafeed request + * Starts one or more datafeeds. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html */ return function mlStartDatafeed (params, options, callback) { diff --git a/api/api/ml.stop_data_frame_analytics.js b/api/api/ml.stop_data_frame_analytics.js index 3a01d20aa..f549389e2 100644 --- a/api/api/ml.stop_data_frame_analytics.js +++ b/api/api/ml.stop_data_frame_analytics.js @@ -24,6 +24,7 @@ function buildMlStopDataFrameAnalytics (opts) { /** * Perform a ml.stop_data_frame_analytics request + * Stops one or more data frame analytics jobs. * https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html */ return function mlStopDataFrameAnalytics (params, options, callback) { diff --git a/api/api/ml.stop_datafeed.js b/api/api/ml.stop_datafeed.js index 9ce1c076f..a10f9a926 100644 --- a/api/api/ml.stop_datafeed.js +++ b/api/api/ml.stop_datafeed.js @@ -24,6 +24,7 @@ function buildMlStopDatafeed (opts) { /** * Perform a ml.stop_datafeed request + * Stops one or more datafeeds. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html */ return function mlStopDatafeed (params, options, callback) { diff --git a/api/api/ml.update_datafeed.js b/api/api/ml.update_datafeed.js index faac2d45b..253b89cc7 100644 --- a/api/api/ml.update_datafeed.js +++ b/api/api/ml.update_datafeed.js @@ -27,6 +27,7 @@ function buildMlUpdateDatafeed (opts) { /** * Perform a ml.update_datafeed request + * Updates certain properties of a datafeed. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html */ return function mlUpdateDatafeed (params, options, callback) { diff --git a/api/api/ml.update_filter.js b/api/api/ml.update_filter.js index 0126cb340..38296576e 100644 --- a/api/api/ml.update_filter.js +++ b/api/api/ml.update_filter.js @@ -21,6 +21,8 @@ function buildMlUpdateFilter (opts) { /** * Perform a ml.update_filter request + * Updates the description of a filter, adds items, or removes items. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html */ return function mlUpdateFilter (params, options, callback) { options = options || {} diff --git a/api/api/ml.update_job.js b/api/api/ml.update_job.js index 9abb38804..3f2b52e88 100644 --- a/api/api/ml.update_job.js +++ b/api/api/ml.update_job.js @@ -21,6 +21,7 @@ function buildMlUpdateJob (opts) { /** * Perform a ml.update_job request + * Updates certain properties of an anomaly detection job. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html */ return function mlUpdateJob (params, options, callback) { diff --git a/api/api/ml.update_model_snapshot.js b/api/api/ml.update_model_snapshot.js index cb25613bd..5890350a9 100644 --- a/api/api/ml.update_model_snapshot.js +++ b/api/api/ml.update_model_snapshot.js @@ -21,6 +21,7 @@ function buildMlUpdateModelSnapshot (opts) { /** * Perform a ml.update_model_snapshot request + * Updates certain properties of a snapshot. * https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html */ return function mlUpdateModelSnapshot (params, options, callback) { diff --git a/api/api/ml.validate.js b/api/api/ml.validate.js index 2636517c7..83ba73dec 100644 --- a/api/api/ml.validate.js +++ b/api/api/ml.validate.js @@ -21,6 +21,7 @@ function buildMlValidate (opts) { /** * Perform a ml.validate request + * Validates an anomaly detection job. */ return function mlValidate (params, options, callback) { options = options || {} diff --git a/api/api/ml.validate_detector.js b/api/api/ml.validate_detector.js index a49d01174..7e14bd0fb 100644 --- a/api/api/ml.validate_detector.js +++ b/api/api/ml.validate_detector.js @@ -21,6 +21,7 @@ function buildMlValidateDetector (opts) { /** * Perform a ml.validate_detector request + * Validates an anomaly detection detector. */ return function mlValidateDetector (params, options, callback) { options = options || {} diff --git a/api/api/monitoring.bulk.js b/api/api/monitoring.bulk.js index eac502921..366f72155 100644 --- a/api/api/monitoring.bulk.js +++ b/api/api/monitoring.bulk.js @@ -25,6 +25,7 @@ function buildMonitoringBulk (opts) { /** * Perform a monitoring.bulk request + * Used by the monitoring features to send monitoring data. * https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html */ return function monitoringBulk (params, options, callback) { diff --git a/api/api/rollup.delete_job.js b/api/api/rollup.delete_job.js index 2b4c9ce85..befeedff0 100644 --- a/api/api/rollup.delete_job.js +++ b/api/api/rollup.delete_job.js @@ -21,6 +21,8 @@ function buildRollupDeleteJob (opts) { /** * Perform a rollup.delete_job request + * Deletes an existing rollup job. + * https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html */ return function rollupDeleteJob (params, options, callback) { options = options || {} diff --git a/api/api/rollup.get_jobs.js b/api/api/rollup.get_jobs.js index c38ea8919..57414ab06 100644 --- a/api/api/rollup.get_jobs.js +++ b/api/api/rollup.get_jobs.js @@ -21,6 +21,8 @@ function buildRollupGetJobs (opts) { /** * Perform a rollup.get_jobs request + * Retrieves the configuration, stats, and status of rollup jobs. + * https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html */ return function rollupGetJobs (params, options, callback) { options = options || {} diff --git a/api/api/rollup.get_rollup_caps.js b/api/api/rollup.get_rollup_caps.js index 8dd61d3f8..fd5a5fded 100644 --- a/api/api/rollup.get_rollup_caps.js +++ b/api/api/rollup.get_rollup_caps.js @@ -21,6 +21,8 @@ function buildRollupGetRollupCaps (opts) { /** * Perform a rollup.get_rollup_caps request + * Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + * https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html */ return function rollupGetRollupCaps (params, options, callback) { options = options || {} diff --git a/api/api/rollup.get_rollup_index_caps.js b/api/api/rollup.get_rollup_index_caps.js index f5a2d590b..2f127cfc3 100644 --- a/api/api/rollup.get_rollup_index_caps.js +++ b/api/api/rollup.get_rollup_index_caps.js @@ -21,6 +21,8 @@ function buildRollupGetRollupIndexCaps (opts) { /** * Perform a rollup.get_rollup_index_caps request + * Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). + * https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html */ return function rollupGetRollupIndexCaps (params, options, callback) { options = options || {} diff --git a/api/api/rollup.put_job.js b/api/api/rollup.put_job.js index fd9a7d2e1..ef68909fb 100644 --- a/api/api/rollup.put_job.js +++ b/api/api/rollup.put_job.js @@ -21,6 +21,8 @@ function buildRollupPutJob (opts) { /** * Perform a rollup.put_job request + * Creates a rollup job. + * https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html */ return function rollupPutJob (params, options, callback) { options = options || {} diff --git a/api/api/rollup.rollup_search.js b/api/api/rollup.rollup_search.js index d5e84e16c..4bd756434 100644 --- a/api/api/rollup.rollup_search.js +++ b/api/api/rollup.rollup_search.js @@ -23,6 +23,8 @@ function buildRollupRollupSearch (opts) { /** * Perform a rollup.rollup_search request + * Enables searching rolled-up data using the standard query DSL. + * https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html */ return function rollupRollupSearch (params, options, callback) { options = options || {} diff --git a/api/api/rollup.start_job.js b/api/api/rollup.start_job.js index e44805ad7..5fad665ba 100644 --- a/api/api/rollup.start_job.js +++ b/api/api/rollup.start_job.js @@ -21,6 +21,8 @@ function buildRollupStartJob (opts) { /** * Perform a rollup.start_job request + * Starts an existing, stopped rollup job. + * https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html */ return function rollupStartJob (params, options, callback) { options = options || {} diff --git a/api/api/rollup.stop_job.js b/api/api/rollup.stop_job.js index 8bcf7a781..727058e2b 100644 --- a/api/api/rollup.stop_job.js +++ b/api/api/rollup.stop_job.js @@ -23,6 +23,8 @@ function buildRollupStopJob (opts) { /** * Perform a rollup.stop_job request + * Stops an existing, started rollup job. + * https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html */ return function rollupStopJob (params, options, callback) { options = options || {} diff --git a/api/api/security.authenticate.js b/api/api/security.authenticate.js index fffb1b3bc..bd156f41f 100644 --- a/api/api/security.authenticate.js +++ b/api/api/security.authenticate.js @@ -21,6 +21,7 @@ function buildSecurityAuthenticate (opts) { /** * Perform a security.authenticate request + * Enables authentication as a user and retrieve information about the authenticated user. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html */ return function securityAuthenticate (params, options, callback) { diff --git a/api/api/security.change_password.js b/api/api/security.change_password.js index f05ae0cde..b71816c75 100644 --- a/api/api/security.change_password.js +++ b/api/api/security.change_password.js @@ -21,6 +21,7 @@ function buildSecurityChangePassword (opts) { /** * Perform a security.change_password request + * Changes the passwords of users in the native realm and built-in users. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html */ return function securityChangePassword (params, options, callback) { diff --git a/api/api/security.clear_cached_realms.js b/api/api/security.clear_cached_realms.js index 047752891..d06e2aa24 100644 --- a/api/api/security.clear_cached_realms.js +++ b/api/api/security.clear_cached_realms.js @@ -21,6 +21,7 @@ function buildSecurityClearCachedRealms (opts) { /** * Perform a security.clear_cached_realms request + * Evicts users from the user cache. Can completely clear the cache or evict specific users. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html */ return function securityClearCachedRealms (params, options, callback) { diff --git a/api/api/security.clear_cached_roles.js b/api/api/security.clear_cached_roles.js index bea3afe06..fb6497298 100644 --- a/api/api/security.clear_cached_roles.js +++ b/api/api/security.clear_cached_roles.js @@ -21,6 +21,7 @@ function buildSecurityClearCachedRoles (opts) { /** * Perform a security.clear_cached_roles request + * Evicts roles from the native role cache. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html */ return function securityClearCachedRoles (params, options, callback) { diff --git a/api/api/security.create_api_key.js b/api/api/security.create_api_key.js index a61a23d9d..d0ec816da 100644 --- a/api/api/security.create_api_key.js +++ b/api/api/security.create_api_key.js @@ -21,6 +21,7 @@ function buildSecurityCreateApiKey (opts) { /** * Perform a security.create_api_key request + * Creates an API key for access without requiring basic authentication. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html */ return function securityCreateApiKey (params, options, callback) { diff --git a/api/api/security.delete_privileges.js b/api/api/security.delete_privileges.js index a007bf197..89031c2b1 100644 --- a/api/api/security.delete_privileges.js +++ b/api/api/security.delete_privileges.js @@ -21,6 +21,7 @@ function buildSecurityDeletePrivileges (opts) { /** * Perform a security.delete_privileges request + * Removes application privileges. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html */ return function securityDeletePrivileges (params, options, callback) { diff --git a/api/api/security.delete_role.js b/api/api/security.delete_role.js index 30d755764..4dd113a6a 100644 --- a/api/api/security.delete_role.js +++ b/api/api/security.delete_role.js @@ -21,6 +21,7 @@ function buildSecurityDeleteRole (opts) { /** * Perform a security.delete_role request + * Removes roles in the native realm. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html */ return function securityDeleteRole (params, options, callback) { diff --git a/api/api/security.delete_role_mapping.js b/api/api/security.delete_role_mapping.js index 65b57e8e8..5edde79d3 100644 --- a/api/api/security.delete_role_mapping.js +++ b/api/api/security.delete_role_mapping.js @@ -21,6 +21,7 @@ function buildSecurityDeleteRoleMapping (opts) { /** * Perform a security.delete_role_mapping request + * Removes role mappings. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html */ return function securityDeleteRoleMapping (params, options, callback) { diff --git a/api/api/security.delete_user.js b/api/api/security.delete_user.js index abc7d9a00..007da3e8c 100644 --- a/api/api/security.delete_user.js +++ b/api/api/security.delete_user.js @@ -21,6 +21,7 @@ function buildSecurityDeleteUser (opts) { /** * Perform a security.delete_user request + * Deletes users from the native realm. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html */ return function securityDeleteUser (params, options, callback) { diff --git a/api/api/security.disable_user.js b/api/api/security.disable_user.js index 473155a91..b89afc916 100644 --- a/api/api/security.disable_user.js +++ b/api/api/security.disable_user.js @@ -21,6 +21,7 @@ function buildSecurityDisableUser (opts) { /** * Perform a security.disable_user request + * Disables users in the native realm. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html */ return function securityDisableUser (params, options, callback) { diff --git a/api/api/security.enable_user.js b/api/api/security.enable_user.js index b8604fc51..367590123 100644 --- a/api/api/security.enable_user.js +++ b/api/api/security.enable_user.js @@ -21,6 +21,7 @@ function buildSecurityEnableUser (opts) { /** * Perform a security.enable_user request + * Enables users in the native realm. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html */ return function securityEnableUser (params, options, callback) { diff --git a/api/api/security.get_api_key.js b/api/api/security.get_api_key.js index 80e21a104..7492f84e5 100644 --- a/api/api/security.get_api_key.js +++ b/api/api/security.get_api_key.js @@ -26,6 +26,7 @@ function buildSecurityGetApiKey (opts) { /** * Perform a security.get_api_key request + * Retrieves information for one or more API keys. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html */ return function securityGetApiKey (params, options, callback) { diff --git a/api/api/security.get_builtin_privileges.js b/api/api/security.get_builtin_privileges.js index dfa335006..15581bf4f 100644 --- a/api/api/security.get_builtin_privileges.js +++ b/api/api/security.get_builtin_privileges.js @@ -21,6 +21,7 @@ function buildSecurityGetBuiltinPrivileges (opts) { /** * Perform a security.get_builtin_privileges request + * Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html */ return function securityGetBuiltinPrivileges (params, options, callback) { diff --git a/api/api/security.get_privileges.js b/api/api/security.get_privileges.js index fc7320cbc..15a5a3a72 100644 --- a/api/api/security.get_privileges.js +++ b/api/api/security.get_privileges.js @@ -21,6 +21,7 @@ function buildSecurityGetPrivileges (opts) { /** * Perform a security.get_privileges request + * Retrieves application privileges. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html */ return function securityGetPrivileges (params, options, callback) { diff --git a/api/api/security.get_role.js b/api/api/security.get_role.js index 33a6299eb..e660c5b8a 100644 --- a/api/api/security.get_role.js +++ b/api/api/security.get_role.js @@ -21,6 +21,7 @@ function buildSecurityGetRole (opts) { /** * Perform a security.get_role request + * Retrieves roles in the native realm. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html */ return function securityGetRole (params, options, callback) { diff --git a/api/api/security.get_role_mapping.js b/api/api/security.get_role_mapping.js index cdb35ba4e..0a1768512 100644 --- a/api/api/security.get_role_mapping.js +++ b/api/api/security.get_role_mapping.js @@ -21,6 +21,7 @@ function buildSecurityGetRoleMapping (opts) { /** * Perform a security.get_role_mapping request + * Retrieves role mappings. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html */ return function securityGetRoleMapping (params, options, callback) { diff --git a/api/api/security.get_token.js b/api/api/security.get_token.js index 90c501341..066c9e6d0 100644 --- a/api/api/security.get_token.js +++ b/api/api/security.get_token.js @@ -21,6 +21,7 @@ function buildSecurityGetToken (opts) { /** * Perform a security.get_token request + * Creates a bearer token for access without requiring basic authentication. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html */ return function securityGetToken (params, options, callback) { diff --git a/api/api/security.get_user.js b/api/api/security.get_user.js index 8838b8919..40383949b 100644 --- a/api/api/security.get_user.js +++ b/api/api/security.get_user.js @@ -21,6 +21,7 @@ function buildSecurityGetUser (opts) { /** * Perform a security.get_user request + * Retrieves information about users in the native realm and built-in users. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html */ return function securityGetUser (params, options, callback) { diff --git a/api/api/security.get_user_privileges.js b/api/api/security.get_user_privileges.js index 8fcd17ac8..3ef3a9dc3 100644 --- a/api/api/security.get_user_privileges.js +++ b/api/api/security.get_user_privileges.js @@ -21,6 +21,7 @@ function buildSecurityGetUserPrivileges (opts) { /** * Perform a security.get_user_privileges request + * Retrieves application privileges. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html */ return function securityGetUserPrivileges (params, options, callback) { diff --git a/api/api/security.has_privileges.js b/api/api/security.has_privileges.js index 6de5e33b4..dc0f1d1d1 100644 --- a/api/api/security.has_privileges.js +++ b/api/api/security.has_privileges.js @@ -21,6 +21,7 @@ function buildSecurityHasPrivileges (opts) { /** * Perform a security.has_privileges request + * Determines whether the specified user has a specified list of privileges. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html */ return function securityHasPrivileges (params, options, callback) { diff --git a/api/api/security.invalidate_api_key.js b/api/api/security.invalidate_api_key.js index 62b01f8db..470704850 100644 --- a/api/api/security.invalidate_api_key.js +++ b/api/api/security.invalidate_api_key.js @@ -21,6 +21,7 @@ function buildSecurityInvalidateApiKey (opts) { /** * Perform a security.invalidate_api_key request + * Invalidates one or more API keys. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html */ return function securityInvalidateApiKey (params, options, callback) { diff --git a/api/api/security.invalidate_token.js b/api/api/security.invalidate_token.js index e89af0619..dc1bcf6ba 100644 --- a/api/api/security.invalidate_token.js +++ b/api/api/security.invalidate_token.js @@ -21,6 +21,7 @@ function buildSecurityInvalidateToken (opts) { /** * Perform a security.invalidate_token request + * Invalidates one or more access tokens or refresh tokens. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html */ return function securityInvalidateToken (params, options, callback) { diff --git a/api/api/security.put_privileges.js b/api/api/security.put_privileges.js index ca7e18919..83df2139c 100644 --- a/api/api/security.put_privileges.js +++ b/api/api/security.put_privileges.js @@ -21,6 +21,7 @@ function buildSecurityPutPrivileges (opts) { /** * Perform a security.put_privileges request + * Adds or updates application privileges. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html */ return function securityPutPrivileges (params, options, callback) { diff --git a/api/api/security.put_role.js b/api/api/security.put_role.js index 8cbff54e3..3de853456 100644 --- a/api/api/security.put_role.js +++ b/api/api/security.put_role.js @@ -21,6 +21,7 @@ function buildSecurityPutRole (opts) { /** * Perform a security.put_role request + * Adds and updates roles in the native realm. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html */ return function securityPutRole (params, options, callback) { diff --git a/api/api/security.put_role_mapping.js b/api/api/security.put_role_mapping.js index 42e3a5a87..e35a70657 100644 --- a/api/api/security.put_role_mapping.js +++ b/api/api/security.put_role_mapping.js @@ -21,6 +21,7 @@ function buildSecurityPutRoleMapping (opts) { /** * Perform a security.put_role_mapping request + * Creates and updates role mappings. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html */ return function securityPutRoleMapping (params, options, callback) { diff --git a/api/api/security.put_user.js b/api/api/security.put_user.js index a0f672e4e..398816fa9 100644 --- a/api/api/security.put_user.js +++ b/api/api/security.put_user.js @@ -21,6 +21,7 @@ function buildSecurityPutUser (opts) { /** * Perform a security.put_user request + * Adds and updates users in the native realm. These users are commonly referred to as native users. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html */ return function securityPutUser (params, options, callback) { diff --git a/api/api/slm.delete_lifecycle.js b/api/api/slm.delete_lifecycle.js index 06eee754e..6730ea66e 100644 --- a/api/api/slm.delete_lifecycle.js +++ b/api/api/slm.delete_lifecycle.js @@ -21,6 +21,7 @@ function buildSlmDeleteLifecycle (opts) { /** * Perform a slm.delete_lifecycle request + * Deletes an existing snapshot lifecycle policy. * https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html */ return function slmDeleteLifecycle (params, options, callback) { diff --git a/api/api/slm.execute_lifecycle.js b/api/api/slm.execute_lifecycle.js index a3431feb7..669e9470e 100644 --- a/api/api/slm.execute_lifecycle.js +++ b/api/api/slm.execute_lifecycle.js @@ -21,6 +21,7 @@ function buildSlmExecuteLifecycle (opts) { /** * Perform a slm.execute_lifecycle request + * Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. * https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html */ return function slmExecuteLifecycle (params, options, callback) { diff --git a/api/api/slm.execute_retention.js b/api/api/slm.execute_retention.js index f23dfb5e2..c8d8db99e 100644 --- a/api/api/slm.execute_retention.js +++ b/api/api/slm.execute_retention.js @@ -21,6 +21,7 @@ function buildSlmExecuteRetention (opts) { /** * Perform a slm.execute_retention request + * Deletes any snapshots that are expired according to the policy's retention rules. * https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html */ return function slmExecuteRetention (params, options, callback) { diff --git a/api/api/slm.get_lifecycle.js b/api/api/slm.get_lifecycle.js index 2d93aad89..22be108f6 100644 --- a/api/api/slm.get_lifecycle.js +++ b/api/api/slm.get_lifecycle.js @@ -21,6 +21,7 @@ function buildSlmGetLifecycle (opts) { /** * Perform a slm.get_lifecycle request + * Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. * https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html */ return function slmGetLifecycle (params, options, callback) { diff --git a/api/api/slm.get_stats.js b/api/api/slm.get_stats.js index 2d9a6a1d6..9937bf94f 100644 --- a/api/api/slm.get_stats.js +++ b/api/api/slm.get_stats.js @@ -21,6 +21,7 @@ function buildSlmGetStats (opts) { /** * Perform a slm.get_stats request + * Returns global and policy-level statistics about actions taken by snapshot lifecycle management. * https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html */ return function slmGetStats (params, options, callback) { diff --git a/api/api/slm.get_status.js b/api/api/slm.get_status.js index c9eb621e2..64a66cb88 100644 --- a/api/api/slm.get_status.js +++ b/api/api/slm.get_status.js @@ -21,6 +21,7 @@ function buildSlmGetStatus (opts) { /** * Perform a slm.get_status request + * Retrieves the status of snapshot lifecycle management (SLM). * https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html */ return function slmGetStatus (params, options, callback) { diff --git a/api/api/slm.put_lifecycle.js b/api/api/slm.put_lifecycle.js index c8091a7dc..47d4e6de3 100644 --- a/api/api/slm.put_lifecycle.js +++ b/api/api/slm.put_lifecycle.js @@ -21,6 +21,7 @@ function buildSlmPutLifecycle (opts) { /** * Perform a slm.put_lifecycle request + * Creates or updates a snapshot lifecycle policy. * https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html */ return function slmPutLifecycle (params, options, callback) { diff --git a/api/api/slm.start.js b/api/api/slm.start.js index 649165320..137d0c1c9 100644 --- a/api/api/slm.start.js +++ b/api/api/slm.start.js @@ -21,6 +21,7 @@ function buildSlmStart (opts) { /** * Perform a slm.start request + * Turns on snapshot lifecycle management (SLM). * https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html */ return function slmStart (params, options, callback) { diff --git a/api/api/slm.stop.js b/api/api/slm.stop.js index 8e150400f..32ccb37a0 100644 --- a/api/api/slm.stop.js +++ b/api/api/slm.stop.js @@ -21,6 +21,7 @@ function buildSlmStop (opts) { /** * Perform a slm.stop request + * Turns off snapshot lifecycle management (SLM). * https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html */ return function slmStop (params, options, callback) { diff --git a/api/api/sql.query.js b/api/api/sql.query.js index b37ef6b27..5354b8684 100644 --- a/api/api/sql.query.js +++ b/api/api/sql.query.js @@ -21,7 +21,7 @@ function buildSqlQuery (opts) { /** * Perform a sql.query request - * Executes an SQL request + * Executes a SQL request * https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-overview.html */ return function sqlQuery (params, options, callback) { diff --git a/api/api/ssl.certificates.js b/api/api/ssl.certificates.js index d9fe0e188..beef26f5f 100644 --- a/api/api/ssl.certificates.js +++ b/api/api/ssl.certificates.js @@ -21,6 +21,7 @@ function buildSslCertificates (opts) { /** * Perform a ssl.certificates request + * Retrieves information about the X.509 certificates used to encrypt communications in the cluster. * https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html */ return function sslCertificates (params, options, callback) { diff --git a/api/api/tasks.cancel.js b/api/api/tasks.cancel.js index 51b284c47..03700b092 100644 --- a/api/api/tasks.cancel.js +++ b/api/api/tasks.cancel.js @@ -15,6 +15,7 @@ function buildTasksCancel (opts) { 'nodes', 'actions', 'parent_task_id', + 'wait_for_completion', 'pretty', 'human', 'error_trace', @@ -24,6 +25,7 @@ function buildTasksCancel (opts) { const snakeCase = { parentTaskId: 'parent_task_id', + waitForCompletion: 'wait_for_completion', errorTrace: 'error_trace', filterPath: 'filter_path' } diff --git a/api/api/transform.delete_transform.js b/api/api/transform.delete_transform.js index 043e3d13a..6d76bfe56 100644 --- a/api/api/transform.delete_transform.js +++ b/api/api/transform.delete_transform.js @@ -21,6 +21,7 @@ function buildTransformDeleteTransform (opts) { /** * Perform a transform.delete_transform request + * Deletes an existing transform. * https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html */ return function transformDeleteTransform (params, options, callback) { diff --git a/api/api/transform.get_transform.js b/api/api/transform.get_transform.js index 643debd27..4fc5fa0e4 100644 --- a/api/api/transform.get_transform.js +++ b/api/api/transform.get_transform.js @@ -23,6 +23,7 @@ function buildTransformGetTransform (opts) { /** * Perform a transform.get_transform request + * Retrieves configuration information for transforms. * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html */ return function transformGetTransform (params, options, callback) { diff --git a/api/api/transform.get_transform_stats.js b/api/api/transform.get_transform_stats.js index 7dc8fa140..d139d9e00 100644 --- a/api/api/transform.get_transform_stats.js +++ b/api/api/transform.get_transform_stats.js @@ -23,6 +23,7 @@ function buildTransformGetTransformStats (opts) { /** * Perform a transform.get_transform_stats request + * Retrieves usage information for transforms. * https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html */ return function transformGetTransformStats (params, options, callback) { diff --git a/api/api/transform.preview_transform.js b/api/api/transform.preview_transform.js index 78333d69f..73aadb2c2 100644 --- a/api/api/transform.preview_transform.js +++ b/api/api/transform.preview_transform.js @@ -21,6 +21,7 @@ function buildTransformPreviewTransform (opts) { /** * Perform a transform.preview_transform request + * Previews a transform. * https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html */ return function transformPreviewTransform (params, options, callback) { diff --git a/api/api/transform.put_transform.js b/api/api/transform.put_transform.js index 4832ea689..578f1c0b3 100644 --- a/api/api/transform.put_transform.js +++ b/api/api/transform.put_transform.js @@ -21,6 +21,7 @@ function buildTransformPutTransform (opts) { /** * Perform a transform.put_transform request + * Instantiates a transform. * https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html */ return function transformPutTransform (params, options, callback) { diff --git a/api/api/transform.start_transform.js b/api/api/transform.start_transform.js index 8482d4dd6..b06f6a793 100644 --- a/api/api/transform.start_transform.js +++ b/api/api/transform.start_transform.js @@ -21,6 +21,7 @@ function buildTransformStartTransform (opts) { /** * Perform a transform.start_transform request + * Starts one or more transforms. * https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html */ return function transformStartTransform (params, options, callback) { diff --git a/api/api/transform.stop_transform.js b/api/api/transform.stop_transform.js index eed82e91a..be60db461 100644 --- a/api/api/transform.stop_transform.js +++ b/api/api/transform.stop_transform.js @@ -27,6 +27,7 @@ function buildTransformStopTransform (opts) { /** * Perform a transform.stop_transform request + * Stops one or more transforms. * https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html */ return function transformStopTransform (params, options, callback) { diff --git a/api/api/transform.update_transform.js b/api/api/transform.update_transform.js index d8623e7a9..eaa9404ae 100644 --- a/api/api/transform.update_transform.js +++ b/api/api/transform.update_transform.js @@ -21,6 +21,7 @@ function buildTransformUpdateTransform (opts) { /** * Perform a transform.update_transform request + * Updates certain properties of a transform. * https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html */ return function transformUpdateTransform (params, options, callback) { diff --git a/api/api/watcher.ack_watch.js b/api/api/watcher.ack_watch.js index f84399b1d..ea399d928 100644 --- a/api/api/watcher.ack_watch.js +++ b/api/api/watcher.ack_watch.js @@ -21,6 +21,7 @@ function buildWatcherAckWatch (opts) { /** * Perform a watcher.ack_watch request + * Acknowledges a watch, manually throttling the execution of the watch's actions. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html */ return function watcherAckWatch (params, options, callback) { diff --git a/api/api/watcher.activate_watch.js b/api/api/watcher.activate_watch.js index 328b013c2..f78edec85 100644 --- a/api/api/watcher.activate_watch.js +++ b/api/api/watcher.activate_watch.js @@ -21,6 +21,7 @@ function buildWatcherActivateWatch (opts) { /** * Perform a watcher.activate_watch request + * Activates a currently inactive watch. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html */ return function watcherActivateWatch (params, options, callback) { diff --git a/api/api/watcher.deactivate_watch.js b/api/api/watcher.deactivate_watch.js index 63ee8ce57..add97ef75 100644 --- a/api/api/watcher.deactivate_watch.js +++ b/api/api/watcher.deactivate_watch.js @@ -21,6 +21,7 @@ function buildWatcherDeactivateWatch (opts) { /** * Perform a watcher.deactivate_watch request + * Deactivates a currently active watch. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html */ return function watcherDeactivateWatch (params, options, callback) { diff --git a/api/api/watcher.delete_watch.js b/api/api/watcher.delete_watch.js index c76a13c5e..544480b14 100644 --- a/api/api/watcher.delete_watch.js +++ b/api/api/watcher.delete_watch.js @@ -21,6 +21,7 @@ function buildWatcherDeleteWatch (opts) { /** * Perform a watcher.delete_watch request + * Removes a watch from Watcher. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html */ return function watcherDeleteWatch (params, options, callback) { diff --git a/api/api/watcher.execute_watch.js b/api/api/watcher.execute_watch.js index ffd29db1c..62bf13a11 100644 --- a/api/api/watcher.execute_watch.js +++ b/api/api/watcher.execute_watch.js @@ -21,6 +21,7 @@ function buildWatcherExecuteWatch (opts) { /** * Perform a watcher.execute_watch request + * Forces the execution of a stored watch. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html */ return function watcherExecuteWatch (params, options, callback) { diff --git a/api/api/watcher.get_watch.js b/api/api/watcher.get_watch.js index dc267a23d..61e693964 100644 --- a/api/api/watcher.get_watch.js +++ b/api/api/watcher.get_watch.js @@ -21,6 +21,7 @@ function buildWatcherGetWatch (opts) { /** * Perform a watcher.get_watch request + * Retrieves a watch by its ID. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html */ return function watcherGetWatch (params, options, callback) { diff --git a/api/api/watcher.put_watch.js b/api/api/watcher.put_watch.js index 494a26fc9..1a60b2d4b 100644 --- a/api/api/watcher.put_watch.js +++ b/api/api/watcher.put_watch.js @@ -25,6 +25,7 @@ function buildWatcherPutWatch (opts) { /** * Perform a watcher.put_watch request + * Creates a new watch, or updates an existing one. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html */ return function watcherPutWatch (params, options, callback) { diff --git a/api/api/watcher.start.js b/api/api/watcher.start.js index ae1443060..c9e3b9047 100644 --- a/api/api/watcher.start.js +++ b/api/api/watcher.start.js @@ -21,6 +21,7 @@ function buildWatcherStart (opts) { /** * Perform a watcher.start request + * Starts Watcher if it is not already running. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html */ return function watcherStart (params, options, callback) { diff --git a/api/api/watcher.stats.js b/api/api/watcher.stats.js index eb60b926d..647b733f6 100644 --- a/api/api/watcher.stats.js +++ b/api/api/watcher.stats.js @@ -22,6 +22,7 @@ function buildWatcherStats (opts) { /** * Perform a watcher.stats request + * Retrieves the current Watcher metrics. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html */ return function watcherStats (params, options, callback) { diff --git a/api/api/watcher.stop.js b/api/api/watcher.stop.js index b76fb923d..ac5a97d88 100644 --- a/api/api/watcher.stop.js +++ b/api/api/watcher.stop.js @@ -21,6 +21,7 @@ function buildWatcherStop (opts) { /** * Perform a watcher.stop request + * Stops Watcher if it is running. * https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html */ return function watcherStop (params, options, callback) { diff --git a/api/api/xpack.info.js b/api/api/xpack.info.js index fe155ee6d..2be59b4a9 100644 --- a/api/api/xpack.info.js +++ b/api/api/xpack.info.js @@ -21,6 +21,7 @@ function buildXpackInfo (opts) { /** * Perform a xpack.info request + * Retrieves information about the installed X-Pack features. * https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html */ return function xpackInfo (params, options, callback) { diff --git a/api/api/xpack.usage.js b/api/api/xpack.usage.js index 0e6d3b0c8..bebe72ee5 100644 --- a/api/api/xpack.usage.js +++ b/api/api/xpack.usage.js @@ -21,6 +21,7 @@ function buildXpackUsage (opts) { /** * Perform a xpack.usage request + * Retrieves usage information about the installed X-Pack features. * https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html */ return function xpackUsage (params, options, callback) { diff --git a/api/index.js b/api/index.js index 1d7db0097..c22613513 100644 --- a/api/index.js +++ b/api/index.js @@ -28,7 +28,9 @@ function ESAPI (opts) { }, autoscaling: { get_autoscaling_decision: lazyLoad('autoscaling.get_autoscaling_decision', opts), - getAutoscalingDecision: lazyLoad('autoscaling.get_autoscaling_decision', opts) + getAutoscalingDecision: lazyLoad('autoscaling.get_autoscaling_decision', opts), + put_autoscaling_policy: lazyLoad('autoscaling.put_autoscaling_policy', opts), + putAutoscalingPolicy: lazyLoad('autoscaling.put_autoscaling_policy', opts) }, bulk: lazyLoad('bulk', opts), cat: { diff --git a/api/requestParams.d.ts b/api/requestParams.d.ts index 43fb5c82a..9e68e8090 100644 --- a/api/requestParams.d.ts +++ b/api/requestParams.d.ts @@ -77,7 +77,7 @@ export interface CatHealth extends Generic { h?: string | string[]; help?: boolean; s?: string | string[]; - time?: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)'; + time?: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos'; ts?: boolean; v?: boolean; } @@ -1195,11 +1195,10 @@ export interface SearchTemplate extends Generic { body: T; } -export interface SnapshotCleanupRepository extends Generic { +export interface SnapshotCleanupRepository extends Generic { repository: string; master_timeout?: string; timeout?: string; - body?: T; } export interface SnapshotCreate extends Generic { @@ -1270,6 +1269,7 @@ export interface TasksCancel extends Generic { nodes?: string | string[]; actions?: string | string[]; parent_task_id?: string; + wait_for_completion?: boolean; } export interface TasksGet extends Generic { @@ -1402,7 +1402,7 @@ export interface AsyncSearchSubmit extends Generic { ignore_unavailable?: boolean; ignore_throttled?: boolean; allow_no_indices?: boolean; - expand_wildcards?: 'open' | 'closed' | 'none' | 'all'; + expand_wildcards?: 'open' | 'closed' | 'hidden' | 'none' | 'all'; lenient?: boolean; preference?: string; q?: string; @@ -1433,6 +1433,11 @@ export interface AsyncSearchSubmit extends Generic { export interface AutoscalingGetAutoscalingDecision extends Generic { } +export interface AutoscalingPutAutoscalingPolicy extends Generic { + name: string; + body: T; +} + export interface CatMlDataFrameAnalytics extends Generic { id?: string; allow_no_match?: boolean; @@ -1441,7 +1446,7 @@ export interface CatMlDataFrameAnalytics extends Generic { h?: string | string[]; help?: boolean; s?: string | string[]; - time?: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)'; + time?: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos'; v?: boolean; } @@ -1452,7 +1457,7 @@ export interface CatMlDatafeeds extends Generic { h?: string | string[]; help?: boolean; s?: string | string[]; - time?: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)'; + time?: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos'; v?: boolean; } @@ -1464,7 +1469,7 @@ export interface CatMlJobs extends Generic { h?: string | string[]; help?: boolean; s?: string | string[]; - time?: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)'; + time?: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos'; v?: boolean; } @@ -1478,7 +1483,7 @@ export interface CatMlTrainedModels extends Generic { h?: string | string[]; help?: boolean; s?: string | string[]; - time?: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)'; + time?: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos'; v?: boolean; } @@ -1491,7 +1496,7 @@ export interface CatTransform extends Generic { h?: string | string[]; help?: boolean; s?: string | string[]; - time?: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)'; + time?: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos'; v?: boolean; } @@ -1678,7 +1683,7 @@ export interface IndicesFreeze extends Generic { master_timeout?: string; ignore_unavailable?: boolean; allow_no_indices?: boolean; - expand_wildcards?: 'open' | 'closed' | 'none' | 'all'; + expand_wildcards?: 'open' | 'closed' | 'hidden' | 'none' | 'all'; wait_for_active_shards?: string; } @@ -1686,7 +1691,7 @@ export interface IndicesReloadSearchAnalyzers extends Generic { index: string | string[]; ignore_unavailable?: boolean; allow_no_indices?: boolean; - expand_wildcards?: 'open' | 'closed' | 'none' | 'all'; + expand_wildcards?: 'open' | 'closed' | 'hidden' | 'none' | 'all'; } export interface IndicesUnfreeze extends Generic { @@ -1695,7 +1700,7 @@ export interface IndicesUnfreeze extends Generic { master_timeout?: string; ignore_unavailable?: boolean; allow_no_indices?: boolean; - expand_wildcards?: 'open' | 'closed' | 'none' | 'all'; + expand_wildcards?: 'open' | 'closed' | 'hidden' | 'none' | 'all'; wait_for_active_shards?: string; } diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 226eb0707..2cc6a41aa 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -330,7 +330,7 @@ client.cat.health({ h: string | string[], help: boolean, s: string | string[], - time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)', + time: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos', ts: boolean, v: boolean }) @@ -351,7 +351,7 @@ link:{ref}/cat-health.html[Documentation] + |`string \| string[]` - Comma-separated list of column names or column aliases to sort by |`time` -|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values +|`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values |`ts` |`boolean` - Set to false to disable timestamping + @@ -1759,7 +1759,8 @@ _Default:_ `1m` |`string` - Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) |`scroll_size` or `scrollSize` -|`number` - Size on the scroll request powering the delete by query +|`number` - Size on the scroll request powering the delete by query + +_Default:_ `100` |`wait_for_completion` or `waitForCompletion` |`boolean` - Should the request should block until the delete by query is complete. + @@ -2141,6 +2142,7 @@ link:{ref}/modules-scripting.html[Documentation] + ---- client.getScriptContext() ---- +link:https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html[Documentation] + === getScriptLanguages @@ -2149,6 +2151,7 @@ client.getScriptContext() ---- client.getScriptLanguages() ---- +link:{ref}/modules-scripting.html[Documentation] + === getSource @@ -3055,7 +3058,7 @@ link:{ref}/indices-get-settings.html[Documentation] + |`expand_wildcards` or `expandWildcards` |`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + -_Default:_ `open,closed` +_Default:_ `all` |`flat_settings` or `flatSettings` |`boolean` - Return settings in flat format (default: false) @@ -4818,8 +4821,7 @@ _Default:_ `true` client.snapshot.cleanupRepository({ repository: string, master_timeout: string, - timeout: string, - body: object + timeout: string }) ---- link:{ref}/modules-snapshots.html[Documentation] + @@ -4834,9 +4836,6 @@ link:{ref}/modules-snapshots.html[Documentation] + |`timeout` |`string` - Explicit operation timeout -|`body` -|`object` - undefined - |=== === snapshot.create @@ -5099,7 +5098,8 @@ client.tasks.cancel({ task_id: string, nodes: string | string[], actions: string | string[], - parent_task_id: string + parent_task_id: string, + wait_for_completion: boolean }) ---- link:{ref}/tasks.html[Documentation] + @@ -5117,6 +5117,9 @@ link:{ref}/tasks.html[Documentation] + |`parent_task_id` or `parentTaskId` |`string` - Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all. +|`wait_for_completion` or `waitForCompletion` +|`boolean` - Should the request block until the cancellation of the task and its child tasks is completed. Defaults to false + |=== === tasks.get @@ -5476,7 +5479,8 @@ _Default:_ `1m` |`string` - Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) |`scroll_size` or `scrollSize` -|`number` - Size on the scroll request powering the update by query +|`number` - Size on the scroll request powering the update by query + +_Default:_ `100` |`wait_for_completion` or `waitForCompletion` |`boolean` - Should the request should block until the update by query operation is complete. + @@ -5580,7 +5584,7 @@ client.asyncSearch.submit({ ignore_unavailable: boolean, ignore_throttled: boolean, allow_no_indices: boolean, - expand_wildcards: 'open' | 'closed' | 'none' | 'all', + expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all', lenient: boolean, preference: string, q: string, @@ -5667,7 +5671,7 @@ _Default:_ `OR` |`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) |`expand_wildcards` or `expandWildcards` -|`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + +|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + _Default:_ `open` |`lenient` @@ -5759,6 +5763,26 @@ client.autoscaling.getAutoscalingDecision() link:{ref}/autoscaling-get-autoscaling-decision.html[Documentation] + +=== autoscaling.putAutoscalingPolicy +*Stability:* experimental +[source,ts] +---- +client.autoscaling.putAutoscalingPolicy({ + name: string, + body: object +}) +---- +link:{ref}/autoscaling-put-autoscaling-policy.html[Documentation] + +[cols=2*] +|=== +|`name` +|`string` - the name of the autoscaling policy + +|`body` +|`object` - the specification of the autoscaling policy + +|=== + === cat.mlDataFrameAnalytics [source,ts] @@ -5771,7 +5795,7 @@ client.cat.mlDataFrameAnalytics({ h: string | string[], help: boolean, s: string | string[], - time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)', + time: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos', v: boolean }) ---- @@ -5800,7 +5824,7 @@ link:{ref}/cat-dfanalytics.html[Documentation] + |`string \| string[]` - Comma-separated list of column names or column aliases to sort by |`time` -|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values +|`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values |`v` |`boolean` - Verbose mode. Display column headers @@ -5818,7 +5842,7 @@ client.cat.mlDatafeeds({ h: string | string[], help: boolean, s: string | string[], - time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)', + time: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos', v: boolean }) ---- @@ -5844,7 +5868,7 @@ link:{ref}/cat-datafeeds.html[Documentation] + |`string \| string[]` - Comma-separated list of column names or column aliases to sort by |`time` -|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values +|`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values |`v` |`boolean` - Verbose mode. Display column headers @@ -5863,7 +5887,7 @@ client.cat.mlJobs({ h: string | string[], help: boolean, s: string | string[], - time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)', + time: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos', v: boolean }) ---- @@ -5892,7 +5916,7 @@ link:{ref}/cat-anomaly-detectors.html[Documentation] + |`string \| string[]` - Comma-separated list of column names or column aliases to sort by |`time` -|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values +|`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values |`v` |`boolean` - Verbose mode. Display column headers @@ -5913,7 +5937,7 @@ client.cat.mlTrainedModels({ h: string | string[], help: boolean, s: string | string[], - time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)', + time: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos', v: boolean }) ---- @@ -5950,7 +5974,7 @@ _Default:_ `100` |`string \| string[]` - Comma-separated list of column names or column aliases to sort by |`time` -|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values +|`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values |`v` |`boolean` - Verbose mode. Display column headers @@ -5970,7 +5994,7 @@ client.cat.transform({ h: string | string[], help: boolean, s: string | string[], - time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)', + time: 'd' | 'h' | 'm' | 's' | 'ms' | 'micros' | 'nanos', v: boolean }) ---- @@ -6002,7 +6026,7 @@ link:{ref}/cat-transforms.html[Documentation] + |`string \| string[]` - Comma-separated list of column names or column aliases to sort by |`time` -|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values +|`'d' \| 'h' \| 'm' \| 's' \| 'ms' \| 'micros' \| 'nanos'` - The unit in which to display time values |`v` |`boolean` - Verbose mode. Display column headers @@ -6714,7 +6738,7 @@ client.indices.freeze({ master_timeout: string, ignore_unavailable: boolean, allow_no_indices: boolean, - expand_wildcards: 'open' | 'closed' | 'none' | 'all', + expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all', wait_for_active_shards: string }) ---- @@ -6737,7 +6761,7 @@ link:{ref}/freeze-index-api.html[Documentation] + |`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) |`expand_wildcards` or `expandWildcards` -|`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + +|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + _Default:_ `closed` |`wait_for_active_shards` or `waitForActiveShards` @@ -6753,7 +6777,7 @@ client.indices.reloadSearchAnalyzers({ index: string | string[], ignore_unavailable: boolean, allow_no_indices: boolean, - expand_wildcards: 'open' | 'closed' | 'none' | 'all' + expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all' }) ---- link:{ref}/indices-reload-analyzers.html[Documentation] + @@ -6769,7 +6793,7 @@ link:{ref}/indices-reload-analyzers.html[Documentation] + |`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) |`expand_wildcards` or `expandWildcards` -|`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + +|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + _Default:_ `open` |=== @@ -6784,11 +6808,11 @@ client.indices.unfreeze({ master_timeout: string, ignore_unavailable: boolean, allow_no_indices: boolean, - expand_wildcards: 'open' | 'closed' | 'none' | 'all', + expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all', wait_for_active_shards: string }) ---- -link:{ref}/freeze-index-api.html[Documentation] + +link:{ref}/unfreeze-index-api.html[Documentation] + [cols=2*] |=== |`index` @@ -6807,7 +6831,7 @@ link:{ref}/freeze-index-api.html[Documentation] + |`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) |`expand_wildcards` or `expandWildcards` -|`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + +|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + _Default:_ `closed` |`wait_for_active_shards` or `waitForActiveShards` @@ -6976,6 +7000,7 @@ client.ml.deleteCalendar({ calendar_id: string }) ---- +link:{ref}/ml-delete-calendar.html[Documentation] + [cols=2*] |=== |`calendar_id` or `calendarId` @@ -6992,6 +7017,7 @@ client.ml.deleteCalendarEvent({ event_id: string }) ---- +link:{ref}/ml-delete-calendar-event.html[Documentation] + [cols=2*] |=== |`calendar_id` or `calendarId` @@ -7011,6 +7037,7 @@ client.ml.deleteCalendarJob({ job_id: string }) ---- +link:{ref}/ml-delete-calendar-job.html[Documentation] + [cols=2*] |=== |`calendar_id` or `calendarId` @@ -7067,6 +7094,7 @@ link:{ref}/ml-delete-datafeed.html[Documentation] + ---- client.ml.deleteExpiredData() ---- +link:{ref}/ml-delete-expired-data.html[Documentation] + === ml.deleteFilter @@ -7077,6 +7105,7 @@ client.ml.deleteFilter({ filter_id: string }) ---- +link:{ref}/ml-delete-filter.html[Documentation] + [cols=2*] |=== |`filter_id` or `filterId` @@ -7181,6 +7210,7 @@ client.ml.estimateModelMemory({ body: object }) ---- +link:{ref}/ml-apis.html[Documentation] + [cols=2*] |=== |`body` @@ -7349,6 +7379,7 @@ client.ml.forecast({ expires_in: string }) ---- +link:{ref}/ml-forecast.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7435,6 +7466,7 @@ client.ml.getCalendarEvents({ size: number }) ---- +link:{ref}/ml-get-calendar-event.html[Documentation] + [cols=2*] |=== |`calendar_id` or `calendarId` @@ -7468,6 +7500,7 @@ client.ml.getCalendars({ body: object }) ---- +link:{ref}/ml-get-calendar.html[Documentation] + [cols=2*] |=== |`calendar_id` or `calendarId` @@ -7626,6 +7659,7 @@ client.ml.getFilters({ size: number }) ---- +link:{ref}/ml-get-filter.html[Documentation] + [cols=2*] |=== |`filter_id` or `filterId` @@ -7660,7 +7694,7 @@ link:{ref}/ml-get-influencer.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` -|`string` - undefined +|`string` - Identifier for the anomaly detection job |`exclude_interim` or `excludeInterim` |`boolean` - Exclude interim results @@ -7848,7 +7882,7 @@ link:{ref}/ml-get-record.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` -|`string` - undefined +|`string` - The ID of the job |`exclude_interim` or `excludeInterim` |`boolean` - Exclude interim results @@ -7866,7 +7900,7 @@ link:{ref}/ml-get-record.html[Documentation] + |`string` - End time filter for records |`record_score` or `recordScore` -|`number` - undefined +|`number` - Returns records with anomaly scores greater or equal than this value |`sort` |`string` - Sort records by a particular field @@ -7958,6 +7992,7 @@ _Default:_ `100` ---- client.ml.info() ---- +link:{ref}/get-ml-info.html[Documentation] + === ml.openJob @@ -7985,6 +8020,7 @@ client.ml.postCalendarEvents({ body: object }) ---- +link:{ref}/ml-post-calendar-event.html[Documentation] + [cols=2*] |=== |`calendar_id` or `calendarId` @@ -8048,6 +8084,7 @@ client.ml.putCalendar({ body: object }) ---- +link:{ref}/ml-put-calendar.html[Documentation] + [cols=2*] |=== |`calendar_id` or `calendarId` @@ -8067,6 +8104,7 @@ client.ml.putCalendarJob({ job_id: string }) ---- +link:{ref}/ml-put-calendar-job.html[Documentation] + [cols=2*] |=== |`calendar_id` or `calendarId` @@ -8142,6 +8180,7 @@ client.ml.putFilter({ body: object }) ---- +link:{ref}/ml-put-filter.html[Documentation] + [cols=2*] |=== |`filter_id` or `filterId` @@ -8181,7 +8220,7 @@ client.ml.putTrainedModel({ body: object }) ---- -link:TODO[Documentation] + +link:{ref}/put-inference.html[Documentation] + [cols=2*] |=== |`model_id` or `modelId` @@ -8401,6 +8440,7 @@ client.ml.updateFilter({ body: object }) ---- +link:{ref}/ml-update-filter.html[Documentation] + [cols=2*] |=== |`filter_id` or `filterId` @@ -8527,6 +8567,7 @@ client.rollup.deleteJob({ id: string }) ---- +link:{ref}/rollup-delete-job.html[Documentation] + [cols=2*] |=== |`id` @@ -8542,6 +8583,7 @@ client.rollup.getJobs({ id: string }) ---- +link:{ref}/rollup-get-job.html[Documentation] + [cols=2*] |=== |`id` @@ -8557,6 +8599,7 @@ client.rollup.getRollupCaps({ id: string }) ---- +link:{ref}/rollup-get-rollup-caps.html[Documentation] + [cols=2*] |=== |`id` @@ -8572,6 +8615,7 @@ client.rollup.getRollupIndexCaps({ index: string }) ---- +link:{ref}/rollup-get-rollup-index-caps.html[Documentation] + [cols=2*] |=== |`index` @@ -8588,6 +8632,7 @@ client.rollup.putJob({ body: object }) ---- +link:{ref}/rollup-put-job.html[Documentation] + [cols=2*] |=== |`id` @@ -8610,6 +8655,7 @@ client.rollup.rollupSearch({ body: object }) ---- +link:{ref}/rollup-search.html[Documentation] + [cols=2*] |=== |`index` @@ -8639,6 +8685,7 @@ client.rollup.startJob({ id: string }) ---- +link:{ref}/rollup-start-job.html[Documentation] + [cols=2*] |=== |`id` @@ -8656,6 +8703,7 @@ client.rollup.stopJob({ timeout: string }) ---- +link:{ref}/rollup-stop-job.html[Documentation] + [cols=2*] |=== |`id` diff --git a/index.d.ts b/index.d.ts index 95c6806bd..4650e1bc7 100644 --- a/index.d.ts +++ b/index.d.ts @@ -149,6 +149,14 @@ declare class Client extends EventEmitter { getAutoscalingDecision(callback: callbackFn): TransportRequestCallback getAutoscalingDecision(params: RequestParams.AutoscalingGetAutoscalingDecision, callback: callbackFn): TransportRequestCallback getAutoscalingDecision(params: RequestParams.AutoscalingGetAutoscalingDecision, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + put_autoscaling_policy(params?: RequestParams.AutoscalingPutAutoscalingPolicy, options?: TransportRequestOptions): Promise> + put_autoscaling_policy(callback: callbackFn): TransportRequestCallback + put_autoscaling_policy(params: RequestParams.AutoscalingPutAutoscalingPolicy, callback: callbackFn): TransportRequestCallback + put_autoscaling_policy(params: RequestParams.AutoscalingPutAutoscalingPolicy, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + putAutoscalingPolicy(params?: RequestParams.AutoscalingPutAutoscalingPolicy, options?: TransportRequestOptions): Promise> + putAutoscalingPolicy(callback: callbackFn): TransportRequestCallback + putAutoscalingPolicy(params: RequestParams.AutoscalingPutAutoscalingPolicy, callback: callbackFn): TransportRequestCallback + putAutoscalingPolicy(params: RequestParams.AutoscalingPutAutoscalingPolicy, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback } bulk(params?: RequestParams.Bulk, options?: TransportRequestOptions): Promise> bulk(callback: callbackFn): TransportRequestCallback @@ -2129,14 +2137,14 @@ declare class Client extends EventEmitter { stop(params: RequestParams.SlmStop, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback } snapshot: { - cleanup_repository(params?: RequestParams.SnapshotCleanupRepository, options?: TransportRequestOptions): Promise> - cleanup_repository(callback: callbackFn): TransportRequestCallback - cleanup_repository(params: RequestParams.SnapshotCleanupRepository, callback: callbackFn): TransportRequestCallback - cleanup_repository(params: RequestParams.SnapshotCleanupRepository, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback - cleanupRepository(params?: RequestParams.SnapshotCleanupRepository, options?: TransportRequestOptions): Promise> - cleanupRepository(callback: callbackFn): TransportRequestCallback - cleanupRepository(params: RequestParams.SnapshotCleanupRepository, callback: callbackFn): TransportRequestCallback - cleanupRepository(params: RequestParams.SnapshotCleanupRepository, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + cleanup_repository(params?: RequestParams.SnapshotCleanupRepository, options?: TransportRequestOptions): Promise> + cleanup_repository(callback: callbackFn): TransportRequestCallback + cleanup_repository(params: RequestParams.SnapshotCleanupRepository, callback: callbackFn): TransportRequestCallback + cleanup_repository(params: RequestParams.SnapshotCleanupRepository, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + cleanupRepository(params?: RequestParams.SnapshotCleanupRepository, options?: TransportRequestOptions): Promise> + cleanupRepository(callback: callbackFn): TransportRequestCallback + cleanupRepository(params: RequestParams.SnapshotCleanupRepository, callback: callbackFn): TransportRequestCallback + cleanupRepository(params: RequestParams.SnapshotCleanupRepository, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback create(params?: RequestParams.SnapshotCreate, options?: TransportRequestOptions): Promise> create(callback: callbackFn): TransportRequestCallback create(params: RequestParams.SnapshotCreate, callback: callbackFn): TransportRequestCallback