diff --git a/api/_types/_common.d.ts b/api/_types/_common.d.ts index 42822e0c4..6270852f3 100644 --- a/api/_types/_common.d.ts +++ b/api/_types/_common.d.ts @@ -271,6 +271,7 @@ export type GetStats = { missing_time?: Duration; missing_time_in_millis: DurationValueUnitMillis; missing_total: number; + time?: Duration; time_in_millis: DurationValueUnitMillis; total: number; } diff --git a/api/asynchronousSearch/search.js b/api/asynchronousSearch/search.js index 99d231119..5ac25df9e 100644 --- a/api/asynchronousSearch/search.js +++ b/api/asynchronousSearch/search.js @@ -26,9 +26,9 @@ const { normalizeArguments } = require('../utils'); * * @param {object} [params] * @param {string} [params.index] - The name of the index to be searched. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index names. - * @param {string} [params.keep_alive] - The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours. The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time. If the query overruns this time, the process cancels this query automatically. - * @param {boolean} [params.keep_on_completion] - Whether you want to save the results in the cluster after the search is complete. You can examine the stored results at a later time. - * @param {string} [params.wait_for_completion_timeout] - The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`. + * @param {string} [params.keep_alive] - The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours. The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time. If the query exceeds this amount of time, the process cancels this query automatically. + * @param {boolean} [params.keep_on_completion] - Whether to save the results in the cluster after the search is complete. You can examine the stored results at a later time. + * @param {string} [params.wait_for_completion_timeout] - The amount of time to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`. * @param {object} [params.body] - The search definition using the Query DSL. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/asynchronousSearch/stats.js b/api/asynchronousSearch/stats.js index 465687c61..11dfbf39e 100644 --- a/api/asynchronousSearch/stats.js +++ b/api/asynchronousSearch/stats.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Monitors any asynchronous searches that are `running`, `completed`, `persisted`. + * Monitors any asynchronous searches that are `running`, `completed`, or `persisted`. *
See Also: {@link https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats - asynchronous_search.stats} * * @memberOf API-Asynchronous-Search diff --git a/api/cluster/allocationExplain.js b/api/cluster/allocationExplain.js index 6a9eff3fb..75e99eb5c 100644 --- a/api/cluster/allocationExplain.js +++ b/api/cluster/allocationExplain.js @@ -19,15 +19,15 @@ const { normalizeArguments } = require('../utils'); /** - * Provides explanations for shard allocations in the cluster. + * Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ - cluster.allocation_explain} * * @memberOf API-Cluster * * @param {object} [params] - * @param {boolean} [params.include_disk_info=false] - If `true`, returns information about disk usage and shard sizes. - * @param {boolean} [params.include_yes_decisions=false] - If `true`, returns YES decisions in explanation. - * @param {object} [params.body] - The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' + * @param {boolean} [params.include_disk_info=false] - When `true`, returns information about disk usage and shard sizes. + * @param {boolean} [params.include_yes_decisions=false] - When `true`, returns any `YES` decisions in the allocation explanation. + * @param {object} [params.body] - The index, shard, and primary flag for which to generate an explanation. Leave this empty to generate an explanation for the first unassigned shard. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/deleteComponentTemplate.js b/api/cluster/deleteComponentTemplate.js index 0ae0dea33..5bdfc4b46 100644 --- a/api/cluster/deleteComponentTemplate.js +++ b/api/cluster/deleteComponentTemplate.js @@ -26,9 +26,9 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * * @param {object} params * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} params.name - Name of the component template to delete. Wildcard (*) expressions are supported. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} [params.timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} params.name - The name of the component template to delete. Supports wildcard (*) expressions. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/deleteDecommissionAwareness.js b/api/cluster/deleteDecommissionAwareness.js index d40c60478..4bf99188f 100644 --- a/api/cluster/deleteDecommissionAwareness.js +++ b/api/cluster/deleteDecommissionAwareness.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Delete any existing decommission. + * Recommissions a decommissioned zone. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone - cluster.delete_decommission_awareness} * * @memberOf API-Cluster diff --git a/api/cluster/deleteVotingConfigExclusions.js b/api/cluster/deleteVotingConfigExclusions.js index 4d0fa3bcc..137edfcb4 100644 --- a/api/cluster/deleteVotingConfigExclusions.js +++ b/api/cluster/deleteVotingConfigExclusions.js @@ -19,13 +19,13 @@ const { normalizeArguments } = require('../utils'); /** - * Clears cluster voting config exclusions. + * Clears any cluster voting configuration exclusions. *
See Also: {@link https://opensearch.org/docs/latest - cluster.delete_voting_config_exclusions} * * @memberOf API-Cluster * * @param {object} [params] - * @param {boolean} [params.wait_for_removal=true] - Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to `false` then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. + * @param {boolean} [params.wait_for_removal=true] - Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. When `true`, all excluded nodes are removed from the cluster before this API takes any action. When `false`, the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/existsComponentTemplate.js b/api/cluster/existsComponentTemplate.js index f5522892e..8538e95da 100644 --- a/api/cluster/existsComponentTemplate.js +++ b/api/cluster/existsComponentTemplate.js @@ -25,10 +25,10 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Cluster * * @param {object} params - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} params.name - Name of the component template to check existence of. Wildcard (*) expressions are supported. + * @param {string} [params.cluster_manager_timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {boolean} [params.local=false] - When `true`, the request retrieves information from the local node only. When `false, information is retrieved from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} params.name - The name of the component template. Wildcard (*) expressions are supported. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/getComponentTemplate.js b/api/cluster/getComponentTemplate.js index 41e21bb98..6227bae8a 100644 --- a/api/cluster/getComponentTemplate.js +++ b/api/cluster/getComponentTemplate.js @@ -25,11 +25,11 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Cluster * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. + * @param {string} [params.cluster_manager_timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. * @param {boolean} [params.flat_settings=false] - If `true`, returns settings in flat format. - * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} [params.name] - Name of the component template to retrieve. Wildcard (`*`) expressions are supported. + * @param {boolean} [params.local=false] - When `true`, the request retrieves information from the local node only. When `false`, information is retrieved from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} [params.name] - The name of the component template to retrieve. Wildcard (`*`) expressions are supported. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/getDecommissionAwareness.js b/api/cluster/getDecommissionAwareness.js index df7e60204..570e38357 100644 --- a/api/cluster/getDecommissionAwareness.js +++ b/api/cluster/getDecommissionAwareness.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Get details and status of decommissioned attribute. + * Retrieves the decommission status for all zones. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status - cluster.get_decommission_awareness} * * @memberOf API-Cluster * * @param {object} params - * @param {string} params.awareness_attribute_name - Awareness attribute name. + * @param {string} params.awareness_attribute_name - The name of the awareness attribute. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/getSettings.js b/api/cluster/getSettings.js index ef1916640..1337d5ef9 100644 --- a/api/cluster/getSettings.js +++ b/api/cluster/getSettings.js @@ -25,11 +25,11 @@ const { normalizeArguments } = require('../utils'); * @memberOf API-Cluster * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {boolean} [params.flat_settings=false] - If `true`, returns settings in flat format. - * @param {boolean} [params.include_defaults=false] - If `true`, returns default cluster settings from the local node. - * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @param {string} [params.cluster_manager_timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {boolean} [params.flat_settings=false] - When `true`, returns cluster settings in a flat format. + * @param {boolean} [params.include_defaults=false] - When `true`, returns default cluster settings from the local node. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} [params.timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/getWeightedRouting.js b/api/cluster/getWeightedRouting.js index b811cda5a..e2c081cce 100644 --- a/api/cluster/getWeightedRouting.js +++ b/api/cluster/getWeightedRouting.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Cluster * * @param {object} params - * @param {string} params.attribute - Awareness attribute name. + * @param {string} params.attribute - The name of the awareness attribute. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/health.js b/api/cluster/health.js index 3763010ec..33d1c43d0 100644 --- a/api/cluster/health.js +++ b/api/cluster/health.js @@ -25,20 +25,20 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Cluster * * @param {object} [params] - * @param {string} [params.awareness_attribute] - The awareness attribute for which the health is required. - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. - * @param {string} [params.level] - Can be one of cluster, indexes or shards. Controls the details level of the health information returned. - * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} [params.wait_for_active_shards] - A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. - * @param {string} [params.wait_for_events] - Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. - * @param {boolean} [params.wait_for_no_initializing_shards] - A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. - * @param {boolean} [params.wait_for_no_relocating_shards] - A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. - * @param {string} [params.wait_for_nodes] - The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status. - * @param {string} [params.index] - Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. + * @param {string} [params.awareness_attribute] - The name of the awareness attribute for which to return the cluster health status (for example, `zone`). Applicable only if `level` is set to `awareness_attributes`. + * @param {string} [params.cluster_manager_timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} [params.expand_wildcards] - Specifies the type of index that wildcard expressions can match. Supports comma-separated values. + * @param {string} [params.level] + * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} [params.timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} [params.wait_for_active_shards] - Waits until the specified number of shards is active before returning a response. Use `all` for all shards. + * @param {string} [params.wait_for_events] - Waits until all currently queued events with the given priority are processed. + * @param {boolean} [params.wait_for_no_initializing_shards=false] - Whether to wait until there are no initializing shards in the cluster. + * @param {boolean} [params.wait_for_no_relocating_shards] - Whether to wait until there are no relocating shards in the cluster. + * @param {string} [params.wait_for_nodes] - Waits until the specified number of nodes (`N`) is available. Accepts `>=N`, `<=N`, `>N`, and ` See Also: {@link https://opensearch.org/docs/latest - cluster.pending_tasks} * * @memberOf API-Cluster * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. + * @param {string} [params.cluster_manager_timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {boolean} [params.local=false] - When `true`, the request retrieves information from the local node only. When `false`, information is retrieved from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/postVotingConfigExclusions.js b/api/cluster/postVotingConfigExclusions.js index aefa841d2..24bc6551f 100644 --- a/api/cluster/postVotingConfigExclusions.js +++ b/api/cluster/postVotingConfigExclusions.js @@ -19,15 +19,15 @@ const { normalizeArguments } = require('../utils'); /** - * Updates the cluster voting config exclusions by node ids or node names. + * Updates the cluster voting configuration by excluding certain node IDs or names. *
See Also: {@link https://opensearch.org/docs/latest - cluster.post_voting_config_exclusions} * * @memberOf API-Cluster * * @param {object} [params] - * @param {string} [params.node_ids] - A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify `node_names`. - * @param {string} [params.node_names] - A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify `node_ids`. - * @param {string} [params.timeout] - When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. + * @param {string} [params.node_ids] - A comma-separated list of node IDs to exclude from the voting configuration. When using this setting, you cannot also specify `node_names`. + * @param {string} [params.node_names] - A comma-separated list of node names to exclude from the voting configuration. When using this setting, you cannot also specify `node_ids`. + * @param {string} [params.timeout] - When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/putComponentTemplate.js b/api/cluster/putComponentTemplate.js index a610e7eae..2bc632c17 100644 --- a/api/cluster/putComponentTemplate.js +++ b/api/cluster/putComponentTemplate.js @@ -25,12 +25,12 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Cluster * * @param {object} params - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {boolean} [params.create=false] - If `true`, this request cannot replace or update existing component templates. - * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} [params.timeout] - Operation timeout. - * @param {string} params.name - Name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. OpenSearch Agent uses these templates to configure backing indexes for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. - * @param {object} params.body - The template definition + * @param {string} [params.cluster_manager_timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {boolean} [params.create=false] - When `true`, this request cannot replace or update existing component templates. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} [params.timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} params.name - The name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template `version` to a higher value than the current version. If you want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the Cluster Update Settings API. + * @param {object} params.body - The template definition. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/putDecommissionAwareness.js b/api/cluster/putDecommissionAwareness.js index 6c6ca4fc0..35681dbaf 100644 --- a/api/cluster/putDecommissionAwareness.js +++ b/api/cluster/putDecommissionAwareness.js @@ -19,14 +19,14 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Decommissions an awareness attribute. + * Decommissions a cluster zone based on awareness. This can greatly benefit multi-zone deployments, where awareness attributes can aid in applying new upgrades to a cluster in a controlled fashion. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone - cluster.put_decommission_awareness} * * @memberOf API-Cluster * * @param {object} params - * @param {string} params.awareness_attribute_name - Awareness attribute name. - * @param {string} params.awareness_attribute_value - Awareness attribute value. + * @param {string} params.awareness_attribute_name - The name of the awareness attribute. + * @param {string} params.awareness_attribute_value - The value of the awareness attribute. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/putSettings.js b/api/cluster/putSettings.js index bb4a28145..7e532b1c8 100644 --- a/api/cluster/putSettings.js +++ b/api/cluster/putSettings.js @@ -25,11 +25,11 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); * @memberOf API-Cluster * * @param {object} params - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {boolean} [params.flat_settings=false] - Return settings in flat format. - * @param {string} [params.master_timeout] DEPRECATED - Explicit operation timeout for connection to cluster-manager node - * @param {string} [params.timeout] - Explicit operation timeout - * @param {object} params.body - The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). + * @param {string} [params.cluster_manager_timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {boolean} [params.flat_settings=false] - Returns settings in a flat format. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} [params.timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {object} params.body - The cluster settings to update. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/putWeightedRouting.js b/api/cluster/putWeightedRouting.js index 89e3a7e60..2506c8598 100644 --- a/api/cluster/putWeightedRouting.js +++ b/api/cluster/putWeightedRouting.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Cluster * * @param {object} params - * @param {string} params.attribute - Awareness attribute name. + * @param {string} params.attribute - The name of the awareness attribute. * @param {string} [params.body] * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/cluster/reroute.js b/api/cluster/reroute.js index 76572359b..5ff628f42 100644 --- a/api/cluster/reroute.js +++ b/api/cluster/reroute.js @@ -25,13 +25,13 @@ const { normalizeArguments } = require('../utils'); * @memberOf API-Cluster * * @param {object} [params] - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {boolean} [params.dry_run] - If `true`, then the request simulates the operation only and returns the resulting state. - * @param {boolean} [params.explain] - If `true`, then the response contains an explanation of why the commands can or cannot be executed. - * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. + * @param {string} [params.cluster_manager_timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {boolean} [params.dry_run] - When `true`, the request simulates the operation and returns the resulting state. + * @param {boolean} [params.explain] - When `true`, the response contains an explanation of why certain commands can or cannot be executed. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. * @param {string} [params.metric] - Limits the information returned to the specified metrics. - * @param {boolean} [params.retry_failed] - If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures. - * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * @param {boolean} [params.retry_failed] - When `true`, retries shard allocation if it was blocked because of too many subsequent failures. + * @param {string} [params.timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. * @param {object} [params.body] - The definition of `commands` to perform (`move`, `cancel`, `allocate`) * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/cluster/state.js b/api/cluster/state.js index 9f18dcb0a..463cdb919 100644 --- a/api/cluster/state.js +++ b/api/cluster/state.js @@ -19,23 +19,23 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns a comprehensive information about the state of the cluster. + * Returns comprehensive information about the state of the cluster. *
See Also: {@link https://opensearch.org/docs/latest - cluster.state} * * @memberOf API-Cluster * * @param {object} [params] - * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified) - * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. - * @param {boolean} [params.flat_settings=false] - Return settings in flat format. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed) - * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. - * @param {string} [params.master_timeout] DEPRECATED - Specify timeout for connection to cluster manager. + * @param {boolean} [params.allow_no_indices] - Whether to ignore a wildcard index expression that resolves into no concrete indexes. This includes the `_all` string or when no indexes have been specified. + * @param {string} [params.cluster_manager_timeout] - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + * @param {string} [params.expand_wildcards] - Specifies the type of index that wildcard expressions can match. Supports comma-separated values. + * @param {boolean} [params.flat_settings=false] - Returns settings in a flat format. + * @param {boolean} [params.ignore_unavailable] - Whether the specified concrete indexes should be ignored when unavailable (missing or closed). + * @param {boolean} [params.local=false] - Whether to return information from the local node only instead of from the cluster manager node. + * @param {string} [params.master_timeout] DEPRECATED - A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. * @param {number} [params.wait_for_metadata_version] - Wait for the metadata version to be equal or greater than the specified metadata version. * @param {string} [params.wait_for_timeout] - The maximum time to wait for `wait_for_metadata_version` before timing out. - * @param {array} [params.metric] - Limit the information returned to the specified metrics - * @param {string} [params.index] - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes + * @param {array} [params.metric] - Limits the information returned to only the specified metrics. + * @param {string} [params.index] - A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/stats.js b/api/cluster/stats.js index 8546bac57..2304b5067 100644 --- a/api/cluster/stats.js +++ b/api/cluster/stats.js @@ -19,17 +19,17 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns high-level overview of cluster statistics. + * Returns a high-level overview of cluster statistics. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ - cluster.stats} * * @memberOf API-Cluster * * @param {object} [params] - * @param {boolean} [params.flat_settings=false] - If `true`, returns settings in flat format. - * @param {string} [params.timeout] - Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. - * @param {array} [params.index_metric] - Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. + * @param {boolean} [params.flat_settings=false] - When `true`, returns settings in a flat format. + * @param {string} [params.timeout] - The amount of time to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. + * @param {array} [params.index_metric] - A comma-separated list of index metric groups, for example, `docs,store`. * @param {array} [params.metric] - Limit the information returned to the specified metrics. - * @param {string} [params.node_id] - Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. + * @param {string} [params.node_id] - A comma-separated list of node IDs used to filter results. Supports [node filters](https://opensearch.org/docs/latest/api-reference/nodes-apis/index/#node-filters). * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response