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

Auto-generated code for 8.14 (#2307)

Browse Source
This commit is contained in:
Elastic Machine
2024-07-09 04:32:23 +10:00
committed by GitHub
parent 6dc5131622
commit 0b504428f1
88 changed files with 3870 additions and 676 deletions
Download Patch File Download Diff File Expand all files Collapse all files

612
docs/reference.asciidoc
View File

@ -1271,8 +1271,7 @@ Set to 'all' or any positive integer up to the total number of shards in the ind
[discrete]
=== update_by_query
Updates documents that match the specified query. If no query is specified,
performs an update on every document in the index without changing the source,
Performs an update on every document in the index without changing the source,
for example to pick up a mapping change.
{ref}/docs-update-by-query.html[Endpoint documentation]
@ -1517,6 +1516,68 @@ A partial reduction is performed every time the coordinating node has received a
** *`_source_includes` (Optional, string | string[])*: A list of fields to extract and return from the _source field
** *`q` (Optional, string)*: Query in the Lucene query string syntax
[discrete]
=== autoscaling
[discrete]
==== delete_autoscaling_policy
Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
{ref}/autoscaling-delete-autoscaling-policy.html[Endpoint documentation]
[source,ts]
----
client.autoscaling.deleteAutoscalingPolicy({ name })
----
[discrete]
==== Arguments
* *Request (object):*
** *`name` (string)*: the name of the autoscaling policy
[discrete]
==== get_autoscaling_capacity
Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
{ref}/autoscaling-get-autoscaling-capacity.html[Endpoint documentation]
[source,ts]
----
client.autoscaling.getAutoscalingCapacity()
----
[discrete]
==== get_autoscaling_policy
Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
{ref}/autoscaling-get-autoscaling-capacity.html[Endpoint documentation]
[source,ts]
----
client.autoscaling.getAutoscalingPolicy({ name })
----
[discrete]
==== Arguments
* *Request (object):*
** *`name` (string)*: the name of the autoscaling policy
[discrete]
==== put_autoscaling_policy
Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
{ref}/autoscaling-put-autoscaling-policy.html[Endpoint documentation]
[source,ts]
----
client.autoscaling.putAutoscalingPolicy({ name })
----
[discrete]
==== Arguments
* *Request (object):*
** *`name` (string)*: the name of the autoscaling policy
** *`policy` (Optional, { roles, deciders })*
[discrete]
=== cat
[discrete]
@ -2855,6 +2916,24 @@ client.features.resetFeatures()
[discrete]
=== fleet
[discrete]
==== delete_secret
Deletes a secret stored by Fleet.
[source,ts]
----
client.fleet.deleteSecret()
----
[discrete]
==== get_secret
Retrieves a secret stored by Fleet.
[source,ts]
----
client.fleet.getSecret()
----
[discrete]
==== global_checkpoints
Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.
@ -2911,6 +2990,15 @@ Elasticsearch to immediately execute the search.
an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`
which is true by default.
[discrete]
==== post_secret
Creates a secret stored by Fleet.
[source,ts]
----
client.fleet.postSecret()
----
[discrete]
==== search
Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.
@ -4766,83 +4854,6 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
** *`rewrite` (Optional, boolean)*: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed.
** *`q` (Optional, string)*: Query in the Lucene query string syntax.
[discrete]
=== inference
[discrete]
==== delete_model
Delete model in the Inference API
{ref}/delete-inference-api.html[Endpoint documentation]
[source,ts]
----
client.inference.deleteModel({ inference_id })
----
[discrete]
==== Arguments
* *Request (object):*
** *`inference_id` (string)*: The inference Id
** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The task type
[discrete]
==== get_model
Get a model in the Inference API
{ref}/get-inference-api.html[Endpoint documentation]
[source,ts]
----
client.inference.getModel({ inference_id })
----
[discrete]
==== Arguments
* *Request (object):*
** *`inference_id` (string)*: The inference Id
** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The task type
[discrete]
==== inference
Perform inference on a model
{ref}/post-inference-api.html[Endpoint documentation]
[source,ts]
----
client.inference.inference({ inference_id, input })
----
[discrete]
==== Arguments
* *Request (object):*
** *`inference_id` (string)*: The inference Id
** *`input` (string | string[])*: Text input to the model.
Either a string or an array of strings.
** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The task type
** *`query` (Optional, string)*: Query input, required for rerank task.
Not required for other tasks.
** *`task_settings` (Optional, User-defined value)*: Optional task settings
** *`timeout` (Optional, string | -1 | 0)*: Specifies the amount of time to wait for the inference request to complete.
[discrete]
==== put_model
Configure a model for use in the Inference API
{ref}/put-inference-api.html[Endpoint documentation]
[source,ts]
----
client.inference.putModel({ inference_id })
----
[discrete]
==== Arguments
* *Request (object):*
** *`inference_id` (string)*: The inference Id
** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The task type
** *`model_config` (Optional, { service, service_settings, task_settings })*
[discrete]
=== ingest
[discrete]
@ -6977,6 +6988,68 @@ client.ml.upgradeJobSnapshot({ job_id, snapshot_id })
Otherwise, it responds as soon as the upgrade task is assigned to a node.
** *`timeout` (Optional, string | -1 | 0)*: Controls the time to wait for the request to complete.
[discrete]
==== validate
Validates an anomaly detection job.
https://www.elastic.co/guide/en/machine-learning/8.14/ml-jobs.html[Endpoint documentation]
[source,ts]
----
client.ml.validate({ ... })
----
[discrete]
==== Arguments
* *Request (object):*
** *`job_id` (Optional, string)*
** *`analysis_config` (Optional, { bucket_span, categorization_analyzer, categorization_field_name, categorization_filters, detectors, influencers, latency, model_prune_window, multivariate_by_fields, per_partition_categorization, summary_count_field_name })*
** *`analysis_limits` (Optional, { categorization_examples_limit, model_memory_limit })*
** *`data_description` (Optional, { format, time_field, time_format, field_delimiter })*
** *`description` (Optional, string)*
** *`model_plot` (Optional, { annotations_enabled, enabled, terms })*
** *`model_snapshot_id` (Optional, string)*
** *`model_snapshot_retention_days` (Optional, number)*
** *`results_index_name` (Optional, string)*
[discrete]
==== validate_detector
Validates an anomaly detection detector.
https://www.elastic.co/guide/en/machine-learning/8.14/ml-jobs.html[Endpoint documentation]
[source,ts]
----
client.ml.validateDetector({ ... })
----
[discrete]
==== Arguments
* *Request (object):*
** *`detector` (Optional, { by_field_name, custom_rules, detector_description, detector_index, exclude_frequent, field_name, function, over_field_name, partition_field_name, use_null })*
[discrete]
=== monitoring
[discrete]
==== bulk
Used by the monitoring features to send monitoring data.
{ref}/monitor-elasticsearch-cluster.html[Endpoint documentation]
[source,ts]
----
client.monitoring.bulk({ system_id, system_api_version, interval })
----
[discrete]
==== Arguments
* *Request (object):*
** *`system_id` (string)*: Identifier of the monitored system
** *`system_api_version` (string)*
** *`interval` (string | -1 | 0)*: Collection interval (e.g., '10s' or '10000ms') of the payload
** *`type` (Optional, string)*: Default document type for items which don't provide one
** *`operations` (Optional, { index, create, update, delete } | { detect_noop, doc, doc_as_upsert, script, scripted_upsert, _source, upsert } | object[])*
[discrete]
=== nodes
[discrete]
@ -7129,6 +7202,52 @@ A list of the following options: `_all`, `rest_actions`.
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
=== profiling
[discrete]
==== flamegraph
Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.
https://www.elastic.co/guide/en/observability/8.14/universal-profiling.html[Endpoint documentation]
[source,ts]
----
client.profiling.flamegraph()
----
[discrete]
==== stacktraces
Extracts raw stacktrace information from Universal Profiling.
https://www.elastic.co/guide/en/observability/8.14/universal-profiling.html[Endpoint documentation]
[source,ts]
----
client.profiling.stacktraces()
----
[discrete]
==== status
Returns basic information about the status of Universal Profiling.
https://www.elastic.co/guide/en/observability/8.14/universal-profiling.html[Endpoint documentation]
[source,ts]
----
client.profiling.status()
----
[discrete]
==== topn_functions
Extracts a list of topN functions from Universal Profiling.
https://www.elastic.co/guide/en/observability/8.14/universal-profiling.html[Endpoint documentation]
[source,ts]
----
client.profiling.topnFunctions()
----
[discrete]
=== query_ruleset
[discrete]
@ -7448,17 +7567,6 @@ client.searchApplication.list({ ... })
** *`from` (Optional, number)*: Starting offset.
** *`size` (Optional, number)*: Specifies a max number of results to get.
[discrete]
==== post_behavioral_analytics_event
Creates a behavioral analytics event for existing collection.
http://todo.com/tbd[Endpoint documentation]
[source,ts]
----
client.searchApplication.postBehavioralAnalyticsEvent()
----
[discrete]
==== put
Creates or updates a search application.
@ -7493,17 +7601,6 @@ client.searchApplication.putBehavioralAnalytics({ name })
* *Request (object):*
** *`name` (string)*: The name of the analytics collection to be created or updated.
[discrete]
==== render_query
Renders a query for given search application search parameters
{ref}/search-application-render-query.html[Endpoint documentation]
[source,ts]
----
client.searchApplication.renderQuery()
----
[discrete]
==== search
Perform a search against a search application
@ -7605,6 +7702,25 @@ client.searchableSnapshots.stats({ ... })
[discrete]
=== security
[discrete]
==== activate_user_profile
Creates or updates the user profile on behalf of another user.
{ref}/security-api-activate-user-profile.html[Endpoint documentation]
[source,ts]
----
client.security.activateUserProfile({ grant_type })
----
[discrete]
==== Arguments
* *Request (object):*
** *`grant_type` (Enum("password" | "access_token"))*
** *`access_token` (Optional, string)*
** *`password` (Optional, string)*
** *`username` (Optional, string)*
[discrete]
==== authenticate
Enables authentication as a user and retrieve information about the authenticated user.
@ -7616,17 +7732,6 @@ client.security.authenticate()
----
[discrete]
==== bulk_update_api_keys
Updates the attributes of multiple existing API keys.
{ref}/security-api-bulk-update-api-keys.html[Endpoint documentation]
[source,ts]
----
client.security.bulkUpdateApiKeys()
----
[discrete]
==== change_password
Changes the passwords of users in the native realm and built-in users.
@ -7755,17 +7860,6 @@ client.security.createApiKey({ ... })
** *`metadata` (Optional, Record<string, User-defined value>)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) 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` then do nothing with refreshes.
[discrete]
==== create_cross_cluster_api_key
Creates a cross-cluster API key for API key based remote cluster access.
{ref}/security-api-create-cross-cluster-api-key.html[Endpoint documentation]
[source,ts]
----
client.security.createCrossClusterApiKey()
----
[discrete]
==== create_service_token
Creates a service account token for access without requiring basic authentication.
@ -7890,6 +7984,25 @@ client.security.disableUser({ username })
** *`username` (string)*: The username of the user to disable
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) 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` then do nothing with refreshes.
[discrete]
==== disable_user_profile
Disables a user profile so it's not visible in user profile searches.
{ref}/security-api-disable-user-profile.html[Endpoint documentation]
[source,ts]
----
client.security.disableUserProfile({ uid })
----
[discrete]
==== Arguments
* *Request (object):*
** *`uid` (string)*: Unique identifier for the user profile.
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If 'true', Elasticsearch refreshes 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' do nothing with refreshes.
[discrete]
==== enable_user
Enables users in the native realm.
@ -7907,6 +8020,25 @@ client.security.enableUser({ username })
** *`username` (string)*: The username of the user to enable
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) 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` then do nothing with refreshes.
[discrete]
==== enable_user_profile
Enables a user profile so it's visible in user profile searches.
{ref}/security-api-enable-user-profile.html[Endpoint documentation]
[source,ts]
----
client.security.enableUserProfile({ uid })
----
[discrete]
==== Arguments
* *Request (object):*
** *`uid` (string)*: Unique identifier for the user profile.
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If 'true', Elasticsearch refreshes 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' do nothing with refreshes.
[discrete]
==== enroll_kibana
Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.
@ -8055,17 +8187,6 @@ client.security.getServiceCredentials({ namespace, service })
** *`namespace` (string)*: Name of the namespace.
** *`service` (string)*: Name of the service name.
[discrete]
==== get_settings
Retrieve settings for the security system indices
{ref}/security-api-get-settings.html[Endpoint documentation]
[source,ts]
----
client.security.getSettings()
----
[discrete]
==== get_token
Creates a bearer token for access without requiring basic authentication.
@ -8122,6 +8243,26 @@ client.security.getUserPrivileges({ ... })
** *`priviledge` (Optional, string)*: The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application.
** *`username` (Optional, string | null)*
[discrete]
==== get_user_profile
Retrieves user profiles for the given unique ID(s).
{ref}/security-api-get-user-profile.html[Endpoint documentation]
[source,ts]
----
client.security.getUserProfile({ uid })
----
[discrete]
==== Arguments
* *Request (object):*
** *`uid` (string | string[])*: A unique identifier for the user profile.
** *`data` (Optional, string | string[])*: List of filters for the `data` field of the profile document.
To return all content use `data=*`. To return a subset of content
use `data=<key>` to retrieve content nested under the specified `<key>`.
By default returns no `data` content.
[discrete]
==== grant_api_key
Creates an API key on behalf of another user.
@ -8167,6 +8308,23 @@ client.security.hasPrivileges({ ... })
** *`cluster` (Optional, Enum("all" | "cancel_task" | "create_snapshot" | "cross_cluster_replication" | "cross_cluster_search" | "delegate_pki" | "grant_api_key" | "manage" | "manage_api_key" | "manage_autoscaling" | "manage_behavioral_analytics" | "manage_ccr" | "manage_data_frame_transforms" | "manage_data_stream_global_retention" | "manage_enrich" | "manage_ilm" | "manage_index_templates" | "manage_inference" | "manage_ingest_pipelines" | "manage_logstash_pipelines" | "manage_ml" | "manage_oidc" | "manage_own_api_key" | "manage_pipeline" | "manage_rollup" | "manage_saml" | "manage_search_application" | "manage_search_query_rules" | "manage_search_synonyms" | "manage_security" | "manage_service_account" | "manage_slm" | "manage_token" | "manage_transform" | "manage_user_profile" | "manage_watcher" | "monitor" | "monitor_data_frame_transforms" | "monitor_data_stream_global_retention" | "monitor_enrich" | "monitor_inference" | "monitor_ml" | "monitor_rollup" | "monitor_snapshot" | "monitor_text_structure" | "monitor_transform" | "monitor_watcher" | "none" | "post_behavioral_analytics_event" | "read_ccr" | "read_connector_secrets" | "read_fleet_secrets" | "read_ilm" | "read_pipeline" | "read_security" | "read_slm" | "transport_client" | "write_connector_secrets" | "write_fleet_secrets")[])*: A list of the cluster privileges that you want to check.
** *`index` (Optional, { names, privileges, allow_restricted_indices }[])*
[discrete]
==== has_privileges_user_profile
Determines whether the users associated with the specified profile IDs have all the requested privileges.
{ref}/security-api-has-privileges-user-profile.html[Endpoint documentation]
[source,ts]
----
client.security.hasPrivilegesUserProfile({ uids, privileges })
----
[discrete]
==== Arguments
* *Request (object):*
** *`uids` (string[])*: A list of profile IDs. The privileges are checked for associated users of the profiles.
** *`privileges` ({ application, cluster, index })*
[discrete]
==== invalidate_api_key
Invalidates one or more API keys.
@ -8212,39 +8370,6 @@ client.security.invalidateToken({ ... })
** *`realm_name` (Optional, string)*
** *`username` (Optional, string)*
[discrete]
==== oidc_authenticate
Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
{ref}/security-api-oidc-authenticate.html[Endpoint documentation]
[source,ts]
----
client.security.oidcAuthenticate()
----
[discrete]
==== oidc_logout
Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
{ref}/security-api-oidc-logout.html[Endpoint documentation]
[source,ts]
----
client.security.oidcLogout()
----
[discrete]
==== oidc_prepare_authentication
Creates an OAuth 2.0 authentication request as a URL string
{ref}/security-api-oidc-prepare-authentication.html[Endpoint documentation]
[source,ts]
----
client.security.oidcPrepareAuthentication()
----
[discrete]
==== put_privileges
Adds or updates application privileges.
@ -8487,6 +8612,32 @@ client.security.samlServiceProviderMetadata({ realm_name })
* *Request (object):*
** *`realm_name` (string)*: The name of the SAML realm in Elasticsearch.
[discrete]
==== suggest_user_profiles
Get suggestions for user profiles that match specified search criteria.
{ref}/security-api-suggest-user-profile.html[Endpoint documentation]
[source,ts]
----
client.security.suggestUserProfiles({ ... })
----
[discrete]
==== Arguments
* *Request (object):*
** *`name` (Optional, string)*: Query string used to match name-related fields in user profile documents.
Name-related fields are the user's `username`, `full_name`, and `email`.
** *`size` (Optional, number)*: Number of profiles to return.
** *`data` (Optional, string | string[])*: List of filters for the `data` field of the profile document.
To return all content use `data=*`. To return a subset of content
use `data=<key>` to retrieve content nested under the specified `<key>`.
By default returns no `data` content.
** *`hint` (Optional, { uids, labels })*: Extra search criteria to improve relevance of the suggestion result.
Profiles matching the spcified hint are ranked higher in the response.
Profiles not matching the hint don't exclude the profile from the response
as long as the profile matches the `name` field query.
[discrete]
==== update_api_key
Updates attributes of an existing API key.
@ -8507,26 +8658,102 @@ client.security.updateApiKey({ id })
** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key.
[discrete]
==== update_cross_cluster_api_key
Updates attributes of an existing cross-cluster API key.
==== update_user_profile_data
Update application specific data for the user profile of the given unique ID.
{ref}/security-api-update-cross-cluster-api-key.html[Endpoint documentation]
{ref}/security-api-update-user-profile-data.html[Endpoint documentation]
[source,ts]
----
client.security.updateCrossClusterApiKey()
client.security.updateUserProfileData({ uid })
----
[discrete]
==== update_settings
Update settings for the security system index
==== Arguments
{ref}/security-api-update-settings.html[Endpoint documentation]
* *Request (object):*
** *`uid` (string)*: A unique identifier for the user profile.
** *`labels` (Optional, Record<string, User-defined value>)*: Searchable data that you want to associate with the user profile. This
field supports a nested data structure.
** *`data` (Optional, Record<string, User-defined value>)*: Non-searchable data that you want to associate with the user profile.
This field supports a nested data structure.
** *`if_seq_no` (Optional, number)*: Only perform the operation if the document has this sequence number.
** *`if_primary_term` (Optional, number)*: Only perform the operation if the document has this primary term.
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If 'true', Elasticsearch refreshes 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' do nothing with refreshes.
[discrete]
=== shutdown
[discrete]
==== delete_node
Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
https://www.elastic.co/guide/en/elasticsearch/reference/current[Endpoint documentation]
[source,ts]
----
client.security.updateSettings()
client.shutdown.deleteNode({ node_id })
----
[discrete]
==== Arguments
* *Request (object):*
** *`node_id` (string)*: The node id of node to be removed from the shutdown state
** *`master_timeout` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
** *`timeout` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
==== get_node
Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
https://www.elastic.co/guide/en/elasticsearch/reference/current[Endpoint documentation]
[source,ts]
----
client.shutdown.getNode({ ... })
----
[discrete]
==== Arguments
* *Request (object):*
** *`node_id` (Optional, string | string[])*: Which node for which to retrieve the shutdown status
** *`master_timeout` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
** *`timeout` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
==== put_node
Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
https://www.elastic.co/guide/en/elasticsearch/reference/current[Endpoint documentation]
[source,ts]
----
client.shutdown.putNode({ node_id, type, reason })
----
[discrete]
==== Arguments
* *Request (object):*
** *`node_id` (string)*: The node id of node to be shut down
** *`type` (Enum("restart" | "remove" | "replace"))*: Valid values are restart, remove, or replace.
Use restart when you need to temporarily shut down a node to perform an upgrade, make configuration changes, or perform other maintenance.
Because the node is expected to rejoin the cluster, data is not migrated off of the node.
Use remove when you need to permanently remove a node from the cluster.
The node is not marked ready for shutdown until data is migrated off of the node Use replace to do a 1:1 replacement of a node with another node.
Certain allocation decisions will be ignored (such as disk watermarks) in the interest of true replacement of the source node with the target node.
During a replace-type shutdown, rollover and index creation may result in unassigned shards, and shrink may fail until the replacement is complete.
** *`reason` (string)*: A human-readable reason that the node is being shut down.
This field provides information for other cluster operators; it does not affect the shut down process.
** *`allocation_delay` (Optional, string)*: Only valid if type is restart.
Controls how long Elasticsearch will wait for the node to restart and join the cluster before reassigning its shards to other nodes.
This works the same as delaying allocation with the index.unassigned.node_left.delayed_timeout setting.
If you specify both a restart allocation delay and an index-level allocation delay, the longer of the two is used.
** *`target_node_name` (Optional, string)*: Only valid if type is replace.
Specifies the name of the node that is replacing the node being shut down.
Shards from the shut down node are only allowed to be allocated to the target node, and no other data will be allocated to the target node.
During relocation of data certain allocation rules are ignored, such as disk watermarks or user attribute filtering rules.
** *`master_timeout` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
** *`timeout` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
[discrete]
=== slm
@ -8827,17 +9054,6 @@ client.snapshot.getRepository({ ... })
** *`local` (Optional, boolean)*: Return local information, do not retrieve the state from master node (default: false)
** *`master_timeout` (Optional, string | -1 | 0)*: Explicit operation timeout for connection to master node
[discrete]
==== repository_analyze
Analyzes a repository for correctness and performance
{ref}/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.repositoryAnalyze()
----
[discrete]
==== restore
Restores a snapshot.
@ -9667,17 +9883,6 @@ client.watcher.executeWatch({ ... })
** *`watch` (Optional, { actions, condition, input, metadata, status, throttle_period, throttle_period_in_millis, transform, trigger })*: When present, this watch is used instead of the one specified in the request. This watch is not persisted to the index and record_execution cannot be set.
** *`debug` (Optional, boolean)*: Defines whether the watch runs in debug mode.
[discrete]
==== get_settings
Retrieve settings for the watcher system index
{ref}/watcher-api-get-settings.html[Endpoint documentation]
[source,ts]
----
client.watcher.getSettings()
----
[discrete]
==== get_watch
Retrieves a watch by its ID.
@ -9780,17 +9985,6 @@ client.watcher.stop()
----
[discrete]
==== update_settings
Update settings for the watcher system index
{ref}/watcher-api-update-settings.html[Endpoint documentation]
[source,ts]
----
client.watcher.updateSettings()
----
[discrete]
=== xpack
[discrete]