Support for Elasticsearch 7.5 (#1015)
* API generation * X-Opaque-Id support (#997) * Added X-Opaque-Id support * Updated type definitions * Updated test * Updated docs * Skip data_frame_transform_deprecated.* apis * API generation * Fix docs link * Fix CI configuration * Added enrich_user to default roles * Added transform_admin ad transform_user to default roles
This commit is contained in:
Tomas Della Vedova
committed by
GitHub
GitHub
parent
da7220ad8a
commit
c0000aa207
@ -1,18 +1,12 @@
|
||||
[[api-reference]]
|
||||
== API Reference
|
||||
|
||||
This document contains the entire list of the {es} API supported by the client,
|
||||
both OSS and commercial. The client is entirely licensed under Apache 2.0.
|
||||
This document contains the entire list of the Elasticsearch API supported by the client, both OSS and commercial. The client is entirely licensed under Apache 2.0.
|
||||
|
||||
{es} exposes an HTTP layer to communicate with, and the client is a library that
|
||||
helps you do this. Because of this reason, you will see HTTP related parameters,
|
||||
such as `body` or `headers`.
|
||||
Elasticsearch exposes an HTTP layer to communicate with, and the client is a library that will help you do this. Because of this reason, you will see HTTP related parameters, such as `body` or `headers`.
|
||||
|
||||
Every API can accept two objects, the first contains all the parameters that
|
||||
will be sent to {es}, while the second includes the request specific parameters,
|
||||
such as timeouts, headers, and so on. In the first object, every parameter but
|
||||
the body will be sent via querystring or url parameter, depending on the API,
|
||||
and every unrecognized parameter will be sent as querystring.
|
||||
Every API can accept two objects, the first contains all the parameters that will be sent to Elasticsearch, while the second includes the request specific parameters, such as timeouts, headers, and so on.
|
||||
In the first object, every parameter but the body will be sent via querystring or url parameter, depending on the API, and every unrecognized parameter will be sent as querystring.
|
||||
|
||||
[source,js]
|
||||
----
|
||||
@ -41,10 +35,7 @@ client.search({
|
||||
})
|
||||
----
|
||||
|
||||
In this document, you will find the reference of every parameter accepted by the
|
||||
querystring or the url. If you also need to send the body, you can find the
|
||||
documentation of its format in the reference link that is present along with
|
||||
every endpoint.
|
||||
In this document, you will find the reference of every parameter accepted by the querystring or the url. If you also need to send the body, you can find the documentation of its format in the reference link that is present along with every endpoint.
|
||||
|
||||
////////
|
||||
|
||||
@ -142,7 +133,6 @@ client.cat.aliases({
|
||||
name: string | string[],
|
||||
format: string,
|
||||
local: boolean,
|
||||
master_timeout: string,
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
@ -161,9 +151,6 @@ link:{ref}/cat-alias.html[Reference]
|
||||
|`local`
|
||||
|`boolean` - Return local information, do not retrieve the state from master node (default: false)
|
||||
|
||||
|`master_timeout` or `masterTimeout`
|
||||
|`string` - Explicit operation timeout for connection to master node
|
||||
|
||||
|`h`
|
||||
|`string \| string[]` - Comma-separated list of column names to display
|
||||
|
||||
@ -233,8 +220,6 @@ link:{ref}/cat-allocation.html[Reference]
|
||||
client.cat.count({
|
||||
index: string | string[],
|
||||
format: string,
|
||||
local: boolean,
|
||||
master_timeout: string,
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
@ -250,12 +235,6 @@ link:{ref}/cat-count.html[Reference]
|
||||
|`format`
|
||||
|`string` - a short version of the Accept header, e.g. json, yaml
|
||||
|
||||
|`local`
|
||||
|`boolean` - Return local information, do not retrieve the state from master node (default: false)
|
||||
|
||||
|`master_timeout` or `masterTimeout`
|
||||
|`string` - Explicit operation timeout for connection to master node
|
||||
|
||||
|`h`
|
||||
|`string \| string[]` - Comma-separated list of column names to display
|
||||
|
||||
@ -278,8 +257,6 @@ client.cat.fielddata({
|
||||
fields: string | string[],
|
||||
format: string,
|
||||
bytes: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb',
|
||||
local: boolean,
|
||||
master_timeout: string,
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
@ -298,12 +275,6 @@ link:{ref}/cat-fielddata.html[Reference]
|
||||
|`bytes`
|
||||
|`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
|
||||
|
||||
|`local`
|
||||
|`boolean` - Return local information, do not retrieve the state from master node (default: false)
|
||||
|
||||
|`master_timeout` or `masterTimeout`
|
||||
|`string` - Explicit operation timeout for connection to master node
|
||||
|
||||
|`h`
|
||||
|`string \| string[]` - Comma-separated list of column names to display
|
||||
|
||||
@ -324,11 +295,10 @@ link:{ref}/cat-fielddata.html[Reference]
|
||||
----
|
||||
client.cat.health({
|
||||
format: string,
|
||||
local: boolean,
|
||||
master_timeout: string,
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)',
|
||||
ts: boolean,
|
||||
v: boolean
|
||||
})
|
||||
@ -339,12 +309,6 @@ link:{ref}/cat-health.html[Reference]
|
||||
|`format`
|
||||
|`string` - a short version of the Accept header, e.g. json, yaml
|
||||
|
||||
|`local`
|
||||
|`boolean` - Return local information, do not retrieve the state from master node (default: false)
|
||||
|
||||
|`master_timeout` or `masterTimeout`
|
||||
|`string` - Explicit operation timeout for connection to master node
|
||||
|
||||
|`h`
|
||||
|`string \| string[]` - Comma-separated list of column names to display
|
||||
|
||||
@ -354,6 +318,9 @@ link:{ref}/cat-health.html[Reference]
|
||||
|`s`
|
||||
|`string \| string[]` - Comma-separated list of column names or column aliases to sort by
|
||||
|
||||
|`time`
|
||||
|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values
|
||||
|
||||
|`ts`
|
||||
|`boolean` - Set to false to disable timestamping +
|
||||
_Default:_ `true`
|
||||
@ -398,6 +365,7 @@ client.cat.indices({
|
||||
help: boolean,
|
||||
pri: boolean,
|
||||
s: string | string[],
|
||||
time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)',
|
||||
v: boolean,
|
||||
include_unloaded_segments: boolean
|
||||
})
|
||||
@ -435,6 +403,9 @@ link:{ref}/cat-indices.html[Reference]
|
||||
|`s`
|
||||
|`string \| string[]` - Comma-separated list of column names or column aliases to sort by
|
||||
|
||||
|`time`
|
||||
|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values
|
||||
|
||||
|`v`
|
||||
|`boolean` - Verbose mode. Display column headers
|
||||
|
||||
@ -528,6 +499,7 @@ link:{ref}/cat-nodeattrs.html[Reference]
|
||||
[source,ts]
|
||||
----
|
||||
client.cat.nodes({
|
||||
bytes: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb',
|
||||
format: string,
|
||||
full_id: boolean,
|
||||
local: boolean,
|
||||
@ -535,12 +507,16 @@ client.cat.nodes({
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)',
|
||||
v: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/cat-nodes.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`bytes`
|
||||
|`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
|
||||
|
||||
|`format`
|
||||
|`string` - a short version of the Accept header, e.g. json, yaml
|
||||
|
||||
@ -562,6 +538,9 @@ link:{ref}/cat-nodes.html[Reference]
|
||||
|`s`
|
||||
|`string \| string[]` - Comma-separated list of column names or column aliases to sort by
|
||||
|
||||
|`time`
|
||||
|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values
|
||||
|
||||
|`v`
|
||||
|`boolean` - Verbose mode. Display column headers
|
||||
|
||||
@ -578,6 +557,7 @@ client.cat.pendingTasks({
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)',
|
||||
v: boolean
|
||||
})
|
||||
----
|
||||
@ -602,6 +582,9 @@ link:{ref}/cat-pending-tasks.html[Reference]
|
||||
|`s`
|
||||
|`string \| string[]` - Comma-separated list of column names or column aliases to sort by
|
||||
|
||||
|`time`
|
||||
|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values
|
||||
|
||||
|`v`
|
||||
|`boolean` - Verbose mode. Display column headers
|
||||
|
||||
@ -654,11 +637,13 @@ link:{ref}/cat-plugins.html[Reference]
|
||||
client.cat.recovery({
|
||||
index: string | string[],
|
||||
format: string,
|
||||
active_only: boolean,
|
||||
bytes: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb',
|
||||
master_timeout: string,
|
||||
detailed: boolean,
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)',
|
||||
v: boolean
|
||||
})
|
||||
----
|
||||
@ -666,16 +651,19 @@ link:{ref}/cat-recovery.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`index`
|
||||
|`string \| string[]` - A comma-separated list of index names to limit the returned information
|
||||
|`string \| string[]` - Comma-separated list or wildcard expression of index names to limit the returned information
|
||||
|
||||
|`format`
|
||||
|`string` - a short version of the Accept header, e.g. json, yaml
|
||||
|
||||
|`active_only` or `activeOnly`
|
||||
|`boolean` - If `true`, the response only includes ongoing shard recoveries
|
||||
|
||||
|`bytes`
|
||||
|`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
|
||||
|
||||
|`master_timeout` or `masterTimeout`
|
||||
|`string` - Explicit operation timeout for connection to master node
|
||||
|`detailed`
|
||||
|`boolean` - If `true`, the response includes detailed information about shard recoveries
|
||||
|
||||
|`h`
|
||||
|`string \| string[]` - Comma-separated list of column names to display
|
||||
@ -686,6 +674,9 @@ link:{ref}/cat-recovery.html[Reference]
|
||||
|`s`
|
||||
|`string \| string[]` - Comma-separated list of column names or column aliases to sort by
|
||||
|
||||
|`time`
|
||||
|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values
|
||||
|
||||
|`v`
|
||||
|`boolean` - Verbose mode. Display column headers
|
||||
|
||||
@ -784,6 +775,7 @@ client.cat.shards({
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)',
|
||||
v: boolean
|
||||
})
|
||||
----
|
||||
@ -814,6 +806,9 @@ link:{ref}/cat-shards.html[Reference]
|
||||
|`s`
|
||||
|`string \| string[]` - Comma-separated list of column names or column aliases to sort by
|
||||
|
||||
|`time`
|
||||
|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values
|
||||
|
||||
|`v`
|
||||
|`boolean` - Verbose mode. Display column headers
|
||||
|
||||
@ -831,6 +826,7 @@ client.cat.snapshots({
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)',
|
||||
v: boolean
|
||||
})
|
||||
----
|
||||
@ -858,6 +854,9 @@ link:{ref}/cat-snapshots.html[Reference]
|
||||
|`s`
|
||||
|`string \| string[]` - Comma-separated list of column names or column aliases to sort by
|
||||
|
||||
|`time`
|
||||
|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values
|
||||
|
||||
|`v`
|
||||
|`boolean` - Verbose mode. Display column headers
|
||||
|
||||
@ -876,6 +875,7 @@ client.cat.tasks({
|
||||
h: string | string[],
|
||||
help: boolean,
|
||||
s: string | string[],
|
||||
time: 'd (Days)' | 'h (Hours)' | 'm (Minutes)' | 's (Seconds)' | 'ms (Milliseconds)' | 'micros (Microseconds)' | 'nanos (Nanoseconds)',
|
||||
v: boolean
|
||||
})
|
||||
----
|
||||
@ -906,6 +906,9 @@ link:{ref}/tasks.html[Reference]
|
||||
|`s`
|
||||
|`string \| string[]` - Comma-separated list of column names or column aliases to sort by
|
||||
|
||||
|`time`
|
||||
|`'d (Days)' \| 'h (Hours)' \| 'm (Minutes)' \| 's (Seconds)' \| 'ms (Milliseconds)' \| 'micros (Microseconds)' \| 'nanos (Nanoseconds)'` - The unit in which to display time values
|
||||
|
||||
|`v`
|
||||
|`boolean` - Verbose mode. Display column headers
|
||||
|
||||
@ -1408,7 +1411,7 @@ client.create({
|
||||
routing: string,
|
||||
timeout: string,
|
||||
version: number,
|
||||
version_type: 'internal' | 'external' | 'external_gte' | 'force',
|
||||
version_type: 'internal' | 'external' | 'external_gte',
|
||||
pipeline: string,
|
||||
body: object
|
||||
})
|
||||
@ -1443,7 +1446,7 @@ WARNING: This parameter has been deprecated.
|
||||
|`number` - Explicit version number for concurrency control
|
||||
|
||||
|`version_type` or `versionType`
|
||||
|`'internal' \| 'external' \| 'external_gte' \| 'force'` - Specific version type
|
||||
|`'internal' \| 'external' \| 'external_gte'` - Specific version type
|
||||
|
||||
|`pipeline`
|
||||
|`string` - The pipeline id to preprocess incoming documents with
|
||||
@ -2119,7 +2122,7 @@ client.index({
|
||||
routing: string,
|
||||
timeout: string,
|
||||
version: number,
|
||||
version_type: 'internal' | 'external' | 'external_gte' | 'force',
|
||||
version_type: 'internal' | 'external' | 'external_gte',
|
||||
if_seq_no: number,
|
||||
if_primary_term: number,
|
||||
pipeline: string,
|
||||
@ -2144,8 +2147,7 @@ WARNING: This parameter has been deprecated.
|
||||
|`string` - Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
|
||||
|
||||
|`op_type` or `opType`
|
||||
|`'index' \| 'create'` - Explicit operation type +
|
||||
_Default:_ `index`
|
||||
|`'index' \| 'create'` - Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID
|
||||
|
||||
|`refresh`
|
||||
|`'true' \| 'false' \| 'wait_for'` - If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
|
||||
@ -2160,7 +2162,7 @@ _Default:_ `index`
|
||||
|`number` - Explicit version number for concurrency control
|
||||
|
||||
|`version_type` or `versionType`
|
||||
|`'internal' \| 'external' \| 'external_gte' \| 'force'` - Specific version type
|
||||
|`'internal' \| 'external' \| 'external_gte'` - Specific version type
|
||||
|
||||
|`if_seq_no` or `ifSeqNo`
|
||||
|`number` - only perform the index operation if the last operation that has changed the document has the specified sequence number
|
||||
@ -5507,6 +5509,22 @@ link:{ref}/ccr-get-auto-follow-pattern.html[Reference]
|
||||
|
||||
|===
|
||||
|
||||
=== ccr.pauseAutoFollowPattern
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.ccr.pauseAutoFollowPattern({
|
||||
name: string
|
||||
})
|
||||
----
|
||||
link:{ref}/ccr-pause-auto-follow-pattern.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`name`
|
||||
|`string` - The name of the auto follow pattern that should pause discovering new indices to follow.
|
||||
|
||||
|===
|
||||
|
||||
=== ccr.pauseFollow
|
||||
|
||||
[source,ts]
|
||||
@ -5543,6 +5561,22 @@ link:{ref}/ccr-put-auto-follow-pattern.html[Reference]
|
||||
|
||||
|===
|
||||
|
||||
=== ccr.resumeAutoFollowPattern
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.ccr.resumeAutoFollowPattern({
|
||||
name: string
|
||||
})
|
||||
----
|
||||
link:{ref}/ccr-resume-auto-follow-pattern.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`name`
|
||||
|`string` - The name of the auto follow pattern to resume discovering new indices to follow.
|
||||
|
||||
|===
|
||||
|
||||
=== ccr.resumeFollow
|
||||
|
||||
[source,ts]
|
||||
@ -5588,194 +5622,83 @@ link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Reference]
|
||||
|
||||
|===
|
||||
|
||||
=== dataFrame.deleteDataFrameTransform
|
||||
*Stability:* beta
|
||||
=== enrich.deletePolicy
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.dataFrame.deleteDataFrameTransform({
|
||||
transform_id: string,
|
||||
force: boolean
|
||||
client.enrich.deletePolicy({
|
||||
name: string
|
||||
})
|
||||
----
|
||||
link:{ref}/delete-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform to delete
|
||||
|
||||
|`force`
|
||||
|`boolean` - When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.
|
||||
|`name`
|
||||
|`string` - The name of the enrich policy
|
||||
|
||||
|===
|
||||
|
||||
=== dataFrame.getDataFrameTransform
|
||||
*Stability:* beta
|
||||
=== enrich.executePolicy
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.dataFrame.getDataFrameTransform({
|
||||
transform_id: string,
|
||||
from: number,
|
||||
size: number,
|
||||
allow_no_match: boolean
|
||||
client.enrich.executePolicy({
|
||||
name: string,
|
||||
wait_for_completion: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/get-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
|
||||
|
||||
|`from`
|
||||
|`number` - skips a number of transform configs, defaults to 0
|
||||
|
||||
|`size`
|
||||
|`number` - specifies a max number of transforms to get, defaults to 100
|
||||
|
||||
|`allow_no_match` or `allowNoMatch`
|
||||
|`boolean` - Whether to ignore if a wildcard expression matches no data frame transforms. (This includes `_all` string or when no data frame transforms have been specified)
|
||||
|
||||
|===
|
||||
|
||||
=== dataFrame.getDataFrameTransformStats
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.dataFrame.getDataFrameTransformStats({
|
||||
transform_id: string,
|
||||
from: number,
|
||||
size: number,
|
||||
allow_no_match: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/get-transform-stats.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform for which to get stats. '_all' or '*' implies all transforms
|
||||
|
||||
|`from`
|
||||
|`number` - skips a number of transform stats, defaults to 0
|
||||
|
||||
|`size`
|
||||
|`number` - specifies a max number of transform stats to get, defaults to 100
|
||||
|
||||
|`allow_no_match` or `allowNoMatch`
|
||||
|`boolean` - Whether to ignore if a wildcard expression matches no data frame transforms. (This includes `_all` string or when no data frame transforms have been specified)
|
||||
|
||||
|===
|
||||
|
||||
=== dataFrame.previewDataFrameTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.dataFrame.previewDataFrameTransform({
|
||||
body: object
|
||||
})
|
||||
----
|
||||
link:{ref}/preview-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`body`
|
||||
|`object` - The definition for the data_frame transform to preview
|
||||
|
||||
|===
|
||||
|
||||
=== dataFrame.putDataFrameTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.dataFrame.putDataFrameTransform({
|
||||
transform_id: string,
|
||||
defer_validation: boolean,
|
||||
body: object
|
||||
})
|
||||
----
|
||||
link:{ref}/put-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the new transform.
|
||||
|
||||
|`defer_validation` or `deferValidation`
|
||||
|`boolean` - If validations should be deferred until data frame transform starts, defaults to false.
|
||||
|
||||
|`body`
|
||||
|`object` - The data frame transform definition
|
||||
|
||||
|===
|
||||
|
||||
=== dataFrame.startDataFrameTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.dataFrame.startDataFrameTransform({
|
||||
transform_id: string,
|
||||
timeout: string
|
||||
})
|
||||
----
|
||||
link:{ref}/start-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform to start
|
||||
|
||||
|`timeout`
|
||||
|`string` - Controls the time to wait for the transform to start
|
||||
|
||||
|===
|
||||
|
||||
=== dataFrame.stopDataFrameTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.dataFrame.stopDataFrameTransform({
|
||||
transform_id: string,
|
||||
wait_for_completion: boolean,
|
||||
timeout: string,
|
||||
allow_no_match: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/stop-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform to stop
|
||||
|`name`
|
||||
|`string` - The name of the enrich policy
|
||||
|
||||
|`wait_for_completion` or `waitForCompletion`
|
||||
|`boolean` - Whether to wait for the transform to fully stop before returning or not. Default to false
|
||||
|
||||
|`timeout`
|
||||
|`string` - Controls the time to wait until the transform has stopped. Default to 30 seconds
|
||||
|
||||
|`allow_no_match` or `allowNoMatch`
|
||||
|`boolean` - Whether to ignore if a wildcard expression matches no data frame transforms. (This includes `_all` string or when no data frame transforms have been specified)
|
||||
|`boolean` - Should the request should block until the execution is complete. +
|
||||
_Default:_ `true`
|
||||
|
||||
|===
|
||||
|
||||
=== dataFrame.updateDataFrameTransform
|
||||
*Stability:* beta
|
||||
=== enrich.getPolicy
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.dataFrame.updateDataFrameTransform({
|
||||
transform_id: string,
|
||||
defer_validation: boolean,
|
||||
client.enrich.getPolicy({
|
||||
name: string
|
||||
})
|
||||
----
|
||||
[cols=2*]
|
||||
|===
|
||||
|`name`
|
||||
|`string` - The name of the enrich policy
|
||||
|
||||
|===
|
||||
|
||||
=== enrich.putPolicy
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.enrich.putPolicy({
|
||||
name: string,
|
||||
body: object
|
||||
})
|
||||
----
|
||||
link:{ref}/update-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform.
|
||||
|
||||
|`defer_validation` or `deferValidation`
|
||||
|`boolean` - If validations should be deferred until data frame transform starts, defaults to false.
|
||||
|`name`
|
||||
|`string` - The name of the enrich policy
|
||||
|
||||
|`body`
|
||||
|`object` - The update data frame transform definition
|
||||
|`object` - The enrich policy to register
|
||||
|
||||
|===
|
||||
|
||||
=== enrich.stats
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.enrich.stats()
|
||||
----
|
||||
|
||||
|
||||
=== graph.explore
|
||||
|
||||
[source,ts]
|
||||
@ -6408,6 +6331,22 @@ link:{ref}/ml-delete-snapshot.html[Reference]
|
||||
|
||||
|===
|
||||
|
||||
=== ml.estimateMemoryUsage
|
||||
*Stability:* experimental
|
||||
[source,ts]
|
||||
----
|
||||
client.ml.estimateMemoryUsage({
|
||||
body: object
|
||||
})
|
||||
----
|
||||
https://www.elastic.co/guide/en/elasticsearch/reference/current/estimate-memory-usage-dfanalytics.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`body`
|
||||
|`object` - Memory usage estimation definition
|
||||
|
||||
|===
|
||||
|
||||
=== ml.evaluateDataFrame
|
||||
*Stability:* experimental
|
||||
[source,ts]
|
||||
@ -7965,7 +7904,8 @@ client.security.getApiKey({
|
||||
id: string,
|
||||
name: string,
|
||||
username: string,
|
||||
realm_name: string
|
||||
realm_name: string,
|
||||
owner: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/security-api-get-api-key.html[Reference]
|
||||
@ -7983,6 +7923,9 @@ link:{ref}/security-api-get-api-key.html[Reference]
|
||||
|`realm_name` or `realmName`
|
||||
|`string` - realm name of the user who created this API key to be retrieved
|
||||
|
||||
|`owner`
|
||||
|`boolean` - flag to query API keys owned by the currently authenticated user
|
||||
|
||||
|===
|
||||
|
||||
=== security.getBuiltinPrivileges
|
||||
@ -8263,22 +8206,40 @@ link:{ref}/slm-api-execute.html[Reference]
|
||||
|
||||
|===
|
||||
|
||||
=== slm.executeRetention
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.slm.executeRetention()
|
||||
----
|
||||
link:{ref}/slm-api-execute-retention.html[Reference]
|
||||
|
||||
|
||||
=== slm.getLifecycle
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.slm.getLifecycle({
|
||||
policy_id: string
|
||||
policy_id: string | string[]
|
||||
})
|
||||
----
|
||||
link:{ref}/slm-api-get.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`policy_id` or `policyId`
|
||||
|`string` - Comma-separated list of snapshot lifecycle policies to retrieve
|
||||
|`string \| string[]` - Comma-separated list of snapshot lifecycle policies to retrieve
|
||||
|
||||
|===
|
||||
|
||||
=== slm.getStats
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
client.slm.getStats()
|
||||
----
|
||||
link:{ref}/slm-get-stats.html[Reference]
|
||||
|
||||
|
||||
=== slm.putLifecycle
|
||||
|
||||
[source,ts]
|
||||
@ -8360,6 +8321,194 @@ client.ssl.certificates()
|
||||
link:{ref}/security-api-ssl.html[Reference]
|
||||
|
||||
|
||||
=== transform.deleteTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.transform.deleteTransform({
|
||||
transform_id: string,
|
||||
force: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/delete-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform to delete
|
||||
|
||||
|`force`
|
||||
|`boolean` - When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.
|
||||
|
||||
|===
|
||||
|
||||
=== transform.getTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.transform.getTransform({
|
||||
transform_id: string,
|
||||
from: number,
|
||||
size: number,
|
||||
allow_no_match: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/get-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
|
||||
|
||||
|`from`
|
||||
|`number` - skips a number of transform configs, defaults to 0
|
||||
|
||||
|`size`
|
||||
|`number` - specifies a max number of transforms to get, defaults to 100
|
||||
|
||||
|`allow_no_match` or `allowNoMatch`
|
||||
|`boolean` - Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
|
||||
|
||||
|===
|
||||
|
||||
=== transform.getTransformStats
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.transform.getTransformStats({
|
||||
transform_id: string,
|
||||
from: number,
|
||||
size: number,
|
||||
allow_no_match: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/get-transform-stats.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform for which to get stats. '_all' or '*' implies all transforms
|
||||
|
||||
|`from`
|
||||
|`number` - skips a number of transform stats, defaults to 0
|
||||
|
||||
|`size`
|
||||
|`number` - specifies a max number of transform stats to get, defaults to 100
|
||||
|
||||
|`allow_no_match` or `allowNoMatch`
|
||||
|`boolean` - Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
|
||||
|
||||
|===
|
||||
|
||||
=== transform.previewTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.transform.previewTransform({
|
||||
body: object
|
||||
})
|
||||
----
|
||||
link:{ref}/preview-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`body`
|
||||
|`object` - The definition for the transform to preview
|
||||
|
||||
|===
|
||||
|
||||
=== transform.putTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.transform.putTransform({
|
||||
transform_id: string,
|
||||
defer_validation: boolean,
|
||||
body: object
|
||||
})
|
||||
----
|
||||
link:{ref}/put-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the new transform.
|
||||
|
||||
|`defer_validation` or `deferValidation`
|
||||
|`boolean` - If validations should be deferred until transform starts, defaults to false.
|
||||
|
||||
|`body`
|
||||
|`object` - The transform definition
|
||||
|
||||
|===
|
||||
|
||||
=== transform.startTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.transform.startTransform({
|
||||
transform_id: string,
|
||||
timeout: string
|
||||
})
|
||||
----
|
||||
link:{ref}/start-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform to start
|
||||
|
||||
|`timeout`
|
||||
|`string` - Controls the time to wait for the transform to start
|
||||
|
||||
|===
|
||||
|
||||
=== transform.stopTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.transform.stopTransform({
|
||||
transform_id: string,
|
||||
wait_for_completion: boolean,
|
||||
timeout: string,
|
||||
allow_no_match: boolean
|
||||
})
|
||||
----
|
||||
link:{ref}/stop-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform to stop
|
||||
|
||||
|`wait_for_completion` or `waitForCompletion`
|
||||
|`boolean` - Whether to wait for the transform to fully stop before returning or not. Default to false
|
||||
|
||||
|`timeout`
|
||||
|`string` - Controls the time to wait until the transform has stopped. Default to 30 seconds
|
||||
|
||||
|`allow_no_match` or `allowNoMatch`
|
||||
|`boolean` - Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
|
||||
|
||||
|===
|
||||
|
||||
=== transform.updateTransform
|
||||
*Stability:* beta
|
||||
[source,ts]
|
||||
----
|
||||
client.transform.updateTransform({
|
||||
transform_id: string,
|
||||
defer_validation: boolean,
|
||||
body: object
|
||||
})
|
||||
----
|
||||
link:{ref}/update-transform.html[Reference]
|
||||
[cols=2*]
|
||||
|===
|
||||
|`transform_id` or `transformId`
|
||||
|`string` - The id of the transform.
|
||||
|
||||
|`defer_validation` or `deferValidation`
|
||||
|`boolean` - If validations should be deferred until transform starts, defaults to false.
|
||||
|
||||
|`body`
|
||||
|`object` - The update transform definition
|
||||
|
||||
|===
|
||||
|
||||
=== watcher.ackWatch
|
||||
|
||||
[source,ts]
|
||||
|
||||
Reference in New Issue
Block a user