From 4121e1e7ffae835ad13e1e37a87671af68591abc Mon Sep 17 00:00:00 2001 From: delvedor Date: Wed, 3 Jun 2020 09:11:45 +0200 Subject: [PATCH] API generation --- api/api/cluster.delete_component_template.js | 2 +- api/api/cluster.exists_component_template.js | 2 +- api/api/cluster.get_component_template.js | 2 +- api/api/cluster.put_component_template.js | 2 +- api/api/indices.create_data_stream.js | 4 - api/api/indices.simulate_template.js | 86 ++++++++++++++++++++ api/api/ml.forecast.js | 6 +- api/api/ml.get_trained_models.js | 7 +- api/index.js | 2 + api/requestParams.d.ts | 15 +++- docs/reference.asciidoc | 59 ++++++++++++-- index.d.ts | 24 ++++-- 12 files changed, 183 insertions(+), 28 deletions(-) create mode 100644 api/api/indices.simulate_template.js diff --git a/api/api/cluster.delete_component_template.js b/api/api/cluster.delete_component_template.js index 0a4b279eb..d47afdd27 100644 --- a/api/api/cluster.delete_component_template.js +++ b/api/api/cluster.delete_component_template.js @@ -30,7 +30,7 @@ function buildClusterDeleteComponentTemplate (opts) { /** * Perform a cluster.delete_component_template request * Deletes a component template - * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-templates.html + * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html */ return function clusterDeleteComponentTemplate (params, options, callback) { options = options || {} diff --git a/api/api/cluster.exists_component_template.js b/api/api/cluster.exists_component_template.js index 8860da8a6..cfdb42494 100644 --- a/api/api/cluster.exists_component_template.js +++ b/api/api/cluster.exists_component_template.js @@ -30,7 +30,7 @@ function buildClusterExistsComponentTemplate (opts) { /** * Perform a cluster.exists_component_template request * Returns information about whether a particular component template exist - * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-templates.html + * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html */ return function clusterExistsComponentTemplate (params, options, callback) { options = options || {} diff --git a/api/api/cluster.get_component_template.js b/api/api/cluster.get_component_template.js index e33c15ade..8a6d3030f 100644 --- a/api/api/cluster.get_component_template.js +++ b/api/api/cluster.get_component_template.js @@ -30,7 +30,7 @@ function buildClusterGetComponentTemplate (opts) { /** * Perform a cluster.get_component_template request * Returns one or more component templates - * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-templates.html + * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html */ return function clusterGetComponentTemplate (params, options, callback) { options = options || {} diff --git a/api/api/cluster.put_component_template.js b/api/api/cluster.put_component_template.js index 335f892bc..6dbcacf9f 100644 --- a/api/api/cluster.put_component_template.js +++ b/api/api/cluster.put_component_template.js @@ -31,7 +31,7 @@ function buildClusterPutComponentTemplate (opts) { /** * Perform a cluster.put_component_template request * Creates or updates a component template - * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-templates.html + * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html */ return function clusterPutComponentTemplate (params, options, callback) { options = options || {} diff --git a/api/api/indices.create_data_stream.js b/api/api/indices.create_data_stream.js index b3dd2e717..017720d9f 100644 --- a/api/api/indices.create_data_stream.js +++ b/api/api/indices.create_data_stream.js @@ -46,10 +46,6 @@ function buildIndicesCreateDataStream (opts) { 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') { diff --git a/api/api/indices.simulate_template.js b/api/api/indices.simulate_template.js new file mode 100644 index 000000000..94c22fd2e --- /dev/null +++ b/api/api/indices.simulate_template.js @@ -0,0 +1,86 @@ +// 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 buildIndicesSimulateTemplate (opts) { + // eslint-disable-next-line no-unused-vars + const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts + + const acceptedQuerystring = [ + 'create', + 'cause', + 'master_timeout', + 'pretty', + 'human', + 'error_trace', + 'source', + 'filter_path' + ] + + const snakeCase = { + masterTimeout: 'master_timeout', + errorTrace: 'error_trace', + filterPath: 'filter_path' + } + + /** + * Perform a indices.simulate_template request + * Simulate resolving the given template name or body + * https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html + */ + return function indicesSimulateTemplate (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, name, ...querystring } = params + querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings) + + var ignore = options.ignore + if (typeof ignore === 'number') { + options.ignore = [ignore] + } + + var path = '' + + if ((name) != null) { + if (method == null) method = 'POST' + path = '/' + '_index_template' + '/' + '_simulate' + '/' + encodeURIComponent(name) + } else { + if (method == null) method = 'POST' + path = '/' + '_index_template' + '/' + '_simulate' + } + + // build request object + const request = { + method, + path, + body: body || '', + querystring + } + + options.warnings = warnings.length === 0 ? null : warnings + return makeRequest(request, options, callback) + } +} + +module.exports = buildIndicesSimulateTemplate diff --git a/api/api/ml.forecast.js b/api/api/ml.forecast.js index 35fe59d56..b1af60455 100644 --- a/api/api/ml.forecast.js +++ b/api/api/ml.forecast.js @@ -13,11 +13,13 @@ function buildMlForecast (opts) { const acceptedQuerystring = [ 'duration', - 'expires_in' + 'expires_in', + 'max_model_memory' ] const snakeCase = { - expiresIn: 'expires_in' + expiresIn: 'expires_in', + maxModelMemory: 'max_model_memory' } /** diff --git a/api/api/ml.get_trained_models.js b/api/api/ml.get_trained_models.js index 75c3e99e5..b447802ed 100644 --- a/api/api/ml.get_trained_models.js +++ b/api/api/ml.get_trained_models.js @@ -17,14 +17,15 @@ function buildMlGetTrainedModels (opts) { 'decompress_definition', 'from', 'size', - 'tags' + 'tags', + 'for_export' ] const snakeCase = { allowNoMatch: 'allow_no_match', includeModelDefinition: 'include_model_definition', - decompressDefinition: 'decompress_definition' - + decompressDefinition: 'decompress_definition', + forExport: 'for_export' } /** diff --git a/api/index.js b/api/index.js index 1e4a24403..a47224418 100644 --- a/api/index.js +++ b/api/index.js @@ -257,6 +257,8 @@ function ESAPI (opts) { shrink: lazyLoad('indices.shrink', opts), simulate_index_template: lazyLoad('indices.simulate_index_template', opts), simulateIndexTemplate: lazyLoad('indices.simulate_index_template', opts), + simulate_template: lazyLoad('indices.simulate_template', opts), + simulateTemplate: lazyLoad('indices.simulate_template', opts), split: lazyLoad('indices.split', opts), stats: lazyLoad('indices.stats', opts), unfreeze: lazyLoad('indices.unfreeze', opts), diff --git a/api/requestParams.d.ts b/api/requestParams.d.ts index dc7a43194..b157304a1 100644 --- a/api/requestParams.d.ts +++ b/api/requestParams.d.ts @@ -625,7 +625,7 @@ export interface IndicesCreate extends Generic { export interface IndicesCreateDataStream extends Generic { name: string; - body: T; + body?: T; } export interface IndicesDelete extends Generic { @@ -927,6 +927,14 @@ export interface IndicesSimulateIndexTemplate extends Generic { body?: T; } +export interface IndicesSimulateTemplate extends Generic { + name?: string; + create?: boolean; + cause?: string; + master_timeout?: string; + body?: T; +} + export interface IndicesSplit extends Generic { index: string; target: string; @@ -1776,7 +1784,8 @@ export interface MlDeleteDatafeed extends Generic { force?: boolean; } -export interface MlDeleteExpiredData extends Generic { +export interface MlDeleteExpiredData extends Generic { + body?: T; } export interface MlDeleteFilter extends Generic { @@ -1850,6 +1859,7 @@ export interface MlForecast extends Generic { job_id: string; duration?: string; expires_in?: string; + max_model_memory?: string; } export interface MlGetBuckets extends Generic { @@ -1989,6 +1999,7 @@ export interface MlGetTrainedModels extends Generic { from?: number; size?: number; tags?: string | string[]; + for_export?: boolean; } export interface MlGetTrainedModelsStats extends Generic { diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 88b3f0884..cbfb774c4 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -3219,7 +3219,9 @@ _Default:_ `open` |`string` - Specify timeout for connection to master |`local` -|`boolean` - Return local information, do not retrieve the state from master node (default: false) +|`boolean` - Return local information, do not retrieve the state from master node (default: false) + + +WARNING: This parameter has been deprecated. |=== @@ -3809,6 +3811,38 @@ link:{ref}/indices-templates.html[Documentation] + |=== +=== indices.simulateTemplate + +[source,ts] +---- +client.indices.simulateTemplate({ + name: string, + create: boolean, + cause: string, + master_timeout: string, + body: object +}) +---- +link:{ref}/indices-templates.html[Documentation] + +[cols=2*] +|=== +|`name` +|`string` - The name of the index template + +|`create` +|`boolean` - Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one + +|`cause` +|`string` - User defined reason for dry-run creating the new template for simulation purposes + +|`master_timeout` or `masterTimeout` +|`string` - Specify timeout for connection to master + +|`body` +|`object` - New index template definition to be simulated, if no index template name is specified + +|=== + === indices.split [source,ts] @@ -5233,7 +5267,7 @@ link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` -|`string \| string[]` - A comma-separated list of repository names +|`string \| string[]` - Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. |`master_timeout` or `masterTimeout` |`string` - Explicit operation timeout for connection to master node @@ -7245,10 +7279,17 @@ link:{ref}/ml-delete-datafeed.html[Documentation] + [source,ts] ---- -client.ml.deleteExpiredData() +client.ml.deleteExpiredData({ + body: object +}) ---- link:{ref}/ml-delete-expired-data.html[Documentation] + +[cols=2*] +|=== +|`body` +|`object` - deleting expired data parameters +|=== === ml.deleteFilter @@ -7529,7 +7570,8 @@ link:{ref}/ml-flush-job.html[Documentation] + client.ml.forecast({ job_id: string, duration: string, - expires_in: string + expires_in: string, + max_model_memory: string }) ---- link:{ref}/ml-forecast.html[Documentation] + @@ -7544,6 +7586,9 @@ link:{ref}/ml-forecast.html[Documentation] + |`expires_in` or `expiresIn` |`string` - The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity. +|`max_model_memory` or `maxModelMemory` +|`string` - The max memory able to be used by the forecast. Default is 20mb. + |=== === ml.getBuckets @@ -8077,7 +8122,8 @@ client.ml.getTrainedModels({ decompress_definition: boolean, from: number, size: number, - tags: string | string[] + tags: string | string[], + for_export: boolean }) ---- link:{ref}/get-inference.html[Documentation] + @@ -8107,6 +8153,9 @@ _Default:_ `100` |`tags` |`string \| string[]` - A comma-separated list of tags that the model must have. +|`for_export` or `forExport` +|`boolean` - Omits fields that are illegal to set on model PUT + |=== === ml.getTrainedModelsStats diff --git a/index.d.ts b/index.d.ts index e6f71a8c8..ca6744636 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1013,6 +1013,14 @@ declare class Client extends EventEmitter { simulateIndexTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(callback: callbackFn): TransportRequestCallback simulateIndexTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.IndicesSimulateIndexTemplate, callback: callbackFn): TransportRequestCallback simulateIndexTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.IndicesSimulateIndexTemplate, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + simulate_template, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesSimulateTemplate, options?: TransportRequestOptions): TransportRequestPromise> + simulate_template, TRequestBody extends RequestBody = Record, TContext = unknown>(callback: callbackFn): TransportRequestCallback + simulate_template, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.IndicesSimulateTemplate, callback: callbackFn): TransportRequestCallback + simulate_template, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.IndicesSimulateTemplate, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + simulateTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesSimulateTemplate, options?: TransportRequestOptions): TransportRequestPromise> + simulateTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(callback: callbackFn): TransportRequestCallback + simulateTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.IndicesSimulateTemplate, callback: callbackFn): TransportRequestCallback + simulateTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.IndicesSimulateTemplate, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback split, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesSplit, options?: TransportRequestOptions): TransportRequestPromise> split, TRequestBody extends RequestBody = Record, TContext = unknown>(callback: callbackFn): TransportRequestCallback split, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.IndicesSplit, callback: callbackFn): TransportRequestCallback @@ -1193,14 +1201,14 @@ declare class Client extends EventEmitter { deleteDatafeed, TContext = unknown>(callback: callbackFn): TransportRequestCallback deleteDatafeed, TContext = unknown>(params: RequestParams.MlDeleteDatafeed, callback: callbackFn): TransportRequestCallback deleteDatafeed, TContext = unknown>(params: RequestParams.MlDeleteDatafeed, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback - delete_expired_data, TContext = unknown>(params?: RequestParams.MlDeleteExpiredData, options?: TransportRequestOptions): TransportRequestPromise> - delete_expired_data, TContext = unknown>(callback: callbackFn): TransportRequestCallback - delete_expired_data, TContext = unknown>(params: RequestParams.MlDeleteExpiredData, callback: callbackFn): TransportRequestCallback - delete_expired_data, TContext = unknown>(params: RequestParams.MlDeleteExpiredData, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback - deleteExpiredData, TContext = unknown>(params?: RequestParams.MlDeleteExpiredData, options?: TransportRequestOptions): TransportRequestPromise> - deleteExpiredData, TContext = unknown>(callback: callbackFn): TransportRequestCallback - deleteExpiredData, TContext = unknown>(params: RequestParams.MlDeleteExpiredData, callback: callbackFn): TransportRequestCallback - deleteExpiredData, TContext = unknown>(params: RequestParams.MlDeleteExpiredData, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + delete_expired_data, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlDeleteExpiredData, options?: TransportRequestOptions): TransportRequestPromise> + delete_expired_data, TRequestBody extends RequestBody = Record, TContext = unknown>(callback: callbackFn): TransportRequestCallback + delete_expired_data, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.MlDeleteExpiredData, callback: callbackFn): TransportRequestCallback + delete_expired_data, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.MlDeleteExpiredData, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + deleteExpiredData, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlDeleteExpiredData, options?: TransportRequestOptions): TransportRequestPromise> + deleteExpiredData, TRequestBody extends RequestBody = Record, TContext = unknown>(callback: callbackFn): TransportRequestCallback + deleteExpiredData, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.MlDeleteExpiredData, callback: callbackFn): TransportRequestCallback + deleteExpiredData, TRequestBody extends RequestBody = Record, TContext = unknown>(params: RequestParams.MlDeleteExpiredData, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback delete_filter, TContext = unknown>(params?: RequestParams.MlDeleteFilter, options?: TransportRequestOptions): TransportRequestPromise> delete_filter, TContext = unknown>(callback: callbackFn): TransportRequestCallback delete_filter, TContext = unknown>(params: RequestParams.MlDeleteFilter, callback: callbackFn): TransportRequestCallback