API generation
This commit is contained in:
86
api/api/indices.data_streams_stats.js
Normal file
86
api/api/indices.data_streams_stats.js
Normal file
@ -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 buildIndicesDataStreamsStats (opts) {
|
||||||
|
// eslint-disable-next-line no-unused-vars
|
||||||
|
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
|
||||||
|
|
||||||
|
const acceptedQuerystring = [
|
||||||
|
'expand_wildcards',
|
||||||
|
'forbid_closed_indices',
|
||||||
|
'pretty',
|
||||||
|
'human',
|
||||||
|
'error_trace',
|
||||||
|
'source',
|
||||||
|
'filter_path'
|
||||||
|
]
|
||||||
|
|
||||||
|
const snakeCase = {
|
||||||
|
expandWildcards: 'expand_wildcards',
|
||||||
|
forbidClosedIndices: 'forbid_closed_indices',
|
||||||
|
errorTrace: 'error_trace',
|
||||||
|
filterPath: 'filter_path'
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Perform a indices.data_streams_stats request
|
||||||
|
* Provides statistics on operations happening in a data stream.
|
||||||
|
* https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
|
||||||
|
*/
|
||||||
|
return function indicesDataStreamsStats (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 = 'GET'
|
||||||
|
path = '/' + '_data_stream' + '/' + encodeURIComponent(name) + '/' + '_stats'
|
||||||
|
} else {
|
||||||
|
if (method == null) method = 'GET'
|
||||||
|
path = '/' + '_data_stream' + '/' + '_stats'
|
||||||
|
}
|
||||||
|
|
||||||
|
// build request object
|
||||||
|
const request = {
|
||||||
|
method,
|
||||||
|
path,
|
||||||
|
body: null,
|
||||||
|
querystring
|
||||||
|
}
|
||||||
|
|
||||||
|
options.warnings = warnings.length === 0 ? null : warnings
|
||||||
|
return makeRequest(request, options, callback)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = buildIndicesDataStreamsStats
|
||||||
@ -18,6 +18,7 @@ function buildIndicesPutMapping (opts) {
|
|||||||
'ignore_unavailable',
|
'ignore_unavailable',
|
||||||
'allow_no_indices',
|
'allow_no_indices',
|
||||||
'expand_wildcards',
|
'expand_wildcards',
|
||||||
|
'write_index_only',
|
||||||
'pretty',
|
'pretty',
|
||||||
'human',
|
'human',
|
||||||
'error_trace',
|
'error_trace',
|
||||||
@ -31,6 +32,7 @@ function buildIndicesPutMapping (opts) {
|
|||||||
ignoreUnavailable: 'ignore_unavailable',
|
ignoreUnavailable: 'ignore_unavailable',
|
||||||
allowNoIndices: 'allow_no_indices',
|
allowNoIndices: 'allow_no_indices',
|
||||||
expandWildcards: 'expand_wildcards',
|
expandWildcards: 'expand_wildcards',
|
||||||
|
writeIndexOnly: 'write_index_only',
|
||||||
errorTrace: 'error_trace',
|
errorTrace: 'error_trace',
|
||||||
filterPath: 'filter_path'
|
filterPath: 'filter_path'
|
||||||
}
|
}
|
||||||
|
|||||||
@ -215,6 +215,8 @@ function ESAPI (opts) {
|
|||||||
create: lazyLoad('indices.create', opts),
|
create: lazyLoad('indices.create', opts),
|
||||||
create_data_stream: lazyLoad('indices.create_data_stream', opts),
|
create_data_stream: lazyLoad('indices.create_data_stream', opts),
|
||||||
createDataStream: lazyLoad('indices.create_data_stream', opts),
|
createDataStream: lazyLoad('indices.create_data_stream', opts),
|
||||||
|
data_streams_stats: lazyLoad('indices.data_streams_stats', opts),
|
||||||
|
dataStreamsStats: lazyLoad('indices.data_streams_stats', opts),
|
||||||
delete: lazyLoad('indices.delete', opts),
|
delete: lazyLoad('indices.delete', opts),
|
||||||
delete_alias: lazyLoad('indices.delete_alias', opts),
|
delete_alias: lazyLoad('indices.delete_alias', opts),
|
||||||
deleteAlias: lazyLoad('indices.delete_alias', opts),
|
deleteAlias: lazyLoad('indices.delete_alias', opts),
|
||||||
|
|||||||
1
api/kibana.d.ts
vendored
1
api/kibana.d.ts
vendored
@ -188,6 +188,7 @@ interface KibanaClient {
|
|||||||
close<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesClose, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
close<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesClose, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
create<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesCreate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
create<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesCreate<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
createDataStream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesCreateDataStream<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
createDataStream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesCreateDataStream<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
|
dataStreamsStats<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDataStreamsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
delete<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
delete<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
deleteAlias<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDeleteAlias, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
deleteAlias<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDeleteAlias, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
deleteDataStream<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDeleteDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
deleteDataStream<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDeleteDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
|
|||||||
7
api/requestParams.d.ts
vendored
7
api/requestParams.d.ts
vendored
@ -656,6 +656,12 @@ export interface IndicesCreateDataStream<T = RequestBody> extends Generic {
|
|||||||
body?: T;
|
body?: T;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface IndicesDataStreamsStats extends Generic {
|
||||||
|
name?: string | string[];
|
||||||
|
expand_wildcards?: 'open' | 'closed' | 'hidden' | 'none' | 'all';
|
||||||
|
forbid_closed_indices?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
export interface IndicesDelete extends Generic {
|
export interface IndicesDelete extends Generic {
|
||||||
index: string | string[];
|
index: string | string[];
|
||||||
timeout?: string;
|
timeout?: string;
|
||||||
@ -873,6 +879,7 @@ export interface IndicesPutMapping<T = RequestBody> extends Generic {
|
|||||||
ignore_unavailable?: boolean;
|
ignore_unavailable?: boolean;
|
||||||
allow_no_indices?: boolean;
|
allow_no_indices?: boolean;
|
||||||
expand_wildcards?: 'open' | 'closed' | 'hidden' | 'none' | 'all';
|
expand_wildcards?: 'open' | 'closed' | 'hidden' | 'none' | 'all';
|
||||||
|
write_index_only?: boolean;
|
||||||
body: T;
|
body: T;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -2473,7 +2473,7 @@ client.indices.addBlock({
|
|||||||
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all'
|
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all'
|
||||||
})
|
})
|
||||||
----
|
----
|
||||||
|
link:{ref}/indices-blocks.html[Documentation] +
|
||||||
[cols=2*]
|
[cols=2*]
|
||||||
|===
|
|===
|
||||||
|`index`
|
|`index`
|
||||||
@ -2698,6 +2698,32 @@ link:{ref}/data-streams.html[Documentation] +
|
|||||||
|
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
=== indices.dataStreamsStats
|
||||||
|
*Stability:* experimental
|
||||||
|
[source,ts]
|
||||||
|
----
|
||||||
|
client.indices.dataStreamsStats({
|
||||||
|
name: string | string[],
|
||||||
|
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all',
|
||||||
|
forbid_closed_indices: boolean
|
||||||
|
})
|
||||||
|
----
|
||||||
|
link:{ref}/data-streams.html[Documentation] +
|
||||||
|
[cols=2*]
|
||||||
|
|===
|
||||||
|
|`name`
|
||||||
|
|`string \| string[]` - A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams
|
||||||
|
|
||||||
|
|`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`
|
||||||
|
|
||||||
|
|`forbid_closed_indices` or `forbidClosedIndices`
|
||||||
|
|`boolean` - If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices +
|
||||||
|
_Default:_ `true`
|
||||||
|
|
||||||
|
|===
|
||||||
|
|
||||||
=== indices.delete
|
=== indices.delete
|
||||||
|
|
||||||
[source,ts]
|
[source,ts]
|
||||||
@ -3563,6 +3589,7 @@ client.indices.putMapping({
|
|||||||
ignore_unavailable: boolean,
|
ignore_unavailable: boolean,
|
||||||
allow_no_indices: boolean,
|
allow_no_indices: boolean,
|
||||||
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all',
|
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all',
|
||||||
|
write_index_only: boolean,
|
||||||
body: object
|
body: object
|
||||||
})
|
})
|
||||||
----
|
----
|
||||||
@ -3596,6 +3623,9 @@ WARNING: This parameter has been deprecated.
|
|||||||
|`'open' \| 'closed' \| 'hidden' \| '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`
|
_Default:_ `open`
|
||||||
|
|
||||||
|
|`write_index_only` or `writeIndexOnly`
|
||||||
|
|`boolean` - When true, applies mappings only to the write index of an alias or data stream
|
||||||
|
|
||||||
|`body`
|
|`body`
|
||||||
|`object` - The mapping definition
|
|`object` - The mapping definition
|
||||||
|
|
||||||
@ -3748,7 +3778,7 @@ client.indices.resolveIndex({
|
|||||||
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all'
|
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all'
|
||||||
})
|
})
|
||||||
----
|
----
|
||||||
|
link:{ref}/indices-resolve-index.html[Documentation] +
|
||||||
[cols=2*]
|
[cols=2*]
|
||||||
|===
|
|===
|
||||||
|`name`
|
|`name`
|
||||||
|
|||||||
8
index.d.ts
vendored
8
index.d.ts
vendored
@ -844,6 +844,14 @@ declare class Client {
|
|||||||
createDataStream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
createDataStream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
createDataStream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreateDataStream<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
createDataStream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreateDataStream<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
createDataStream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreateDataStream<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
createDataStream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreateDataStream<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
|
data_streams_stats<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDataStreamsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
|
data_streams_stats<TResponse = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
|
data_streams_stats<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.IndicesDataStreamsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
|
data_streams_stats<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.IndicesDataStreamsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
|
dataStreamsStats<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDataStreamsStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
|
dataStreamsStats<TResponse = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
|
dataStreamsStats<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.IndicesDataStreamsStats, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
|
dataStreamsStats<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.IndicesDataStreamsStats, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
delete<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
delete<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDelete, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
|
||||||
delete<TResponse = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
delete<TResponse = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
delete<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.IndicesDelete, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
delete<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.IndicesDelete, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
|
||||||
|
|||||||
Reference in New Issue
Block a user