From fa760f44b5181f0e8a467122b2e807cca8f2ac92 Mon Sep 17 00:00:00 2001 From: delvedor Date: Mon, 13 Jul 2020 11:21:44 +0200 Subject: [PATCH] API generation --- api/api/ml.update_data_frame_analytics.js | 82 +++++++++++++++++++++++ api/index.js | 2 + api/kibana.d.ts | 1 + api/requestParams.d.ts | 9 ++- docs/reference.asciidoc | 32 +++++++-- index.d.ts | 8 +++ 6 files changed, 126 insertions(+), 8 deletions(-) create mode 100644 api/api/ml.update_data_frame_analytics.js diff --git a/api/api/ml.update_data_frame_analytics.js b/api/api/ml.update_data_frame_analytics.js new file mode 100644 index 000000000..1e1d21a12 --- /dev/null +++ b/api/api/ml.update_data_frame_analytics.js @@ -0,0 +1,82 @@ +// Licensed to Elasticsearch B.V under one or more agreements. +// Elasticsearch B.V licenses this file to you under the Apache 2.0 License. +// See the LICENSE file in the project root for more information + +'use strict' + +/* eslint camelcase: 0 */ +/* eslint no-unused-vars: 0 */ + +function buildMlUpdateDataFrameAnalytics (opts) { + // eslint-disable-next-line no-unused-vars + const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts + + const acceptedQuerystring = [ + + ] + + const snakeCase = { + + } + + /** + * Perform a ml.update_data_frame_analytics request + * Updates certain properties of a data frame analytics job. + * https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html + */ + return function mlUpdateDataFrameAnalytics (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['id'] == null) { + const err = new ConfigurationError('Missing required parameter: id') + 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, id, ...querystring } = params + querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings) + + var ignore = options.ignore + if (typeof ignore === 'number') { + options.ignore = [ignore] + } + + var path = '' + + if (method == null) method = 'POST' + path = '/' + '_ml' + '/' + 'data_frame' + '/' + 'analytics' + '/' + encodeURIComponent(id) + '/' + '_update' + + // build request object + const request = { + method, + path, + body: body || '', + querystring + } + + options.warnings = warnings.length === 0 ? null : warnings + return makeRequest(request, options, callback) + } +} + +module.exports = buildMlUpdateDataFrameAnalytics diff --git a/api/index.js b/api/index.js index c398a3c47..e7d51ff1e 100644 --- a/api/index.js +++ b/api/index.js @@ -458,6 +458,8 @@ function ESAPI (opts) { stopDataFrameAnalytics: lazyLoad('ml.stop_data_frame_analytics', opts), stop_datafeed: lazyLoad('ml.stop_datafeed', opts), stopDatafeed: lazyLoad('ml.stop_datafeed', opts), + update_data_frame_analytics: lazyLoad('ml.update_data_frame_analytics', opts), + updateDataFrameAnalytics: lazyLoad('ml.update_data_frame_analytics', opts), update_datafeed: lazyLoad('ml.update_datafeed', opts), updateDatafeed: lazyLoad('ml.update_datafeed', opts), update_filter: lazyLoad('ml.update_filter', opts), diff --git a/api/kibana.d.ts b/api/kibana.d.ts index f66d4d024..6d861831c 100644 --- a/api/kibana.d.ts +++ b/api/kibana.d.ts @@ -317,6 +317,7 @@ interface KibanaClient { startDatafeed, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlStartDatafeed, options?: TransportRequestOptions): TransportRequestPromise> stopDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlStopDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> stopDatafeed, TContext = unknown>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + updateDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> updateDatafeed, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateDatafeed, options?: TransportRequestOptions): TransportRequestPromise> updateFilter, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateFilter, options?: TransportRequestOptions): TransportRequestPromise> updateJob, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateJob, options?: TransportRequestOptions): TransportRequestPromise> diff --git a/api/requestParams.d.ts b/api/requestParams.d.ts index c9e8da4c9..2477fa673 100644 --- a/api/requestParams.d.ts +++ b/api/requestParams.d.ts @@ -677,7 +677,7 @@ export interface IndicesDeleteAlias extends Generic { } export interface IndicesDeleteDataStream extends Generic { - name: string; + name: string | string[]; } export interface IndicesDeleteIndexTemplate extends Generic { @@ -774,7 +774,7 @@ export interface IndicesGetAlias extends Generic { } export interface IndicesGetDataStream extends Generic { - name?: string; + name?: string | string[]; } export interface IndicesGetFieldMapping extends Generic { @@ -2195,6 +2195,11 @@ export interface MlStopDatafeed extends Generic { timeout?: string; } +export interface MlUpdateDataFrameAnalytics extends Generic { + id: string; + body: T; +} + export interface MlUpdateDatafeed extends Generic { datafeed_id: string; ignore_unavailable?: boolean; diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index db7f30256..c271782b4 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -2423,7 +2423,7 @@ client.indices.addBlock({ expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all' }) ---- - +link:{ref}/indices-blocks.html[Documentation] + [cols=2*] |=== |`index` @@ -2714,14 +2714,14 @@ link:{ref}/indices-aliases.html[Documentation] + [source,ts] ---- client.indices.deleteDataStream({ - name: string + name: string | string[] }) ---- link:{ref}/data-streams.html[Documentation] + [cols=2*] |=== |`name` -|`string` - The name of the data stream +|`string \| string[]` - A comma-separated list of data streams to delete; use `*` to delete all data streams |=== @@ -3109,14 +3109,14 @@ _Default:_ `all` [source,ts] ---- client.indices.getDataStream({ - name: string + name: string | string[] }) ---- link:{ref}/data-streams.html[Documentation] + [cols=2*] |=== |`name` -|`string` - The name or wildcard expression of the requested data streams +|`string \| string[]` - A comma-separated list of data streams to get; use `*` to get all data streams |=== @@ -3623,7 +3623,7 @@ client.indices.resolveIndex({ expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all' }) ---- - +link:{ref}/indices-resolve-index.html[Documentation] + [cols=2*] |=== |`name` @@ -8811,6 +8811,26 @@ link:{ref}/ml-stop-datafeed.html[Documentation] + |=== +=== ml.updateDataFrameAnalytics +*Stability:* experimental +[source,ts] +---- +client.ml.updateDataFrameAnalytics({ + id: string, + body: object +}) +---- +link:{ref}/update-dfanalytics.html[Documentation] + +[cols=2*] +|=== +|`id` +|`string` - The ID of the data frame analytics to update + +|`body` +|`object` - The data frame analytics settings to update + +|=== + === ml.updateDatafeed [source,ts] diff --git a/index.d.ts b/index.d.ts index 5f51ff089..f63aed8f5 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1778,6 +1778,14 @@ declare class Client { stopDatafeed, TContext = unknown>(callback: callbackFn): TransportRequestCallback stopDatafeed, TContext = unknown>(params: RequestParams.MlStopDatafeed, callback: callbackFn): TransportRequestCallback stopDatafeed, TContext = unknown>(params: RequestParams.MlStopDatafeed, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + update_data_frame_analytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> + update_data_frame_analytics, TRequestBody extends RequestBody = Record, TContext = unknown>(callback: callbackFn): TransportRequestCallback + update_data_frame_analytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.MlUpdateDataFrameAnalytics, callback: callbackFn): TransportRequestCallback + update_data_frame_analytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.MlUpdateDataFrameAnalytics, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + updateDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> + updateDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(callback: callbackFn): TransportRequestCallback + updateDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.MlUpdateDataFrameAnalytics, callback: callbackFn): TransportRequestCallback + updateDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.MlUpdateDataFrameAnalytics, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback update_datafeed, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateDatafeed, options?: TransportRequestOptions): TransportRequestPromise> update_datafeed, TRequestBody extends RequestBody = Record, TContext = unknown>(callback: callbackFn): TransportRequestCallback update_datafeed, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.MlUpdateDatafeed, callback: callbackFn): TransportRequestCallback