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

Updated for 7.16 (#1591)

Browse Source
This commit is contained in:
Tomas Della Vedova
2021-10-29 11:01:18 +02:00
committed by GitHub
parent cb7421ecfc
commit d2ee3be9e0
19 changed files with 473 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

206
docs/reference.asciidoc
View File

@ -438,7 +438,7 @@ client.bulk({
})
----
link:{ref}/docs-bulk.html[Documentation] +
{jsclient}/bulk_examples.html[Code Example] +
<<bulk_examples,Code Example>> +
[cols=2*]
|===
|`index`
@ -2112,7 +2112,8 @@ client.cluster.health({
wait_for_events: 'immediate' | 'urgent' | 'high' | 'normal' | 'low' | 'languid',
wait_for_no_relocating_shards: boolean,
wait_for_no_initializing_shards: boolean,
wait_for_status: 'green' | 'yellow' | 'red'
wait_for_status: 'green' | 'yellow' | 'red',
return_200_for_cluster_health_timeout: boolean
})
----
link:{ref}/cluster-health.html[Documentation] +
@ -2156,6 +2157,9 @@ _Default:_ `cluster`
|`wait_for_status` or `waitForStatus`
|`'green' \| 'yellow' \| 'red'` - Wait until cluster is in a specific state
|`return_200_for_cluster_health_timeout` or `return_200ForClusterHealthTimeout`
|`boolean` - Whether to return HTTP 200 instead of 408 in case of a cluster health timeout from the server side
|===
[discrete]
@ -3079,7 +3083,7 @@ client.exists({
})
----
link:{ref}/docs-get.html[Documentation] +
{jsclient}/exists_examples.html[Code Example] +
<<exists_examples,Code Example>> +
[cols=2*]
|===
|`id`
@ -3339,7 +3343,7 @@ _Default:_ `open`
[discrete]
=== fleet.globalCheckpoints
*Stability:* experimental
[source,ts]
----
client.fleet.globalCheckpoints({
@ -3350,6 +3354,7 @@ client.fleet.globalCheckpoints({
timeout: string
})
----
link:{ref}/get-global-checkpoints.html[Documentation] +
[cols=2*]
|===
|`index`
@ -3372,6 +3377,59 @@ _Default:_ `30s`
|===
[discrete]
=== fleet.msearch
*Stability:* experimental
[source,ts]
----
client.fleet.msearch({
index: string,
body: object
})
----
[cols=2*]
|===
|`index`
|`string` - The index name to use as the default
|`body`
|`object` - The request definitions (metadata-fleet search request definition pairs), separated by newlines
|===
[discrete]
=== fleet.search
*Stability:* experimental
[source,ts]
----
client.fleet.search({
index: string,
wait_for_checkpoints: string | string[],
wait_for_checkpoints_timeout: string,
allow_partial_search_results: boolean,
body: object
})
----
[cols=2*]
|===
|`index`
|`string` - The index name to search.
|`wait_for_checkpoints` or `waitForCheckpoints`
|`string \| string[]` - Comma separated list of checkpoints, one per shard
|`wait_for_checkpoints_timeout` or `waitForCheckpointsTimeout`
|`string` - Explicit wait_for_checkpoints timeout
|`allow_partial_search_results` or `allowPartialSearchResults`
|`boolean` - Indicate if an error should be returned if there is a partial search failure or timeout +
_Default:_ `true`
|`body`
|`object` - The search definition using the Query DSL
|===
[discrete]
=== get
@ -3394,7 +3452,7 @@ client.get({
})
----
link:{ref}/docs-get.html[Documentation] +
{jsclient}/get_examples.html[Code Example] +
<<get_examples,Code Example>> +
[cols=2*]
|===
|`id`
@ -3463,7 +3521,7 @@ link:{ref}/modules-scripting.html[Documentation] +
[discrete]
=== getScriptContext
*Stability:* experimental
[source,ts]
----
client.getScriptContext()
@ -3473,7 +3531,7 @@ link:https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-cont
[discrete]
=== getScriptLanguages
*Stability:* experimental
[source,ts]
----
client.getScriptLanguages()
@ -4132,8 +4190,8 @@ link:{ref}/indices-delete-index.html[Documentation] +
|`boolean` - Ignore if a wildcard expression resolves to no concrete indices (default: false)
|`expand_wildcards` or `expandWildcards`
|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether wildcard expressions should get expanded to open or closed indices (default: open) +
_Default:_ `open`
|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether wildcard expressions should get expanded to open, closed, or hidden indices +
_Default:_ `open,closed`
|===
@ -4806,7 +4864,7 @@ _Default:_ `open`
[source,ts]
----
client.indices.getIndexTemplate({
name: string | string[],
name: string,
flat_settings: boolean,
master_timeout: string,
local: boolean
@ -4816,7 +4874,7 @@ link:{ref}/indices-templates.html[Documentation] +
[cols=2*]
|===
|`name`
|`string \| string[]` - The comma separated names of the index templates
|`string` - A pattern that returned template names must match
|`flat_settings` or `flatSettings`
|`boolean` - Return settings in flat format (default: false)
@ -5009,6 +5067,23 @@ link:{ref}/data-streams.html[Documentation] +
|===
[discrete]
=== indices.modifyDataStream
[source,ts]
----
client.indices.modifyDataStream({
body: object
})
----
link:{ref}/data-streams.html[Documentation] +
[cols=2*]
|===
|`body`
|`object` - The data stream modifications
|===
[discrete]
=== indices.open
@ -5364,7 +5439,7 @@ _Default:_ `open`
[discrete]
=== indices.resolveIndex
*Stability:* experimental
[source,ts]
----
client.indices.resolveIndex({
@ -5978,6 +6053,7 @@ link:{ref}/grok-processor.html#grok-processor-rest-get[Documentation] +
----
client.ingest.putPipeline({
id: string,
if_version: number,
master_timeout: string,
timeout: string,
body: object
@ -5989,6 +6065,9 @@ link:{ref}/put-pipeline-api.html[Documentation] +
|`id`
|`string` - Pipeline ID
|`if_version` or `ifVersion`
|`number` - Required version for optimistic concurrency control for pipeline updates
|`master_timeout` or `masterTimeout`
|`string` - Explicit operation timeout for connection to master node
@ -6266,6 +6345,26 @@ link:{ref}/migration-api-deprecation.html[Documentation] +
|===
[discrete]
=== migration.getFeatureUpgradeStatus
[source,ts]
----
client.migration.getFeatureUpgradeStatus()
----
link:{ref}/migration-api-feature-upgrade.html[Documentation] +
[discrete]
=== migration.postFeatureUpgrade
[source,ts]
----
client.migration.postFeatureUpgrade()
----
link:{ref}/migration-api-feature-upgrade.html[Documentation] +
[discrete]
=== ml.closeJob
@ -7725,6 +7824,7 @@ link:{ref}/ml-put-job.html[Documentation] +
----
client.ml.putTrainedModel({
model_id: string,
defer_definition_decompression: boolean,
body: object
})
----
@ -7734,6 +7834,9 @@ link:{ref}/put-trained-models.html[Documentation] +
|`model_id` or `modelId`
|`string` - The ID of the trained models to store
|`defer_definition_decompression` or `deferDefinitionDecompression`
|`boolean` - If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.
|`body`
|`object` - The trained model configuration
@ -8156,7 +8259,7 @@ link:https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html[Docum
[discrete]
=== monitoring.bulk
*Stability:* experimental
[source,ts]
----
client.monitoring.bulk({
@ -8208,7 +8311,7 @@ client.msearch({
})
----
link:{ref}/search-multi-search.html[Documentation] +
{jsclient}/msearch_examples.html[Code Example] +
<<msearch_examples,Code Example>> +
[cols=2*]
|===
|`index`
@ -8369,11 +8472,11 @@ _Default:_ `true`
|===
[discrete]
=== nodes.clearMeteringArchive
=== nodes.clearRepositoriesMeteringArchive
*Stability:* experimental
[source,ts]
----
client.nodes.clearMeteringArchive({
client.nodes.clearRepositoriesMeteringArchive({
node_id: string | string[],
max_archive_version: number
})
@ -8390,11 +8493,11 @@ link:{ref}/clear-repositories-metering-archive-api.html[Documentation] +
|===
[discrete]
=== nodes.getMeteringInfo
=== nodes.getRepositoriesMeteringInfo
*Stability:* experimental
[source,ts]
----
client.nodes.getMeteringInfo({
client.nodes.getRepositoriesMeteringInfo({
node_id: string | string[]
})
----
@ -8466,7 +8569,7 @@ link:{ref}/cluster-nodes-info.html[Documentation] +
|`string \| string[]` - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
|`metric`
|`string \| string[]` - A comma-separated list of metrics you wish returned. Leave empty to return all.
|`string \| string[]` - A comma-separated list of metrics you wish returned. Leave empty to return all metrics.
|`flat_settings` or `flatSettings`
|`boolean` - Return settings in flat format (default: false)
@ -8671,7 +8774,7 @@ link:{ref}/modules-scripting.html[Documentation] +
[discrete]
=== rankEval
*Stability:* experimental
[source,ts]
----
client.rankEval({
@ -8725,7 +8828,7 @@ client.reindex({
})
----
link:{ref}/docs-reindex.html[Documentation] +
{jsclient}/reindex_examples.html[Code Example] +
<<reindex_examples,Code Example>> +
[cols=2*]
|===
|`refresh`
@ -9024,7 +9127,7 @@ client.scroll({
})
----
link:{ref}/search-request-body.html#request-body-search-scroll[Documentation] +
{jsclient}/scroll_examples.html[Code Example] +
<<scroll_examples,Code Example>> +
[cols=2*]
|===
|`scroll_id` or `scrollId`
@ -9098,7 +9201,7 @@ client.search({
})
----
link:{ref}/search-search.html[Documentation] +
{jsclient}/search_examples.html[Code Example] +
<<search_examples,Code Example>> +
[cols=2*]
|===
|`index`
@ -9262,8 +9365,9 @@ client.searchMvt({
exact_bounds: boolean,
extent: number,
grid_precision: number,
grid_type: 'grid' | 'point',
grid_type: 'grid' | 'point' | 'centroid',
size: number,
track_total_hits: boolean|long,
body: object
})
----
@ -9297,13 +9401,16 @@ _Default:_ `4096`
_Default:_ `8`
|`grid_type` or `gridType`
|`'grid' \| 'point'` - Determines the geometry type for features in the aggs layer. +
|`'grid' \| 'point' \| 'centroid'` - Determines the geometry type for features in the aggs layer. +
_Default:_ `grid`
|`size`
|`number` - Maximum number of features to return in the hits layer. Accepts 0-10000. +
_Default:_ `10000`
|`track_total_hits` or `trackTotalHits`
|`boolean\|long` - Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
|`body`
|`object` - Search request body.
@ -9479,7 +9586,7 @@ _Default:_ `open`
[discrete]
=== searchableSnapshots.mount
*Stability:* experimental
[source,ts]
----
client.searchableSnapshots.mount({
@ -9533,7 +9640,7 @@ link:{ref}/searchable-snapshots-apis.html[Documentation] +
[discrete]
=== searchableSnapshots.stats
*Stability:* experimental
[source,ts]
----
client.searchableSnapshots.stats({
@ -9662,7 +9769,7 @@ link:{ref}/security-api-clear-role-cache.html[Documentation] +
[discrete]
=== security.clearCachedServiceTokens
*Stability:* beta
[source,ts]
----
client.security.clearCachedServiceTokens({
@ -9708,7 +9815,7 @@ link:{ref}/security-api-create-api-key.html[Documentation] +
[discrete]
=== security.createServiceToken
*Stability:* beta
[source,ts]
----
client.security.createServiceToken({
@ -9804,7 +9911,7 @@ link:{ref}/security-api-delete-role-mapping.html[Documentation] +
[discrete]
=== security.deleteServiceToken
*Stability:* beta
[source,ts]
----
client.security.deleteServiceToken({
@ -9994,7 +10101,7 @@ link:{ref}/security-api-get-role-mapping.html[Documentation] +
[discrete]
=== security.getServiceAccounts
*Stability:* beta
[source,ts]
----
client.security.getServiceAccounts({
@ -10015,7 +10122,7 @@ link:{ref}/security-api-get-service-accounts.html[Documentation] +
[discrete]
=== security.getServiceCredentials
*Stability:* beta
[source,ts]
----
client.security.getServiceCredentials({
@ -10371,7 +10478,7 @@ link:{ref}/security-api-saml-sp-metadata.html[Documentation] +
[discrete]
=== shutdown.deleteNode
*Stability:* experimental
[source,ts]
----
client.shutdown.deleteNode({
@ -10388,7 +10495,7 @@ link:https://www.elastic.co/guide/en/elasticsearch/reference/current[Documentati
[discrete]
=== shutdown.getNode
*Stability:* experimental
[source,ts]
----
client.shutdown.getNode({
@ -10405,7 +10512,7 @@ link:https://www.elastic.co/guide/en/elasticsearch/reference/current[Documentati
[discrete]
=== shutdown.putNode
*Stability:* experimental
[source,ts]
----
client.shutdown.putNode({
@ -11031,7 +11138,7 @@ client.sql.query({
})
----
link:{ref}/sql-search-api.html[Documentation] +
{jsclient}/sql_query_examples.html[Code Example] +
<<sql_query_examples,Code Example>> +
[cols=2*]
|===
|`format`
@ -11171,7 +11278,7 @@ _Default:_ `nodes`
[discrete]
=== termsEnum
*Stability:* beta
[source,ts]
----
client.termsEnum({
@ -11432,12 +11539,16 @@ link:{ref}/get-transform-stats.html[Documentation] +
[source,ts]
----
client.transform.previewTransform({
transform_id: string,
body: object
})
----
link:{ref}/preview-transform.html[Documentation] +
[cols=2*]
|===
|`transform_id` or `transformId`
|`string` - The id of the transform to preview.
|`body`
|`object` - The definition for the transform to preview
@ -11551,6 +11662,23 @@ link:{ref}/update-transform.html[Documentation] +
|===
[discrete]
=== transform.upgradeTransforms
[source,ts]
----
client.transform.upgradeTransforms({
dry_run: boolean
})
----
link:{ref}/upgrade-transforms.html[Documentation] +
[cols=2*]
|===
|`dry_run` or `dryRun`
|`boolean` - Whether to only check for updates but don't execute
|===
[discrete]
=== update
@ -11576,7 +11704,7 @@ client.update({
})
----
link:{ref}/docs-update.html[Documentation] +
{jsclient}/update_examples.html[Code Example] +
<<update_examples,Code Example>> +
[cols=2*]
|===
|`id`
@ -11678,7 +11806,7 @@ client.updateByQuery({
})
----
link:{ref}/docs-update-by-query.html[Documentation] +
{jsclient}/update_by_query_examples.html[Code Example] +
<<update_by_query_examples,Code Example>> +
[cols=2*]
|===
|`index`