habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API generation

Browse Source
This commit is contained in:
delvedor
2020-07-13 11:21:44 +02:00
parent 1a7968aba3
commit fa760f44b5
6 changed files with 126 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
api/api/ml.update_data_frame_analytics.js Normal file
View File

@ -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

2
api/index.js
View File

@ -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),

1
api/kibana.d.ts vendored
View File

@ -317,6 +317,7 @@ interface KibanaClient {
startDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.MlStartDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
stopDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.MlStopDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
stopDatafeed<TResponse = Record<string, any>, TContext = unknown>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
updateDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
updateDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.MlUpdateDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
updateFilter<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.MlUpdateFilter<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
updateJob<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.MlUpdateJob<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

9
api/requestParams.d.ts vendored
View File

@ -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<T = RequestBody> extends Generic {
id: string;
body: T;
}
export interface MlUpdateDatafeed<T = RequestBody> extends Generic {
datafeed_id: string;
ignore_unavailable?: boolean;

32
docs/reference.asciidoc
View File

@ -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]

8
index.d.ts vendored
View File

@ -1778,6 +1778,14 @@ declare class Client {
stopDatafeed<TResponse = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stopDatafeed<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.MlStopDatafeed, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stopDatafeed<TResponse = Record<string, any>, TContext = unknown>(params: RequestParams.MlStopDatafeed, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
update_data_frame_analytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
update_data_frame_analytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
update_data_frame_analytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
update_data_frame_analytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
updateDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
updateDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
updateDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
updateDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
update_datafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params?: RequestParams.MlUpdateDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
update_datafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
update_datafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = unknown>(params: RequestParams.MlUpdateDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback