From 59ab125f48830ae1cb74903d712225a7b6c47699 Mon Sep 17 00:00:00 2001 From: delvedor Date: Mon, 8 Jun 2020 09:30:11 +0200 Subject: [PATCH] API generation --- api/api/ml.delete_data_frame_analytics.js | 3 ++- api/api/ml.delete_expired_data.js | 15 +++++++++++---- api/api/ml.get_categories.js | 5 +++-- api/requestParams.d.ts | 5 +++++ docs/reference.asciidoc | 22 +++++++++++++++++++++- 5 files changed, 42 insertions(+), 8 deletions(-) diff --git a/api/api/ml.delete_data_frame_analytics.js b/api/api/ml.delete_data_frame_analytics.js index a067f15ba..6b7143b59 100644 --- a/api/api/ml.delete_data_frame_analytics.js +++ b/api/api/ml.delete_data_frame_analytics.js @@ -12,7 +12,8 @@ function buildMlDeleteDataFrameAnalytics (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ - 'force' + 'force', + 'timeout' ] const snakeCase = { diff --git a/api/api/ml.delete_expired_data.js b/api/api/ml.delete_expired_data.js index a9fa3368d..7300fd58d 100644 --- a/api/api/ml.delete_expired_data.js +++ b/api/api/ml.delete_expired_data.js @@ -12,10 +12,12 @@ function buildMlDeleteExpiredData (opts) { const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts const acceptedQuerystring = [ - + 'requests_per_second', + 'timeout' ] const snakeCase = { + requestsPerSecond: 'requests_per_second' } @@ -43,7 +45,7 @@ function buildMlDeleteExpiredData (opts) { } var warnings = [] - var { method, body, ...querystring } = params + var { method, body, jobId, job_id, ...querystring } = params querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings) var ignore = options.ignore @@ -53,8 +55,13 @@ function buildMlDeleteExpiredData (opts) { var path = '' - if (method == null) method = 'DELETE' - path = '/' + '_ml' + '/' + '_delete_expired_data' + if ((job_id || jobId) != null) { + if (method == null) method = 'DELETE' + path = '/' + '_ml' + '/' + '_delete_expired_data' + '/' + encodeURIComponent(job_id || jobId) + } else { + if (method == null) method = 'DELETE' + path = '/' + '_ml' + '/' + '_delete_expired_data' + } // build request object const request = { diff --git a/api/api/ml.get_categories.js b/api/api/ml.get_categories.js index 68250b7c9..465629a73 100644 --- a/api/api/ml.get_categories.js +++ b/api/api/ml.get_categories.js @@ -13,11 +13,12 @@ function buildMlGetCategories (opts) { const acceptedQuerystring = [ 'from', - 'size' + 'size', + 'partition_field_value' ] const snakeCase = { - + partitionFieldValue: 'partition_field_value' } /** diff --git a/api/requestParams.d.ts b/api/requestParams.d.ts index 7e2ad41a6..fc907a83d 100644 --- a/api/requestParams.d.ts +++ b/api/requestParams.d.ts @@ -1809,6 +1809,7 @@ export interface MlDeleteCalendarJob extends Generic { export interface MlDeleteDataFrameAnalytics extends Generic { id: string; force?: boolean; + timeout?: string; } export interface MlDeleteDatafeed extends Generic { @@ -1817,6 +1818,9 @@ export interface MlDeleteDatafeed extends Generic { } export interface MlDeleteExpiredData extends Generic { + job_id?: string; + requests_per_second?: number; + timeout?: string; body?: T; } @@ -1930,6 +1934,7 @@ export interface MlGetCategories extends Generic { category_id?: number; from?: number; size?: number; + partition_field_value?: string; body?: T; } diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 70e731750..725e197ad 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -7250,7 +7250,8 @@ link:{ref}/ml-delete-calendar-job.html[Documentation] + ---- client.ml.deleteDataFrameAnalytics({ id: string, - force: boolean + force: boolean, + timeout: string }) ---- link:{ref}/delete-dfanalytics.html[Documentation] + @@ -7262,6 +7263,9 @@ link:{ref}/delete-dfanalytics.html[Documentation] + |`force` |`boolean` - True if the job should be forcefully deleted +|`timeout` +|`string` - Controls the time to wait until a job is deleted. Defaults to 1 minute + |=== === ml.deleteDatafeed @@ -7289,12 +7293,24 @@ link:{ref}/ml-delete-datafeed.html[Documentation] + [source,ts] ---- client.ml.deleteExpiredData({ + job_id: string, + requests_per_second: number, + timeout: string, body: object }) ---- link:{ref}/ml-delete-expired-data.html[Documentation] + [cols=2*] |=== +|`job_id` or `jobId` +|`string` - The ID of the job(s) to perform expired data hygiene for + +|`requests_per_second` or `requestsPerSecond` +|`number` - The desired requests per second for the deletion processes. + +|`timeout` +|`string` - How long can the underlying delete processes run until they are canceled + |`body` |`object` - deleting expired data parameters @@ -7733,6 +7749,7 @@ client.ml.getCategories({ category_id: number, from: number, size: number, + partition_field_value: string, body: object }) ---- @@ -7751,6 +7768,9 @@ link:{ref}/ml-get-category.html[Documentation] + |`size` |`number` - specifies a max number of categories to get +|`partition_field_value` or `partitionFieldValue` +|`string` - Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled. + |`body` |`object` - Category selection details if not provided in URI