habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API generation

Browse Source
This commit is contained in:
delvedor
2020-04-07 10:44:50 +02:00
parent f6677c05cf
commit 8522f303ee
8 changed files with 522 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
docs/reference.asciidoc
View File

@ -1109,6 +1109,30 @@ link:{ref}/indices-component-templates.html[Documentation] +
|===
=== cluster.existsComponentTemplate
[source,ts]
----
client.cluster.existsComponentTemplate({
name: string,
master_timeout: string,
local: boolean
})
----
link:{ref}/indices-component-templates.html[Documentation] +
[cols=2*]
|===
|`name`
|`string` - The name of the template
|`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.getComponentTemplate
[source,ts]
@ -5118,7 +5142,7 @@ link:{ref}/tasks.html[Documentation] +
|`string` - Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
|`wait_for_completion` or `waitForCompletion`
|`boolean` - Should the request block until the cancellation of the task and its child tasks is completed. Defaults to false
|`boolean` - Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
|===
@ -8749,6 +8773,83 @@ link:{ref}/rollup-stop-job.html[Documentation] +
|===
=== searchableSnapshots.clearCache
*Stability:* experimental
[source,ts]
----
client.searchableSnapshots.clearCache({
index: string | string[],
ignore_unavailable: boolean,
allow_no_indices: boolean,
expand_wildcards: 'open' | 'closed' | 'none' | 'all'
})
----
link:{ref}/searchable-snapshots-api-clear-cache.html[Documentation] +
[cols=2*]
|===
|`index`
|`string \| string[]` - A comma-separated list of index names
|`ignore_unavailable` or `ignoreUnavailable`
|`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|`allow_no_indices` or `allowNoIndices`
|`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|`expand_wildcards` or `expandWildcards`
|`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. +
_Default:_ `open`
|===
=== searchableSnapshots.mount
*Stability:* experimental
[source,ts]
----
client.searchableSnapshots.mount({
repository: string,
snapshot: string,
master_timeout: string,
wait_for_completion: boolean,
body: object
})
----
link:https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot[Documentation] +
[cols=2*]
|===
|`repository`
|`string` - The name of the repository containing the snapshot of the index to mount
|`snapshot`
|`string` - The name of the snapshot of the index to mount
|`master_timeout` or `masterTimeout`
|`string` - Explicit operation timeout for connection to master node
|`wait_for_completion` or `waitForCompletion`
|`boolean` - Should this request wait until the operation has completed before returning
|`body`
|`object` - The restore configuration for mounting the snapshot as searchable
|===
=== searchableSnapshots.stats
*Stability:* experimental
[source,ts]
----
client.searchableSnapshots.stats({
index: string | string[]
})
----
link:{ref}/searchable-snapshots-api-stats.html[Documentation] +
[cols=2*]
|===
|`index`
|`string \| string[]` - A comma-separated list of index names
|===
=== security.authenticate
[source,ts]