API generation

This commit is contained in:
delvedor
2020-03-18 15:05:03 +01:00
parent f1fcf4746d
commit 7e51d4cd8c
8 changed files with 528 additions and 0 deletions

View File

@ -1085,6 +1085,54 @@ link:{ref}/cluster-allocation-explain.html[Documentation] +
|===
=== cluster.deleteComponentTemplate
[source,ts]
----
client.cluster.deleteComponentTemplate({
name: string,
timeout: string,
master_timeout: string
})
----
link:{ref}/indices-component-templates.html[Documentation] +
[cols=2*]
|===
|`name`
|`string` - The name of the template
|`timeout`
|`string` - Explicit operation timeout
|`master_timeout` or `masterTimeout`
|`string` - Specify timeout for connection to master
|===
=== cluster.getComponentTemplate
[source,ts]
----
client.cluster.getComponentTemplate({
name: string | string[],
master_timeout: string,
local: boolean
})
----
link:{ref}/indices-component-templates.html[Documentation] +
[cols=2*]
|===
|`name`
|`string \| string[]` - The comma separated names of the component templates
|`master_timeout` or `masterTimeout`
|`string` - Explicit operation timeout for connection to master node
|`local`
|`boolean` - Return local information, do not retrieve the state from master node (default: false)
|===
=== cluster.getSettings
[source,ts]
@ -1195,6 +1243,38 @@ link:{ref}/cluster-pending.html[Documentation] +
|===
=== cluster.putComponentTemplate
[source,ts]
----
client.cluster.putComponentTemplate({
name: string,
create: boolean,
timeout: string,
master_timeout: string,
body: object
})
----
link:{ref}/indices-component-templates.html[Documentation] +
[cols=2*]
|===
|`name`
|`string` - The name of the template
|`create`
|`boolean` - Whether the index template should only be added if new or can also replace an existing one
|`timeout`
|`string` - Explicit operation timeout
|`master_timeout` or `masterTimeout`
|`string` - Specify timeout for connection to master
|`body`
|`object` - The template definition
|===
=== cluster.putSettings
[source,ts]
@ -9078,6 +9158,58 @@ client.ssl.certificates()
link:{ref}/security-api-ssl.html[Documentation] +
=== transform.catTransform
[source,ts]
----
client.transform.catTransform({
transform_id: string,
from: number,
size: number,
allow_no_match: boolean,
format: string,
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-transform.html[Documentation] +
[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 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)
|`format`
|`string` - a short version of the Accept header, e.g. json, yaml
|`h`
|`string \| string[]` - Comma-separated list of column names to display
|`help`
|`boolean` - Return help information
|`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
|===
=== transform.deleteTransform
[source,ts]