API generation

This commit is contained in:
delvedor
2021-04-07 14:16:52 +02:00
parent e198511327
commit 93231e621e
24 changed files with 1255 additions and 646 deletions

View File

@ -2324,8 +2324,8 @@ link:{ref}/cluster-reroute.html[Documentation] +
[source,ts]
----
client.cluster.state({
metric: string | string[],
index: string | string[],
metric: string | string[],
local: boolean,
master_timeout: string,
flat_settings: boolean,
@ -2339,12 +2339,12 @@ client.cluster.state({
link:{ref}/cluster-state.html[Documentation] +
[cols=2*]
|===
|`metric`
|`string \| string[]` - Limit the information returned to the specified metrics
|`index`
|`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|`metric`
|`string \| string[]` - Limit the information returned to the specified metrics
|`local`
|`boolean` - Return local information, do not retrieve the state from master node (default: false)
@ -3277,7 +3277,7 @@ client.features.getFeatures({
master_timeout: string
})
----
link:{ref}/modules-snapshots.html[Documentation] +
link:{ref}/get-features-api.html[Documentation] +
[cols=2*]
|===
|`master_timeout` or `masterTimeout`
@ -5798,6 +5798,16 @@ link:{ref}/delete-pipeline-api.html[Documentation] +
|===
[discrete]
=== ingest.geoIpStats
[source,ts]
----
client.ingest.geoIpStats()
----
link:{ref}/geoip-stats-api.html[Documentation] +
[discrete]
=== ingest.getPipeline
@ -6487,6 +6497,82 @@ link:{ref}/explain-dfanalytics.html[Documentation] +
|===
[discrete]
=== ml.findFileStructure
*Stability:* experimental
[source,ts]
----
client.ml.findFileStructure({
lines_to_sample: number,
line_merge_size_limit: number,
timeout: string,
charset: string,
format: 'ndjson' | 'xml' | 'delimited' | 'semi_structured_text',
has_header_row: boolean,
column_names: string | string[],
delimiter: string,
quote: string,
should_trim_fields: boolean,
grok_pattern: string,
timestamp_field: string,
timestamp_format: string,
explain: boolean,
body: object
})
----
link:{ref}/find-structure.html[Documentation] +
[cols=2*]
|===
|`lines_to_sample` or `linesToSample`
|`number` - How many lines of the file should be included in the analysis +
_Default:_ `1000`
|`line_merge_size_limit` or `lineMergeSizeLimit`
|`number` - Maximum number of characters permitted in a single message when lines are merged to create messages. +
_Default:_ `10000`
|`timeout`
|`string` - Timeout after which the analysis will be aborted +
_Default:_ `25s`
|`charset`
|`string` - Optional parameter to specify the character set of the file
|`format`
|`'ndjson' \| 'xml' \| 'delimited' \| 'semi_structured_text'` - Optional parameter to specify the high level file format
|`has_header_row` or `hasHeaderRow`
|`boolean` - Optional parameter to specify whether a delimited file includes the column names in its first row
|`column_names` or `columnNames`
|`string \| string[]` - Optional parameter containing a comma separated list of the column names for a delimited file
|`delimiter`
|`string` - Optional parameter to specify the delimiter character for a delimited file - must be a single character
|`quote`
|`string` - Optional parameter to specify the quote character for a delimited file - must be a single character
|`should_trim_fields` or `shouldTrimFields`
|`boolean` - Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
|`grok_pattern` or `grokPattern`
|`string` - Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
|`timestamp_field` or `timestampField`
|`string` - Optional parameter to specify the timestamp field in the file
|`timestamp_format` or `timestampFormat`
|`string` - Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
|`explain`
|`boolean` - Whether to include a commentary on how the structure was derived
|`body`
|`object` - The contents of the file to be analyzed
|===
[discrete]
=== ml.flushJob
@ -7331,7 +7417,8 @@ link:{ref}/preview-dfanalytics.html[Documentation] +
[source,ts]
----
client.ml.previewDatafeed({
datafeed_id: string
datafeed_id: string,
body: object
})
----
link:{ref}/ml-preview-datafeed.html[Documentation] +
@ -7340,6 +7427,9 @@ link:{ref}/ml-preview-datafeed.html[Documentation] +
|`datafeed_id` or `datafeedId`
|`string` - The ID of the datafeed to preview
|`body`
|`object` - The datafeed config and job config with which to execute the preview
|===
[discrete]
@ -9753,6 +9843,61 @@ link:{ref}/security-api-put-user.html[Documentation] +
|===
[discrete]
=== shutdown.deleteNode
*Stability:* experimental
[source,ts]
----
client.shutdown.deleteNode({
node_id: string
})
----
link:https://www.elastic.co/guide/en/elasticsearch/reference/current[Documentation] +
[cols=2*]
|===
|`node_id` or `nodeId`
|`string` - The node id of node to be removed from the shutdown state
|===
[discrete]
=== shutdown.getNode
*Stability:* experimental
[source,ts]
----
client.shutdown.getNode({
node_id: string
})
----
link:https://www.elastic.co/guide/en/elasticsearch/reference/current[Documentation] +
[cols=2*]
|===
|`node_id` or `nodeId`
|`string` - Which node for which to retrieve the shutdown status
|===
[discrete]
=== shutdown.putNode
*Stability:* experimental
[source,ts]
----
client.shutdown.putNode({
node_id: string,
body: object
})
----
link:https://www.elastic.co/guide/en/elasticsearch/reference/current[Documentation] +
[cols=2*]
|===
|`node_id` or `nodeId`
|`string` - The node id of node to be shut down
|`body`
|`object` - The shutdown type definition to register
|===
[discrete]
=== slm.deleteLifecycle
@ -10439,7 +10584,7 @@ _Default:_ `true`
[discrete]
=== textStructure.findStructure
*Stability:* experimental
[source,ts]
----
client.textStructure.findStructure({