API generation

This commit is contained in:
delvedor
2020-09-01 14:10:26 +02:00
parent 00aeb8b923
commit 7a407c411d
17 changed files with 124 additions and 48 deletions

View File

@ -27,6 +27,7 @@ function buildCatMlDatafeeds (opts) {
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [ const acceptedQuerystring = [
'allow_no_match',
'allow_no_datafeeds', 'allow_no_datafeeds',
'format', 'format',
'h', 'h',
@ -37,6 +38,7 @@ function buildCatMlDatafeeds (opts) {
] ]
const snakeCase = { const snakeCase = {
allowNoMatch: 'allow_no_match',
allowNoDatafeeds: 'allow_no_datafeeds' allowNoDatafeeds: 'allow_no_datafeeds'
} }

View File

@ -27,6 +27,7 @@ function buildCatMlJobs (opts) {
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [ const acceptedQuerystring = [
'allow_no_match',
'allow_no_jobs', 'allow_no_jobs',
'bytes', 'bytes',
'format', 'format',
@ -38,6 +39,7 @@ function buildCatMlJobs (opts) {
] ]
const snakeCase = { const snakeCase = {
allowNoMatch: 'allow_no_match',
allowNoJobs: 'allow_no_jobs' allowNoJobs: 'allow_no_jobs'
} }

View File

@ -51,7 +51,7 @@ function buildIndicesAddBlock (opts) {
/** /**
* Perform a indices.add_block request * Perform a indices.add_block request
* Adds a block to an index. * 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) { return function indicesAddBlock (params, options, callback) {
options = options || {} options = options || {}

View File

@ -36,7 +36,7 @@ function buildIndicesCreateDataStream (opts) {
/** /**
* Perform a indices.create_data_stream request * 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 * https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
*/ */
return function indicesCreateDataStream (params, options, callback) { return function indicesCreateDataStream (params, options, callback) {

View File

@ -79,13 +79,8 @@ function buildIndicesFlushSynced (opts) {
var path = '' var path = ''
if ((index) != null) { if (method == null) method = body == null ? 'GET' : 'POST'
if (method == null) method = body == null ? 'GET' : 'POST' path = '/' + encodeURIComponent(index) + '/' + '_flush' + '/' + 'synced'
path = '/' + encodeURIComponent(index) + '/' + '_flush' + '/' + 'synced'
} else {
if (method == null) method = body == null ? 'GET' : 'POST'
path = '/' + '_flush' + '/' + 'synced'
}
// build request object // build request object
const request = { const request = {

View File

@ -44,7 +44,7 @@ function buildIndicesResolveIndex (opts) {
/** /**
* Perform a indices.resolve_index request * Perform a indices.resolve_index request
* Returns information about any matching indices, aliases, and data streams * 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) { return function indicesResolveIndex (params, options, callback) {
options = options || {} options = options || {}

View File

@ -27,12 +27,14 @@ function buildMlCloseJob (opts) {
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [ const acceptedQuerystring = [
'allow_no_match',
'allow_no_jobs', 'allow_no_jobs',
'force', 'force',
'timeout' 'timeout'
] ]
const snakeCase = { const snakeCase = {
allowNoMatch: 'allow_no_match',
allowNoJobs: 'allow_no_jobs' allowNoJobs: 'allow_no_jobs'
} }

View File

@ -27,10 +27,12 @@ function buildMlGetDatafeedStats (opts) {
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [ const acceptedQuerystring = [
'allow_no_match',
'allow_no_datafeeds' 'allow_no_datafeeds'
] ]
const snakeCase = { const snakeCase = {
allowNoMatch: 'allow_no_match',
allowNoDatafeeds: 'allow_no_datafeeds' allowNoDatafeeds: 'allow_no_datafeeds'
} }

View File

@ -27,10 +27,12 @@ function buildMlGetDatafeeds (opts) {
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [ const acceptedQuerystring = [
'allow_no_match',
'allow_no_datafeeds' 'allow_no_datafeeds'
] ]
const snakeCase = { const snakeCase = {
allowNoMatch: 'allow_no_match',
allowNoDatafeeds: 'allow_no_datafeeds' allowNoDatafeeds: 'allow_no_datafeeds'
} }

View File

@ -27,10 +27,12 @@ function buildMlGetJobStats (opts) {
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [ const acceptedQuerystring = [
'allow_no_match',
'allow_no_jobs' 'allow_no_jobs'
] ]
const snakeCase = { const snakeCase = {
allowNoMatch: 'allow_no_match',
allowNoJobs: 'allow_no_jobs' allowNoJobs: 'allow_no_jobs'
} }

View File

@ -27,10 +27,12 @@ function buildMlGetJobs (opts) {
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [ const acceptedQuerystring = [
'allow_no_match',
'allow_no_jobs' 'allow_no_jobs'
] ]
const snakeCase = { const snakeCase = {
allowNoMatch: 'allow_no_match',
allowNoJobs: 'allow_no_jobs' allowNoJobs: 'allow_no_jobs'
} }

View File

@ -33,6 +33,7 @@ function buildMlGetOverallBuckets (opts) {
'exclude_interim', 'exclude_interim',
'start', 'start',
'end', 'end',
'allow_no_match',
'allow_no_jobs' 'allow_no_jobs'
] ]
@ -41,6 +42,7 @@ function buildMlGetOverallBuckets (opts) {
bucketSpan: 'bucket_span', bucketSpan: 'bucket_span',
overallScore: 'overall_score', overallScore: 'overall_score',
excludeInterim: 'exclude_interim', excludeInterim: 'exclude_interim',
allowNoMatch: 'allow_no_match',
allowNoJobs: 'allow_no_jobs' allowNoJobs: 'allow_no_jobs'
} }

View File

@ -27,12 +27,14 @@ function buildMlStopDatafeed (opts) {
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
const acceptedQuerystring = [ const acceptedQuerystring = [
'allow_no_match',
'allow_no_datafeeds', 'allow_no_datafeeds',
'force', 'force',
'timeout' 'timeout'
] ]
const snakeCase = { const snakeCase = {
allowNoMatch: 'allow_no_match',
allowNoDatafeeds: 'allow_no_datafeeds' allowNoDatafeeds: 'allow_no_datafeeds'
} }

4
api/kibana.d.ts vendored
View File

@ -202,7 +202,7 @@ interface KibanaClient {
clone<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesClone<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> clone<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesClone<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
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>, TContext = Context>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
dataStreamsStats<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesDataStreamsStats, 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>>
@ -324,7 +324,7 @@ interface KibanaClient {
startDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlStartDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> startDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlStartDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
startDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlStartDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> startDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlStartDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
stopDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlStopDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> stopDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlStopDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
stopDatafeed<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> stopDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlStopDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
updateDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> updateDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
updateDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlUpdateDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> updateDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlUpdateDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
updateFilter<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlUpdateFilter<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> updateFilter<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlUpdateFilter<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

View File

@ -1552,6 +1552,7 @@ export interface CatMlDataFrameAnalytics extends Generic {
export interface CatMlDatafeeds extends Generic { export interface CatMlDatafeeds extends Generic {
datafeed_id?: string; datafeed_id?: string;
allow_no_match?: boolean;
allow_no_datafeeds?: boolean; allow_no_datafeeds?: boolean;
format?: string; format?: string;
h?: string | string[]; h?: string | string[];
@ -1563,6 +1564,7 @@ export interface CatMlDatafeeds extends Generic {
export interface CatMlJobs extends Generic { export interface CatMlJobs extends Generic {
job_id?: string; job_id?: string;
allow_no_match?: boolean;
allow_no_jobs?: boolean; allow_no_jobs?: boolean;
bytes?: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb'; bytes?: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb';
format?: string; format?: string;
@ -1744,9 +1746,8 @@ export interface IlmStart extends Generic {
export interface IlmStop extends Generic { export interface IlmStop extends Generic {
} }
export interface IndicesCreateDataStream<T = RequestBody> extends Generic { export interface IndicesCreateDataStream extends Generic {
name: string; name: string;
body?: T;
} }
export interface IndicesDataStreamsStats extends Generic { export interface IndicesDataStreamsStats extends Generic {
@ -1822,6 +1823,7 @@ export interface MigrationDeprecations extends Generic {
export interface MlCloseJob<T = RequestBody> extends Generic { export interface MlCloseJob<T = RequestBody> extends Generic {
job_id: string; job_id: string;
allow_no_match?: boolean;
allow_no_jobs?: boolean; allow_no_jobs?: boolean;
force?: boolean; force?: boolean;
timeout?: string; timeout?: string;
@ -1991,11 +1993,13 @@ export interface MlGetDataFrameAnalyticsStats extends Generic {
export interface MlGetDatafeedStats extends Generic { export interface MlGetDatafeedStats extends Generic {
datafeed_id?: string; datafeed_id?: string;
allow_no_match?: boolean;
allow_no_datafeeds?: boolean; allow_no_datafeeds?: boolean;
} }
export interface MlGetDatafeeds extends Generic { export interface MlGetDatafeeds extends Generic {
datafeed_id?: string; datafeed_id?: string;
allow_no_match?: boolean;
allow_no_datafeeds?: boolean; allow_no_datafeeds?: boolean;
} }
@ -2020,11 +2024,13 @@ export interface MlGetInfluencers<T = RequestBody> extends Generic {
export interface MlGetJobStats extends Generic { export interface MlGetJobStats extends Generic {
job_id?: string; job_id?: string;
allow_no_match?: boolean;
allow_no_jobs?: boolean; allow_no_jobs?: boolean;
} }
export interface MlGetJobs extends Generic { export interface MlGetJobs extends Generic {
job_id?: string; job_id?: string;
allow_no_match?: boolean;
allow_no_jobs?: boolean; allow_no_jobs?: boolean;
} }
@ -2048,6 +2054,7 @@ export interface MlGetOverallBuckets<T = RequestBody> extends Generic {
exclude_interim?: boolean; exclude_interim?: boolean;
start?: string; start?: string;
end?: string; end?: string;
allow_no_match?: boolean;
allow_no_jobs?: boolean; allow_no_jobs?: boolean;
body?: T; body?: T;
} }
@ -2179,11 +2186,13 @@ export interface MlStopDataFrameAnalytics<T = RequestBody> extends Generic {
body?: T; body?: T;
} }
export interface MlStopDatafeed extends Generic { export interface MlStopDatafeed<T = RequestBody> extends Generic {
datafeed_id: string; datafeed_id: string;
allow_no_match?: boolean;
allow_no_datafeeds?: boolean; allow_no_datafeeds?: boolean;
force?: boolean; force?: boolean;
timeout?: string; timeout?: string;
body?: T;
} }
export interface MlUpdateDataFrameAnalytics<T = RequestBody> extends Generic { export interface MlUpdateDataFrameAnalytics<T = RequestBody> extends Generic {

View File

@ -2481,7 +2481,7 @@ client.indices.addBlock({
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all' expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all'
}) })
---- ----
link:{ref}/index-modules-blocks.html[Documentation] +
[cols=2*] [cols=2*]
|=== |===
|`index` |`index`
@ -3708,7 +3708,7 @@ client.indices.resolveIndex({
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all' expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all'
}) })
---- ----
link:{ref}/indices-resolve-index-api.html[Documentation] +
[cols=2*] [cols=2*]
|=== |===
|`name` |`name`
@ -6303,6 +6303,7 @@ link:{ref}/cat-dfanalytics.html[Documentation] +
---- ----
client.cat.mlDatafeeds({ client.cat.mlDatafeeds({
datafeed_id: string, datafeed_id: string,
allow_no_match: boolean,
allow_no_datafeeds: boolean, allow_no_datafeeds: boolean,
format: string, format: string,
h: string | string[], h: string | string[],
@ -6318,9 +6319,14 @@ link:{ref}/cat-datafeeds.html[Documentation] +
|`datafeed_id` or `datafeedId` |`datafeed_id` or `datafeedId`
|`string` - The ID of the datafeeds stats to fetch |`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) |`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` |`format`
|`string` - a short version of the Accept header, e.g. json, yaml |`string` - a short version of the Accept header, e.g. json, yaml
@ -6347,6 +6353,7 @@ link:{ref}/cat-datafeeds.html[Documentation] +
---- ----
client.cat.mlJobs({ client.cat.mlJobs({
job_id: string, job_id: string,
allow_no_match: boolean,
allow_no_jobs: boolean, allow_no_jobs: boolean,
bytes: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb', bytes: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb',
format: string, format: string,
@ -6363,9 +6370,14 @@ link:{ref}/cat-anomaly-detectors.html[Documentation] +
|`job_id` or `jobId` |`job_id` or `jobId`
|`string` - The ID of the jobs stats to fetch |`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) |`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` |`bytes`
|`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values |`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
@ -7071,8 +7083,7 @@ link:{ref}/ilm-stop.html[Documentation] +
[source,ts] [source,ts]
---- ----
client.indices.createDataStream({ client.indices.createDataStream({
name: string, name: string
body: object
}) })
---- ----
link:{ref}/data-streams.html[Documentation] + link:{ref}/data-streams.html[Documentation] +
@ -7081,9 +7092,6 @@ link:{ref}/data-streams.html[Documentation] +
|`name` |`name`
|`string` - The name of the data stream |`string` - The name of the data stream
|`body`
|`object` - The data stream definition
|=== |===
=== indices.dataStreamsStats === indices.dataStreamsStats
@ -7370,6 +7378,7 @@ link:{ref}/migration-api-deprecation.html[Documentation] +
---- ----
client.ml.closeJob({ client.ml.closeJob({
job_id: string, job_id: string,
allow_no_match: boolean,
allow_no_jobs: boolean, allow_no_jobs: boolean,
force: boolean, force: boolean,
timeout: string, timeout: string,
@ -7382,9 +7391,14 @@ link:{ref}/ml-close-job.html[Documentation] +
|`job_id` or `jobId` |`job_id` or `jobId`
|`string` - The name of the job to close |`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) |`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` |`force`
|`boolean` - True if the job should be forcefully closed |`boolean` - True if the job should be forcefully closed
@ -8054,6 +8068,7 @@ _Default:_ `100`
---- ----
client.ml.getDatafeedStats({ client.ml.getDatafeedStats({
datafeed_id: string, datafeed_id: string,
allow_no_match: boolean,
allow_no_datafeeds: boolean allow_no_datafeeds: boolean
}) })
---- ----
@ -8063,9 +8078,14 @@ link:{ref}/ml-get-datafeed-stats.html[Documentation] +
|`datafeed_id` or `datafeedId` |`datafeed_id` or `datafeedId`
|`string` - The ID of the datafeeds stats to fetch |`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) |`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 === ml.getDatafeeds
@ -8074,6 +8094,7 @@ link:{ref}/ml-get-datafeed-stats.html[Documentation] +
---- ----
client.ml.getDatafeeds({ client.ml.getDatafeeds({
datafeed_id: string, datafeed_id: string,
allow_no_match: boolean,
allow_no_datafeeds: boolean allow_no_datafeeds: boolean
}) })
---- ----
@ -8083,9 +8104,14 @@ link:{ref}/ml-get-datafeed.html[Documentation] +
|`datafeed_id` or `datafeedId` |`datafeed_id` or `datafeedId`
|`string` - The ID of the datafeeds to fetch |`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) |`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 === ml.getFilters
@ -8170,6 +8196,7 @@ link:{ref}/ml-get-influencer.html[Documentation] +
---- ----
client.ml.getJobStats({ client.ml.getJobStats({
job_id: string, job_id: string,
allow_no_match: boolean,
allow_no_jobs: boolean allow_no_jobs: boolean
}) })
---- ----
@ -8179,9 +8206,14 @@ link:{ref}/ml-get-job-stats.html[Documentation] +
|`job_id` or `jobId` |`job_id` or `jobId`
|`string` - The ID of the jobs stats to fetch |`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) |`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 === ml.getJobs
@ -8190,6 +8222,7 @@ link:{ref}/ml-get-job-stats.html[Documentation] +
---- ----
client.ml.getJobs({ client.ml.getJobs({
job_id: string, job_id: string,
allow_no_match: boolean,
allow_no_jobs: boolean allow_no_jobs: boolean
}) })
---- ----
@ -8199,9 +8232,14 @@ link:{ref}/ml-get-job.html[Documentation] +
|`job_id` or `jobId` |`job_id` or `jobId`
|`string` - The ID of the jobs to fetch |`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) |`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 === ml.getModelSnapshots
@ -8264,6 +8302,7 @@ client.ml.getOverallBuckets({
exclude_interim: boolean, exclude_interim: boolean,
start: string, start: string,
end: string, end: string,
allow_no_match: boolean,
allow_no_jobs: boolean, allow_no_jobs: boolean,
body: object body: object
}) })
@ -8292,9 +8331,14 @@ link:{ref}/ml-get-overall-buckets.html[Documentation] +
|`end` |`end`
|`string` - Returns overall buckets with timestamps earlier than this time |`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) |`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` |`body`
|`object` - Overall bucket selection details if not provided in URI |`object` - Overall bucket selection details if not provided in URI
@ -8816,9 +8860,11 @@ link:{ref}/stop-dfanalytics.html[Documentation] +
---- ----
client.ml.stopDatafeed({ client.ml.stopDatafeed({
datafeed_id: string, datafeed_id: string,
allow_no_match: boolean,
allow_no_datafeeds: boolean, allow_no_datafeeds: boolean,
force: boolean, force: boolean,
timeout: string timeout: string,
body: object
}) })
---- ----
link:{ref}/ml-stop-datafeed.html[Documentation] + link:{ref}/ml-stop-datafeed.html[Documentation] +
@ -8827,15 +8873,23 @@ link:{ref}/ml-stop-datafeed.html[Documentation] +
|`datafeed_id` or `datafeedId` |`datafeed_id` or `datafeedId`
|`string` - The ID of the datafeed to stop |`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) |`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` |`force`
|`boolean` - True if the datafeed should be forcefully stopped. |`boolean` - True if the datafeed should be forcefully stopped.
|`timeout` |`timeout`
|`string` - Controls the time to wait until a datafeed has stopped. Default to 20 seconds |`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 === ml.updateDataFrameAnalytics

32
index.d.ts vendored
View File

@ -852,14 +852,14 @@ declare class Client {
create<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback create<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
create<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback create<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreate<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
create<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback create<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreate<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
create_data_stream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesCreateDataStream<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> create_data_stream<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
create_data_stream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback create_data_stream<TResponse = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
create_data_stream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreateDataStream<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback create_data_stream<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreateDataStream, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
create_data_stream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreateDataStream<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback create_data_stream<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.IndicesCreateDataStream, 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): TransportRequestPromise<ApiResponse<TResponse, TContext>> createDataStream<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
createDataStream<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback createDataStream<TResponse = 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>, TContext = Context>(params: RequestParams.IndicesCreateDataStream, 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>, TContext = Context>(params: RequestParams.IndicesCreateDataStream, 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>(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>(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, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
@ -1672,14 +1672,14 @@ declare class Client {
stopDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback stopDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stopDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback stopDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stopDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback stopDataFrameAnalytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDataFrameAnalytics<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stop_datafeed<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> stop_datafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlStopDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
stop_datafeed<TResponse = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback stop_datafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stop_datafeed<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDatafeed, callback: callbackFn<TResponse, TContext>): TransportRequestCallback stop_datafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stop_datafeed<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDatafeed, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback stop_datafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stopDatafeed<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>> stopDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.MlStopDatafeed<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
stopDatafeed<TResponse = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback stopDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stopDatafeed<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDatafeed, callback: callbackFn<TResponse, TContext>): TransportRequestCallback stopDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDatafeed<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
stopDatafeed<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDatafeed, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback stopDatafeed<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlStopDatafeed<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
update_data_frame_analytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(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 = Context>(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 = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback update_data_frame_analytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
update_data_frame_analytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback update_data_frame_analytics<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.MlUpdateDataFrameAnalytics<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback