From e86d38087e8c774cdeadd11b083c5b82be6d3b84 Mon Sep 17 00:00:00 2001 From: delvedor Date: Tue, 1 Sep 2020 14:09:43 +0200 Subject: [PATCH] API generation --- api/api/cat.ml_datafeeds.js | 2 + api/api/cat.ml_jobs.js | 2 + api/api/close_point_in_time.js | 87 ++++++++++++++++ api/api/indices.add_block.js | 2 +- api/api/indices.create_data_stream.js | 2 +- api/api/indices.resolve_index.js | 2 +- api/api/ml.close_job.js | 2 + api/api/ml.get_datafeed_stats.js | 2 + api/api/ml.get_datafeeds.js | 2 + api/api/ml.get_job_stats.js | 2 + api/api/ml.get_jobs.js | 2 + api/api/ml.get_overall_buckets.js | 2 + api/api/ml.stop_datafeed.js | 2 + api/api/open_point_in_time.js | 98 ++++++++++++++++++ api/index.js | 4 + api/kibana.d.ts | 6 +- api/requestParams.d.ts | 28 ++++- docs/reference.asciidoc | 143 ++++++++++++++++++++++---- index.d.ts | 48 ++++++--- 19 files changed, 396 insertions(+), 42 deletions(-) create mode 100644 api/api/close_point_in_time.js create mode 100644 api/api/open_point_in_time.js diff --git a/api/api/cat.ml_datafeeds.js b/api/api/cat.ml_datafeeds.js index 5d10b0c7f..4475a1d77 100644 --- a/api/api/cat.ml_datafeeds.js +++ b/api/api/cat.ml_datafeeds.js @@ -27,6 +27,7 @@ function buildCatMlDatafeeds (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ + 'allow_no_match', 'allow_no_datafeeds', 'format', 'h', @@ -37,6 +38,7 @@ function buildCatMlDatafeeds (opts) { ] const snakeCase = { + allowNoMatch: 'allow_no_match', allowNoDatafeeds: 'allow_no_datafeeds' } diff --git a/api/api/cat.ml_jobs.js b/api/api/cat.ml_jobs.js index b8048ead8..25ed055c0 100644 --- a/api/api/cat.ml_jobs.js +++ b/api/api/cat.ml_jobs.js @@ -27,6 +27,7 @@ function buildCatMlJobs (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ + 'allow_no_match', 'allow_no_jobs', 'bytes', 'format', @@ -38,6 +39,7 @@ function buildCatMlJobs (opts) { ] const snakeCase = { + allowNoMatch: 'allow_no_match', allowNoJobs: 'allow_no_jobs' } diff --git a/api/api/close_point_in_time.js b/api/api/close_point_in_time.js new file mode 100644 index 000000000..602c084ea --- /dev/null +++ b/api/api/close_point_in_time.js @@ -0,0 +1,87 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +'use strict' + +/* eslint camelcase: 0 */ +/* eslint no-unused-vars: 0 */ + +function buildClosePointInTime (opts) { + // eslint-disable-next-line no-unused-vars + const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts + + const acceptedQuerystring = [ + + ] + + const snakeCase = { + + } + + /** + * Perform a close_point_in_time request + * Close a point in time + * https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time.html + */ + return function closePointInTime (params, options, callback) { + options = options || {} + if (typeof options === 'function') { + callback = options + options = {} + } + if (typeof params === 'function' || params == null) { + callback = params + params = {} + options = {} + } + + // validate headers object + if (options.headers != null && typeof options.headers !== 'object') { + const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`) + return handleError(err, callback) + } + + var warnings = [] + var { method, body, ...querystring } = params + querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings) + + var ignore = options.ignore + if (typeof ignore === 'number') { + options.ignore = [ignore] + } + + var path = '' + + if (method == null) method = 'DELETE' + path = '/' + '_pit' + + // build request object + const request = { + method, + path, + body: body || '', + querystring + } + + options.warnings = warnings.length === 0 ? null : warnings + return makeRequest(request, options, callback) + } +} + +module.exports = buildClosePointInTime diff --git a/api/api/indices.add_block.js b/api/api/indices.add_block.js index 32f9fa9d2..2adea3b83 100644 --- a/api/api/indices.add_block.js +++ b/api/api/indices.add_block.js @@ -51,7 +51,7 @@ function buildIndicesAddBlock (opts) { /** * Perform a indices.add_block request * Adds a block to an index. - * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-blocks.html + * https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html */ return function indicesAddBlock (params, options, callback) { options = options || {} diff --git a/api/api/indices.create_data_stream.js b/api/api/indices.create_data_stream.js index ed319d7dd..c83938c27 100644 --- a/api/api/indices.create_data_stream.js +++ b/api/api/indices.create_data_stream.js @@ -36,7 +36,7 @@ function buildIndicesCreateDataStream (opts) { /** * Perform a indices.create_data_stream request - * Creates or updates a data stream + * Creates a data stream * https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html */ return function indicesCreateDataStream (params, options, callback) { diff --git a/api/api/indices.resolve_index.js b/api/api/indices.resolve_index.js index db096a4db..f5b31cb7a 100644 --- a/api/api/indices.resolve_index.js +++ b/api/api/indices.resolve_index.js @@ -44,7 +44,7 @@ function buildIndicesResolveIndex (opts) { /** * Perform a indices.resolve_index request * Returns information about any matching indices, aliases, and data streams - * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index.html + * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html */ return function indicesResolveIndex (params, options, callback) { options = options || {} diff --git a/api/api/ml.close_job.js b/api/api/ml.close_job.js index d2e05a477..b1d961cf6 100644 --- a/api/api/ml.close_job.js +++ b/api/api/ml.close_job.js @@ -27,12 +27,14 @@ function buildMlCloseJob (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ + 'allow_no_match', 'allow_no_jobs', 'force', 'timeout' ] const snakeCase = { + allowNoMatch: 'allow_no_match', allowNoJobs: 'allow_no_jobs' } diff --git a/api/api/ml.get_datafeed_stats.js b/api/api/ml.get_datafeed_stats.js index 3de9c923f..0c38f8c14 100644 --- a/api/api/ml.get_datafeed_stats.js +++ b/api/api/ml.get_datafeed_stats.js @@ -27,10 +27,12 @@ function buildMlGetDatafeedStats (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ + 'allow_no_match', 'allow_no_datafeeds' ] const snakeCase = { + allowNoMatch: 'allow_no_match', allowNoDatafeeds: 'allow_no_datafeeds' } diff --git a/api/api/ml.get_datafeeds.js b/api/api/ml.get_datafeeds.js index e48032e46..e3bde8f09 100644 --- a/api/api/ml.get_datafeeds.js +++ b/api/api/ml.get_datafeeds.js @@ -27,10 +27,12 @@ function buildMlGetDatafeeds (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ + 'allow_no_match', 'allow_no_datafeeds' ] const snakeCase = { + allowNoMatch: 'allow_no_match', allowNoDatafeeds: 'allow_no_datafeeds' } diff --git a/api/api/ml.get_job_stats.js b/api/api/ml.get_job_stats.js index f79137413..10759b68b 100644 --- a/api/api/ml.get_job_stats.js +++ b/api/api/ml.get_job_stats.js @@ -27,10 +27,12 @@ function buildMlGetJobStats (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ + 'allow_no_match', 'allow_no_jobs' ] const snakeCase = { + allowNoMatch: 'allow_no_match', allowNoJobs: 'allow_no_jobs' } diff --git a/api/api/ml.get_jobs.js b/api/api/ml.get_jobs.js index bf765da73..d49486d0c 100644 --- a/api/api/ml.get_jobs.js +++ b/api/api/ml.get_jobs.js @@ -27,10 +27,12 @@ function buildMlGetJobs (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ + 'allow_no_match', 'allow_no_jobs' ] const snakeCase = { + allowNoMatch: 'allow_no_match', allowNoJobs: 'allow_no_jobs' } diff --git a/api/api/ml.get_overall_buckets.js b/api/api/ml.get_overall_buckets.js index c918d7710..9b40879d0 100644 --- a/api/api/ml.get_overall_buckets.js +++ b/api/api/ml.get_overall_buckets.js @@ -33,6 +33,7 @@ function buildMlGetOverallBuckets (opts) { 'exclude_interim', 'start', 'end', + 'allow_no_match', 'allow_no_jobs' ] @@ -41,6 +42,7 @@ function buildMlGetOverallBuckets (opts) { bucketSpan: 'bucket_span', overallScore: 'overall_score', excludeInterim: 'exclude_interim', + allowNoMatch: 'allow_no_match', allowNoJobs: 'allow_no_jobs' } diff --git a/api/api/ml.stop_datafeed.js b/api/api/ml.stop_datafeed.js index c479cbe8f..022be927b 100644 --- a/api/api/ml.stop_datafeed.js +++ b/api/api/ml.stop_datafeed.js @@ -27,12 +27,14 @@ function buildMlStopDatafeed (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ + 'allow_no_match', 'allow_no_datafeeds', 'force', 'timeout' ] const snakeCase = { + allowNoMatch: 'allow_no_match', allowNoDatafeeds: 'allow_no_datafeeds' } diff --git a/api/api/open_point_in_time.js b/api/api/open_point_in_time.js new file mode 100644 index 000000000..d98e81cff --- /dev/null +++ b/api/api/open_point_in_time.js @@ -0,0 +1,98 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +'use strict' + +/* eslint camelcase: 0 */ +/* eslint no-unused-vars: 0 */ + +function buildOpenPointInTime (opts) { + // eslint-disable-next-line no-unused-vars + const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts + + const acceptedQuerystring = [ + 'preference', + 'routing', + 'ignore_unavailable', + 'expand_wildcards', + 'keep_alive' + ] + + const snakeCase = { + ignoreUnavailable: 'ignore_unavailable', + expandWildcards: 'expand_wildcards', + keepAlive: 'keep_alive' + } + + /** + * Perform a open_point_in_time request + * Open a point in time that can be used in subsequent searches + * https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time.html + */ + return function openPointInTime (params, options, callback) { + options = options || {} + if (typeof options === 'function') { + callback = options + options = {} + } + if (typeof params === 'function' || params == null) { + callback = params + params = {} + options = {} + } + + // validate headers object + if (options.headers != null && typeof options.headers !== 'object') { + const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`) + return handleError(err, callback) + } + + var warnings = [] + var { method, body, index, ...querystring } = params + querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings) + + var ignore = options.ignore + if (typeof ignore === 'number') { + options.ignore = [ignore] + } + + var path = '' + + if ((index) != null) { + if (method == null) method = 'POST' + path = '/' + encodeURIComponent(index) + '/' + '_pit' + } else { + if (method == null) method = 'POST' + path = '/' + '_pit' + } + + // build request object + const request = { + method, + path, + body: body || '', + querystring + } + + options.warnings = warnings.length === 0 ? null : warnings + return makeRequest(request, options, callback) + } +} + +module.exports = buildOpenPointInTime diff --git a/api/index.js b/api/index.js index c54627a69..6c338f259 100644 --- a/api/index.js +++ b/api/index.js @@ -112,6 +112,8 @@ function ESAPI (opts) { }, clear_scroll: lazyLoad('clear_scroll', opts), clearScroll: lazyLoad('clear_scroll', opts), + close_point_in_time: lazyLoad('close_point_in_time', opts), + closePointInTime: lazyLoad('close_point_in_time', opts), cluster: { allocation_explain: lazyLoad('cluster.allocation_explain', opts), allocationExplain: lazyLoad('cluster.allocation_explain', opts), @@ -505,6 +507,8 @@ function ESAPI (opts) { stats: lazyLoad('nodes.stats', opts), usage: lazyLoad('nodes.usage', opts) }, + open_point_in_time: lazyLoad('open_point_in_time', opts), + openPointInTime: lazyLoad('open_point_in_time', opts), ping: lazyLoad('ping', opts), put_script: lazyLoad('put_script', opts), putScript: lazyLoad('put_script', opts), diff --git a/api/kibana.d.ts b/api/kibana.d.ts index bc304b62a..6eb063450 100644 --- a/api/kibana.d.ts +++ b/api/kibana.d.ts @@ -130,6 +130,7 @@ interface KibanaClient { unfollow, TContext = Context>(params?: RequestParams.CcrUnfollow, options?: TransportRequestOptions): TransportRequestPromise> } clearScroll, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.ClearScroll, options?: TransportRequestOptions): TransportRequestPromise> + closePointInTime, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.ClosePointInTime, options?: TransportRequestOptions): TransportRequestPromise> cluster: { allocationExplain, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.ClusterAllocationExplain, options?: TransportRequestOptions): TransportRequestPromise> deleteComponentTemplate, TContext = Context>(params?: RequestParams.ClusterDeleteComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise> @@ -212,7 +213,7 @@ interface KibanaClient { clone, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.IndicesClone, options?: TransportRequestOptions): TransportRequestPromise> close, TContext = Context>(params?: RequestParams.IndicesClose, options?: TransportRequestOptions): TransportRequestPromise> create, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.IndicesCreate, options?: TransportRequestOptions): TransportRequestPromise> - createDataStream, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise> + createDataStream, TContext = Context>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise> dataStreamsStats, TContext = Context>(params?: RequestParams.IndicesDataStreamsStats, options?: TransportRequestOptions): TransportRequestPromise> delete, TContext = Context>(params?: RequestParams.IndicesDelete, options?: TransportRequestOptions): TransportRequestPromise> deleteAlias, TContext = Context>(params?: RequestParams.IndicesDeleteAlias, options?: TransportRequestOptions): TransportRequestPromise> @@ -333,7 +334,7 @@ interface KibanaClient { startDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlStartDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> startDatafeed, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlStartDatafeed, options?: TransportRequestOptions): TransportRequestPromise> stopDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlStopDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> - stopDatafeed, TContext = Context>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + stopDatafeed, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise> updateDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlUpdateDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> updateDatafeed, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlUpdateDatafeed, options?: TransportRequestOptions): TransportRequestPromise> updateFilter, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlUpdateFilter, options?: TransportRequestOptions): TransportRequestPromise> @@ -355,6 +356,7 @@ interface KibanaClient { stats, TContext = Context>(params?: RequestParams.NodesStats, options?: TransportRequestOptions): TransportRequestPromise> usage, TContext = Context>(params?: RequestParams.NodesUsage, options?: TransportRequestOptions): TransportRequestPromise> } + openPointInTime, TContext = Context>(params?: RequestParams.OpenPointInTime, options?: TransportRequestOptions): TransportRequestPromise> ping(params?: RequestParams.Ping, options?: TransportRequestOptions): TransportRequestPromise> putScript, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.PutScript, options?: TransportRequestOptions): TransportRequestPromise> rankEval, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.RankEval, options?: TransportRequestOptions): TransportRequestPromise> diff --git a/api/requestParams.d.ts b/api/requestParams.d.ts index 4ea9e4bea..f4ed86bfb 100644 --- a/api/requestParams.d.ts +++ b/api/requestParams.d.ts @@ -1538,6 +1538,7 @@ export interface CatMlDataFrameAnalytics extends Generic { export interface CatMlDatafeeds extends Generic { datafeed_id?: string; + allow_no_match?: boolean; allow_no_datafeeds?: boolean; format?: string; h?: string | string[]; @@ -1549,6 +1550,7 @@ export interface CatMlDatafeeds extends Generic { export interface CatMlJobs extends Generic { job_id?: string; + allow_no_match?: boolean; allow_no_jobs?: boolean; bytes?: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb'; format?: string; @@ -1642,6 +1644,10 @@ export interface CcrUnfollow extends Generic { index: string; } +export interface ClosePointInTime extends Generic { + body?: T; +} + export interface DataFrameTransformDeprecatedDeleteTransform extends Generic { transform_id: string; force?: boolean; @@ -1776,9 +1782,8 @@ export interface IlmStart extends Generic { export interface IlmStop extends Generic { } -export interface IndicesCreateDataStream extends Generic { +export interface IndicesCreateDataStream extends Generic { name: string; - body?: T; } export interface IndicesDataStreamsStats extends Generic { @@ -1854,6 +1859,7 @@ export interface MigrationDeprecations extends Generic { export interface MlCloseJob extends Generic { job_id: string; + allow_no_match?: boolean; allow_no_jobs?: boolean; force?: boolean; timeout?: string; @@ -2023,11 +2029,13 @@ export interface MlGetDataFrameAnalyticsStats extends Generic { export interface MlGetDatafeedStats extends Generic { datafeed_id?: string; + allow_no_match?: boolean; allow_no_datafeeds?: boolean; } export interface MlGetDatafeeds extends Generic { datafeed_id?: string; + allow_no_match?: boolean; allow_no_datafeeds?: boolean; } @@ -2052,11 +2060,13 @@ export interface MlGetInfluencers extends Generic { export interface MlGetJobStats extends Generic { job_id?: string; + allow_no_match?: boolean; allow_no_jobs?: boolean; } export interface MlGetJobs extends Generic { job_id?: string; + allow_no_match?: boolean; allow_no_jobs?: boolean; } @@ -2080,6 +2090,7 @@ export interface MlGetOverallBuckets extends Generic { exclude_interim?: boolean; start?: string; end?: string; + allow_no_match?: boolean; allow_no_jobs?: boolean; body?: T; } @@ -2211,11 +2222,13 @@ export interface MlStopDataFrameAnalytics extends Generic { body?: T; } -export interface MlStopDatafeed extends Generic { +export interface MlStopDatafeed extends Generic { datafeed_id: string; + allow_no_match?: boolean; allow_no_datafeeds?: boolean; force?: boolean; timeout?: string; + body?: T; } export interface MlUpdateDataFrameAnalytics extends Generic { @@ -2264,6 +2277,15 @@ export interface MonitoringBulk extends Generic { body: T; } +export interface OpenPointInTime extends Generic { + index?: string | string[]; + preference?: string; + routing?: string; + ignore_unavailable?: boolean; + expand_wildcards?: 'open' | 'closed' | 'hidden' | 'none' | 'all'; + keep_alive?: string; +} + export interface RollupDeleteJob extends Generic { id: string; } diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index f4f26cc34..6c8aa9ad8 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -2431,7 +2431,7 @@ client.indices.addBlock({ expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all' }) ---- - +link:{ref}/index-modules-blocks.html[Documentation] + [cols=2*] |=== |`index` @@ -3583,7 +3583,7 @@ client.indices.resolveIndex({ expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all' }) ---- - +link:{ref}/indices-resolve-index-api.html[Documentation] + [cols=2*] |=== |`name` @@ -6128,6 +6128,7 @@ link:{ref}/cat-dfanalytics.html[Documentation] + ---- client.cat.mlDatafeeds({ datafeed_id: string, + allow_no_match: boolean, allow_no_datafeeds: boolean, format: string, h: string | string[], @@ -6143,9 +6144,14 @@ link:{ref}/cat-datafeeds.html[Documentation] + |`datafeed_id` or `datafeedId` |`string` - The ID of the datafeeds stats to fetch -|`allow_no_datafeeds` or `allowNoDatafeeds` +|`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) +|`allow_no_datafeeds` or `allowNoDatafeeds` +|`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + + +WARNING: This parameter has been deprecated. + |`format` |`string` - a short version of the Accept header, e.g. json, yaml @@ -6172,6 +6178,7 @@ link:{ref}/cat-datafeeds.html[Documentation] + ---- client.cat.mlJobs({ job_id: string, + allow_no_match: boolean, allow_no_jobs: boolean, bytes: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb', format: string, @@ -6188,9 +6195,14 @@ link:{ref}/cat-anomaly-detectors.html[Documentation] + |`job_id` or `jobId` |`string` - The ID of the jobs stats to fetch -|`allow_no_jobs` or `allowNoJobs` +|`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) +|`allow_no_jobs` or `allowNoJobs` +|`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + + +WARNING: This parameter has been deprecated. + |`bytes` |`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values @@ -6546,6 +6558,22 @@ link:{ref}/ccr-post-unfollow.html[Documentation] + |=== +=== closePointInTime + +[source,ts] +---- +client.closePointInTime({ + body: object +}) +---- +link:{ref}/point-in-time.html[Documentation] + +[cols=2*] +|=== +|`body` +|`object` - a point-in-time id to close + +|=== + === dataFrameTransformDeprecated.deleteTransform *Stability:* beta [source,ts] @@ -7078,8 +7106,7 @@ link:{ref}/ilm-stop.html[Documentation] + [source,ts] ---- client.indices.createDataStream({ - name: string, - body: object + name: string }) ---- link:{ref}/data-streams.html[Documentation] + @@ -7088,9 +7115,6 @@ link:{ref}/data-streams.html[Documentation] + |`name` |`string` - The name of the data stream -|`body` -|`object` - The data stream definition - |=== === indices.dataStreamsStats @@ -7379,6 +7403,7 @@ link:{ref}/migration-api-deprecation.html[Documentation] + ---- client.ml.closeJob({ job_id: string, + allow_no_match: boolean, allow_no_jobs: boolean, force: boolean, timeout: string, @@ -7391,9 +7416,14 @@ link:{ref}/ml-close-job.html[Documentation] + |`job_id` or `jobId` |`string` - The name of the job to close -|`allow_no_jobs` or `allowNoJobs` +|`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) +|`allow_no_jobs` or `allowNoJobs` +|`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + + +WARNING: This parameter has been deprecated. + |`force` |`boolean` - True if the job should be forcefully closed @@ -8063,6 +8093,7 @@ _Default:_ `100` ---- client.ml.getDatafeedStats({ datafeed_id: string, + allow_no_match: boolean, allow_no_datafeeds: boolean }) ---- @@ -8072,9 +8103,14 @@ link:{ref}/ml-get-datafeed-stats.html[Documentation] + |`datafeed_id` or `datafeedId` |`string` - The ID of the datafeeds stats to fetch -|`allow_no_datafeeds` or `allowNoDatafeeds` +|`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) +|`allow_no_datafeeds` or `allowNoDatafeeds` +|`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + + +WARNING: This parameter has been deprecated. + |=== === ml.getDatafeeds @@ -8083,6 +8119,7 @@ link:{ref}/ml-get-datafeed-stats.html[Documentation] + ---- client.ml.getDatafeeds({ datafeed_id: string, + allow_no_match: boolean, allow_no_datafeeds: boolean }) ---- @@ -8092,9 +8129,14 @@ link:{ref}/ml-get-datafeed.html[Documentation] + |`datafeed_id` or `datafeedId` |`string` - The ID of the datafeeds to fetch -|`allow_no_datafeeds` or `allowNoDatafeeds` +|`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) +|`allow_no_datafeeds` or `allowNoDatafeeds` +|`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + + +WARNING: This parameter has been deprecated. + |=== === ml.getFilters @@ -8179,6 +8221,7 @@ link:{ref}/ml-get-influencer.html[Documentation] + ---- client.ml.getJobStats({ job_id: string, + allow_no_match: boolean, allow_no_jobs: boolean }) ---- @@ -8188,9 +8231,14 @@ link:{ref}/ml-get-job-stats.html[Documentation] + |`job_id` or `jobId` |`string` - The ID of the jobs stats to fetch -|`allow_no_jobs` or `allowNoJobs` +|`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) +|`allow_no_jobs` or `allowNoJobs` +|`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + + +WARNING: This parameter has been deprecated. + |=== === ml.getJobs @@ -8199,6 +8247,7 @@ link:{ref}/ml-get-job-stats.html[Documentation] + ---- client.ml.getJobs({ job_id: string, + allow_no_match: boolean, allow_no_jobs: boolean }) ---- @@ -8208,9 +8257,14 @@ link:{ref}/ml-get-job.html[Documentation] + |`job_id` or `jobId` |`string` - The ID of the jobs to fetch -|`allow_no_jobs` or `allowNoJobs` +|`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) +|`allow_no_jobs` or `allowNoJobs` +|`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + + +WARNING: This parameter has been deprecated. + |=== === ml.getModelSnapshots @@ -8273,6 +8327,7 @@ client.ml.getOverallBuckets({ exclude_interim: boolean, start: string, end: string, + allow_no_match: boolean, allow_no_jobs: boolean, body: object }) @@ -8301,9 +8356,14 @@ link:{ref}/ml-get-overall-buckets.html[Documentation] + |`end` |`string` - Returns overall buckets with timestamps earlier than this time -|`allow_no_jobs` or `allowNoJobs` +|`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) +|`allow_no_jobs` or `allowNoJobs` +|`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + + +WARNING: This parameter has been deprecated. + |`body` |`object` - Overall bucket selection details if not provided in URI @@ -8825,9 +8885,11 @@ link:{ref}/stop-dfanalytics.html[Documentation] + ---- client.ml.stopDatafeed({ datafeed_id: string, + allow_no_match: boolean, allow_no_datafeeds: boolean, force: boolean, - timeout: string + timeout: string, + body: object }) ---- link:{ref}/ml-stop-datafeed.html[Documentation] + @@ -8836,15 +8898,23 @@ link:{ref}/ml-stop-datafeed.html[Documentation] + |`datafeed_id` or `datafeedId` |`string` - The ID of the datafeed to stop -|`allow_no_datafeeds` or `allowNoDatafeeds` +|`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) +|`allow_no_datafeeds` or `allowNoDatafeeds` +|`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + + +WARNING: This parameter has been deprecated. + |`force` |`boolean` - True if the datafeed should be forcefully stopped. |`timeout` |`string` - Controls the time to wait until a datafeed has stopped. Default to 20 seconds +|`body` +|`object` - The URL params optionally sent in the body + |=== === ml.updateDataFrameAnalytics @@ -9033,6 +9103,43 @@ WARNING: This parameter has been deprecated. |=== +=== openPointInTime + +[source,ts] +---- +client.openPointInTime({ + index: string | string[], + preference: string, + routing: string, + ignore_unavailable: boolean, + expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all', + keep_alive: string +}) +---- +link:{ref}/point-in-time.html[Documentation] + +[cols=2*] +|=== +|`index` +|`string \| string[]` - A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices + +|`preference` +|`string` - Specify the node or shard the operation should be performed on (default: random) + +|`routing` +|`string` - Specific routing value + +|`ignore_unavailable` or `ignoreUnavailable` +|`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed) + +|`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` + +|`keep_alive` or `keepAlive` +|`string` - Specific the time to live for the point in time + +|=== + === rollup.deleteJob *Stability:* experimental [source,ts] @@ -10360,7 +10467,7 @@ link:{ref}/info-api.html[Documentation] + |`string \| string[]` - Comma-separated list of info categories. Can be any of: build, license, features |`accept_enterprise` or `acceptEnterprise` -|`boolean` - Supported for backwards compatibility with 7.x. If this param is used it must be set to true + +|`boolean` - If this param is used it must be set to true + WARNING: This parameter has been deprecated. diff --git a/index.d.ts b/index.d.ts index 4cfeb403e..78206da7b 100644 --- a/index.d.ts +++ b/index.d.ts @@ -433,6 +433,14 @@ declare class Client { clearScroll, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback clearScroll, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.ClearScroll, callback: callbackFn): TransportRequestCallback clearScroll, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.ClearScroll, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + close_point_in_time, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.ClosePointInTime, options?: TransportRequestOptions): TransportRequestPromise> + close_point_in_time, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback + close_point_in_time, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.ClosePointInTime, callback: callbackFn): TransportRequestCallback + close_point_in_time, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.ClosePointInTime, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + closePointInTime, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.ClosePointInTime, options?: TransportRequestOptions): TransportRequestPromise> + closePointInTime, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback + closePointInTime, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.ClosePointInTime, callback: callbackFn): TransportRequestCallback + closePointInTime, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.ClosePointInTime, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback cluster: { allocation_explain, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.ClusterAllocationExplain, options?: TransportRequestOptions): TransportRequestPromise> allocation_explain, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback @@ -984,14 +992,14 @@ declare class Client { create, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback create, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.IndicesCreate, callback: callbackFn): TransportRequestCallback create, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.IndicesCreate, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback - create_data_stream, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise> - create_data_stream, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback - create_data_stream, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.IndicesCreateDataStream, callback: callbackFn): TransportRequestCallback - create_data_stream, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.IndicesCreateDataStream, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback - createDataStream, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise> - createDataStream, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback - createDataStream, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.IndicesCreateDataStream, callback: callbackFn): TransportRequestCallback - createDataStream, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.IndicesCreateDataStream, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + create_data_stream, TContext = Context>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise> + create_data_stream, TContext = Context>(callback: callbackFn): TransportRequestCallback + create_data_stream, TContext = Context>(params: RequestParams.IndicesCreateDataStream, callback: callbackFn): TransportRequestCallback + create_data_stream, TContext = Context>(params: RequestParams.IndicesCreateDataStream, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + createDataStream, TContext = Context>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise> + createDataStream, TContext = Context>(callback: callbackFn): TransportRequestCallback + createDataStream, TContext = Context>(params: RequestParams.IndicesCreateDataStream, callback: callbackFn): TransportRequestCallback + createDataStream, TContext = Context>(params: RequestParams.IndicesCreateDataStream, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback data_streams_stats, TContext = Context>(params?: RequestParams.IndicesDataStreamsStats, options?: TransportRequestOptions): TransportRequestPromise> data_streams_stats, TContext = Context>(callback: callbackFn): TransportRequestCallback data_streams_stats, TContext = Context>(params: RequestParams.IndicesDataStreamsStats, callback: callbackFn): TransportRequestCallback @@ -1796,14 +1804,14 @@ declare class Client { stopDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback stopDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.MlStopDataFrameAnalytics, callback: callbackFn): TransportRequestCallback stopDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.MlStopDataFrameAnalytics, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback - stop_datafeed, TContext = Context>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise> - stop_datafeed, TContext = Context>(callback: callbackFn): TransportRequestCallback - stop_datafeed, TContext = Context>(params: RequestParams.MlStopDatafeed, callback: callbackFn): TransportRequestCallback - stop_datafeed, TContext = Context>(params: RequestParams.MlStopDatafeed, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback - stopDatafeed, TContext = Context>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise> - stopDatafeed, TContext = Context>(callback: callbackFn): TransportRequestCallback - stopDatafeed, TContext = Context>(params: RequestParams.MlStopDatafeed, callback: callbackFn): TransportRequestCallback - stopDatafeed, TContext = Context>(params: RequestParams.MlStopDatafeed, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + stop_datafeed, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + stop_datafeed, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback + stop_datafeed, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.MlStopDatafeed, callback: callbackFn): TransportRequestCallback + stop_datafeed, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.MlStopDatafeed, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + stopDatafeed, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + stopDatafeed, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback + stopDatafeed, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.MlStopDatafeed, callback: callbackFn): TransportRequestCallback + stopDatafeed, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.MlStopDatafeed, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback update_data_frame_analytics, TRequestBody extends RequestBody = Record, TContext = Context>(params?: RequestParams.MlUpdateDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> update_data_frame_analytics, TRequestBody extends RequestBody = Record, TContext = Context>(callback: callbackFn): TransportRequestCallback update_data_frame_analytics, TRequestBody extends RequestBody = Record, TContext = Context>(params: RequestParams.MlUpdateDataFrameAnalytics, callback: callbackFn): TransportRequestCallback @@ -1909,6 +1917,14 @@ declare class Client { usage, TContext = Context>(params: RequestParams.NodesUsage, callback: callbackFn): TransportRequestCallback usage, TContext = Context>(params: RequestParams.NodesUsage, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback } + open_point_in_time, TContext = Context>(params?: RequestParams.OpenPointInTime, options?: TransportRequestOptions): TransportRequestPromise> + open_point_in_time, TContext = Context>(callback: callbackFn): TransportRequestCallback + open_point_in_time, TContext = Context>(params: RequestParams.OpenPointInTime, callback: callbackFn): TransportRequestCallback + open_point_in_time, TContext = Context>(params: RequestParams.OpenPointInTime, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + openPointInTime, TContext = Context>(params?: RequestParams.OpenPointInTime, options?: TransportRequestOptions): TransportRequestPromise> + openPointInTime, TContext = Context>(callback: callbackFn): TransportRequestCallback + openPointInTime, TContext = Context>(params: RequestParams.OpenPointInTime, callback: callbackFn): TransportRequestCallback + openPointInTime, TContext = Context>(params: RequestParams.OpenPointInTime, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback ping(params?: RequestParams.Ping, options?: TransportRequestOptions): TransportRequestPromise> ping(callback: callbackFn): TransportRequestCallback ping(params: RequestParams.Ping, callback: callbackFn): TransportRequestCallback