From db901a1bd0a7cdc77a448e631ffa8fa14040ceec Mon Sep 17 00:00:00 2001 From: Archer Date: Tue, 15 Apr 2025 16:24:11 -0500 Subject: [PATCH 1/4] Add Snapshot automation markers Signed-off-by: Archer --- .../snapshots/cleanup-snapshot-repository.md | 77 +- _api-reference/snapshots/clone-snapshot.md | 17 + _api-reference/snapshots/create-repository.md | 134 +- _api-reference/snapshots/create-snapshot.md | 474 +- .../snapshots/delete-snapshot-repository.md | 50 +- _api-reference/snapshots/delete-snapshot.md | 49 +- .../snapshots/get-snapshot-repository.md | 93 +- .../snapshots/get-snapshot-status.md | 398 +- _api-reference/snapshots/get-snapshot.md | 446 +- _api-reference/snapshots/restore-snapshot.md | 5304 +++++++++++++++++ .../snapshots/verify-snapshot-repository.md | 82 +- 11 files changed, 6967 insertions(+), 157 deletions(-) diff --git a/_api-reference/snapshots/cleanup-snapshot-repository.md b/_api-reference/snapshots/cleanup-snapshot-repository.md index 202410c758a..3a9038f2a9c 100644 --- a/_api-reference/snapshots/cleanup-snapshot-repository.md +++ b/_api-reference/snapshots/cleanup-snapshot-repository.md @@ -11,27 +11,82 @@ Introduced 1.0 The Cleanup Snapshot Repository API clears a snapshot repository of data no longer referenced by any existing snapshot. + ## Endpoints - ```json -POST /_snapshot//_cleanup +POST /_snapshot/{repository}/_cleanup ``` + + ## Path parameters -| Parameter | Data type | Description | -| :--- | :--- | :--- | -| `repository` | String | The name of the snapshot repository. | +The following table lists the available path parameters. + +| Parameter | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `repository` | **Required** | String | Snapshot repository to clean up. | + + + ## Query parameters The following table lists the available query parameters. All query parameters are optional. -| Parameter | Data type | Description | +| Parameter | Data type | Description | | :--- | :--- | :--- | -| `cluster_manager_timeout` | Time | The amount of time to wait for a response from the cluster manager node. Formerly called `master_timeout`. Optional. Default is 30 seconds. | -| `timeout` | Time | The amount of time to wait for the operation to complete. Optional.| +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | +| `timeout` | String | The amount of time to wait for a response. | + + + + + + + + +## Response body fields + +The response body is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `results` | **Required** | Object | | + +
+ + Response body fields: results + + {: .text-delta} + +`results` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `deleted_blobs` | **Required** | Integer | The number of binary large objects (blobs) removed during cleanup. | +| `deleted_bytes` | **Required** | Integer | The number of bytes freed by cleanup operations. | + +
+ + ## Example request @@ -54,10 +109,4 @@ POST /_snapshot/my_backup/_cleanup } ``` -## Response body fields - -| Field | Data type | Description | -| :--- | :--- | :--- | -| `deleted_bytes` | Integer | The number of bytes made available in the snapshot after data deletion. | -| `deleted_blobs` | Integer | The number of binary large objects (BLOBs) cleared from the repository by the request. | diff --git a/_api-reference/snapshots/clone-snapshot.md b/_api-reference/snapshots/clone-snapshot.md index d220eb266bf..a73be4947c2 100644 --- a/_api-reference/snapshots/clone-snapshot.md +++ b/_api-reference/snapshots/clone-snapshot.md @@ -55,6 +55,23 @@ The following table lists the available query parameters. All query parameters a + +## Request body fields + +The snapshot clone definition. + +The request body is __required__. It is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `indices` | **Required** | String | | + + + + ## Example request The following request clones indexes `index_a` and `index_b` from `my_snapshot`, a snapshot located in the snapshot repository `my-opensearch-repo`, into a new snapshot in the same repository called `my_new_snapshot`: diff --git a/_api-reference/snapshots/create-repository.md b/_api-reference/snapshots/create-repository.md index 3567b56f881..56e93cee26f 100644 --- a/_api-reference/snapshots/create-repository.md +++ b/_api-reference/snapshots/create-repository.md @@ -19,24 +19,124 @@ There are two types of snapshot repositories: For instructions on creating a repository, see [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository). + ## Endpoints - ```json -POST /_snapshot// -PUT /_snapshot// +POST /_snapshot/{repository} +PUT /_snapshot/{repository} ``` + + + ## Path parameters -Parameter | Data type | Description -:--- | :--- | :--- -`repository` | String | Repository name | +The following table lists the available path parameters. + +| Parameter | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `repository` | **Required** | String | The name for the newly registered repository. | + + + + +## Query parameters + +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | +| `timeout` | String | The amount of time to wait for a response. | +| `verify` | Boolean | When `true`, verifies the creation of the snapshot repository. | + + + + +## Request body fields + +The repository definition. + +The request body is __required__. It is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `settings` | **Required** | Object | The settings for the snapshot repository. | +| `type` | **Required** | String | | +| `repository` | _Optional_ | Object | The name of the repository to store the snapshot. | + +
+ + Request body fields: repository + + {: .text-delta} + +The name of the repository to store the snapshot. -## Request parameters +`repository` is a JSON object with the following fields. -Request parameters depend on the type of repository: `fs` or `s3`. +| Property | Data type | Description | +| :--- | :--- | :--- | +| `settings` | Object | The settings for the snapshot repository. | +| `type` | String | The type of the snapshot repository. | +| `uuid` | String | The universally unique identifier. | -### Common parameters +
+
+ + Request body fields: repository > settings + + {: .text-delta} + +The settings for the snapshot repository. + +`settings` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `chunk_size` | String | The chunk size for the repository. | +| `compress` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `concurrent_streams` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `location` | String | The location where snapshots are stored. | +| `read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: settings + + {: .text-delta} + +The settings for the snapshot repository. + +`settings` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `chunk_size` | String | The chunk size for the repository. | +| `compress` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `concurrent_streams` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `location` | String | The location where snapshots are stored. | +| `read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+ + + +### Repository specific parameters The following table lists parameters that can be used with both the `fs` and `s3` repositories. @@ -136,3 +236,19 @@ Upon success, the following JSON object is returned: To verify that the repository was registered, use the [Get snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository) API, passing the repository name as the `repository` path parameter. {: .note} + + +## Response body fields + +The response body is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `acknowledged` | **Required** | Boolean | | +| `index` | **Required** | String | | +| `shards_acknowledged` | **Required** | Boolean | | + + diff --git a/_api-reference/snapshots/create-snapshot.md b/_api-reference/snapshots/create-snapshot.md index ce96bd6442f..d7a74e85e77 100644 --- a/_api-reference/snapshots/create-snapshot.md +++ b/_api-reference/snapshots/create-snapshot.md @@ -15,36 +15,476 @@ Creates a snapshot within an existing repository. * To view a list of your repositories, see [Get snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository). + ## Endpoints - ```json -PUT /_snapshot// -POST /_snapshot// +POST /_snapshot/{repository}/{snapshot} +PUT /_snapshot/{repository}/{snapshot} ``` + + + ## Path parameters -Parameter | Data type | Description -:--- | :--- | :--- -repository | String | Repository name to store the snapshot. | -snapshot | String | Name of Snapshot to create. | +The following table lists the available path parameters. + +| Parameter | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `repository` | **Required** | String | The name of the repository where the snapshot will be stored. | +| `snapshot` | **Required** | String | The name of the snapshot. Must be unique in the repository. | + + + ## Query parameters -Parameter | Data type | Description -:--- | :--- | :--- -wait_for_completion | Boolean | Whether to wait for snapshot creation to complete before continuing. If you include this parameter, the snapshot definition is returned after completion. | +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | +| `wait_for_completion` | Boolean | When `true`, the request returns a response when the snapshot is complete. When `false`, the request returns a response when the snapshot initializes. _(Default: `false`)_ | +| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ 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. | + + + ## Request body fields -The request body is optional. +The snapshot definition. + +The request body is optional. It is a JSON object with the following fields. + +| Property | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `feature_states` | Array of Strings | A list of feature states to include in the snapshot. Each feature state includes one or more system indexes which contain related data. You can view a list of features using the Get Feature API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. | N/A | +| `ignore_unavailable` | Boolean | When `true`, the request ignores any data streams and indexes that are missing or closed. When `false`, the request returns an error for any data streams or indexes that is missing or closed. | N/A | +| `include_global_state` | Boolean | When `true`, includes the current cluster state in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. The cluster state also includes data stored in system indexes, such as watches and task records (configurable with `feature_states`). | `true` | +| `indices` | Array of Strings or String | 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`. | N/A | +| `metadata` | Object | The custom metadata attached to a resource. | N/A | +| `partial` | Boolean | When `true`, enables the restoration of a partial snapshot from indexes with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. When `false`, the entire restore operation will fail if one or more indexes included in the snapshot do not have all primary shards available. | `false` | + +
+ + Request body fields: metadata + + {: .text-delta} + +The custom metadata attached to a resource. + +`metadata` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | + +
+
+ + Request body fields: metadata > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+ + + +## Response body fields + +The response body is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `accepted` | Boolean | Returns `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`. | +| `snapshot` | Object | | + +
+ + Response body fields: snapshot + + {: .text-delta} + +`snapshot` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `data_streams` | Array of Strings | The list of data streams included in the snapshot. | +| `duration` | String | 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. | +| `duration_in_millis` | Integer | The time unit for milliseconds. | +| `end_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `end_time_in_millis` | Integer | The time unit for milliseconds. | +| `failures` | Array of Objects | The list of shard failures that occurred during the snapshot. | +| `include_global_state` | Boolean | Whether the snapshot includes the cluster state. | +| `indices` | Array of Strings | The list of indexes included in the snapshot. | +| `metadata` | Object | The custom metadata attached to a resource. | +| `pinned_timestamp` | Integer | The time unit for milliseconds. | +| `reason` | String | The reason for the snapshot creation. | +| `remote_store_index_shallow_copy` | Boolean | Whether the snapshot uses remote store index shallow copy. | +| `shards` | Object | The statistics about the shards included in the snapshot. | +| `snapshot` | String | The name of a resource or configuration element. | +| `start_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `start_time_in_millis` | Integer | The time unit for milliseconds. | +| `state` | String | The current state of the snapshot. | +| `uuid` | String | The universally unique identifier. | +| `version` | String | The version of OpenSearch when the snapshot was created. | +| `version_id` | Integer | The internal version number of OpenSearch when the snapshot was created. | + +
+
+ + Response body fields: snapshot > end_time + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`end_time` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > end_time + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`end_time` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > end_time + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`end_time` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > failures + + {: .text-delta} + +The list of shard failures that occurred during the snapshot. + +`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `index` | String | The name of the index containing the failed shard. | +| `node_id` | String | The unique identifier for a resource. | +| `reason` | String | The reason for the shard failure. | +| `shard_id` | String | The unique identifier for a resource. | +| `status` | String | The status of the failed shard. | + +
+
+ + Response body fields: snapshot > metadata + + {: .text-delta} + +The custom metadata attached to a resource. + +`metadata` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | + +
+
+ + Response body fields: snapshot > metadata > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > shards + + {: .text-delta} + +The statistics about the shards included in the snapshot. + +`shards` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `failed` | **Required** | Integer | | +| `successful` | **Required** | Integer | | +| `total` | **Required** | Integer | | +| `failures` | _Optional_ | Array of Objects | | +| `skipped` | _Optional_ | Integer | | + +
+
+ + Response body fields: snapshot > shards > failures + + {: .text-delta} + +`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `reason` | **Required** | Object | | +| `shard` | **Required** | Integer | | +| `index` | _Optional_ | String | | +| `node` | _Optional_ | String | | +| `status` | _Optional_ | String | | + +
+
+ + Response body fields: snapshot > shards > failures > reason + + {: .text-delta} + +`reason` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by + + {: .text-delta} + +`caused_by` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > root_cause + + {: .text-delta} + +`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > suppressed + + {: .text-delta} + +`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > suppressed > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > suppressed + + {: .text-delta} + +`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > shards > failures > reason > root_cause + + {: .text-delta} + +`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > suppressed + + {: .text-delta} + +`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > start_time + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`start_time` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Data type | Description | +| :--- | :--- | :--- | -Field | Data type | Description -:--- | :--- | :--- -`indices` | String | The indices you want to include in the snapshot. You can use `,` to create a list of indices, `*` to specify an index pattern, and `-` to exclude certain indices. Don't put spaces between items. Default is all indices. -`ignore_unavailable` | Boolean | If an index from the `indices` list doesn't exist, whether to ignore it rather than fail the snapshot. Default is `false`. -`include_global_state` | Boolean | Whether to include cluster state in the snapshot. Default is `true`. -`partial` | Boolean | Whether to allow partial snapshots. Default is `false`, which fails the entire snapshot if one or more shards fails to stor +
+ ## Example requests diff --git a/_api-reference/snapshots/delete-snapshot-repository.md b/_api-reference/snapshots/delete-snapshot-repository.md index 14c2b6c86a8..dd549296e6e 100644 --- a/_api-reference/snapshots/delete-snapshot-repository.md +++ b/_api-reference/snapshots/delete-snapshot-repository.md @@ -15,17 +15,54 @@ A repository in OpenSearch is simply a configuration that maps a repository name To learn more about repositories, see [Register or update snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-repository). + ## Endpoints - ```json -DELETE _snapshot/ +DELETE /_snapshot/{repository} ``` + + + ## Path parameters -Parameter | Data type | Description -:--- | :--- | :--- -repository | String | Repository to delete. | +The following table lists the available path parameters. + +| Parameter | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `repository` | **Required** | List or String | The name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. | + + + + +## Query parameters + +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | +| `timeout` | String | The amount of time to wait for a response. | +| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ Explicit operation timeout for connection to cluster-manager node | + + + + + + + ## Example request @@ -47,4 +84,5 @@ Upon success, the response returns the following JSON object: ```` To verify that the repository was deleted, use the [Get snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository) API, passing the repository name as the `repository` path parameter. -{: .note} \ No newline at end of file +{: .note} + diff --git a/_api-reference/snapshots/delete-snapshot.md b/_api-reference/snapshots/delete-snapshot.md index faed3b92d05..fbc1dd59085 100644 --- a/_api-reference/snapshots/delete-snapshot.md +++ b/_api-reference/snapshots/delete-snapshot.md @@ -17,18 +17,53 @@ Deletes a snapshot from a repository. * To view a list of your snapshots, see [cat snapshots]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-snapshots). -## Path and HTTP method - + +## Endpoints ```json -DELETE _snapshot// +DELETE /_snapshot/{repository}/{snapshot} ``` + + + ## Path parameters -Parameter | Data type | Description -:--- | :--- | :--- -repository | String | Repository that contains the snapshot. | -snapshot | String | Snapshot to delete. | +The following table lists the available path parameters. + +| Parameter | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `repository` | **Required** | String | The name of the snapshot repository to delete. | +| `snapshot` | **Required** | String | A comma-separated list of snapshot names to delete from the repository. | + + + + +## Query parameters + +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | + + + + + + ## Example request diff --git a/_api-reference/snapshots/get-snapshot-repository.md b/_api-reference/snapshots/get-snapshot-repository.md index 522ea0c6599..5ea36b17112 100644 --- a/_api-reference/snapshots/get-snapshot-repository.md +++ b/_api-reference/snapshots/get-snapshot-repository.md @@ -22,18 +22,49 @@ You can also get details about a snapshot during and after snapshot creation. Se GET /_snapshot/ ``` + +## Endpoints +```json +GET /_snapshot +GET /_snapshot/{repository} +``` + + + + ## Path parameters +The following table lists the available path parameters. All path parameters are optional. + | Parameter | Data type | Description | | :--- | :--- | :--- | -| repository | String | A comma-separated list of snapshot repository names to retrieve. Wildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`. | +| `repository` | List or String | A comma-separated list of repository names. | + + + ## Query parameters -| Parameter | Data type | Description | -:--- | :--- | :--- -| local | Boolean | Whether to get information from the local node. Optional, defaults to `false`.| -| cluster_manager_timeout | Time | Amount of time to wait for a connection to the cluster manager node. Optional, defaults to 30 seconds. | +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | +| `local` | Boolean | Whether to get information from the local node. _(Default: `false`)_ | +| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ Explicit operation timeout for connection to cluster-manager node | + + + + ## Example request @@ -60,10 +91,52 @@ Upon success, the response returns repositry information. This sample is for an } ```` + ## Response body fields -| Field | Data type | Description | -| :--- | :--- | :--- | -| type | string | Bucket type: `fs` (file system) or `s3` (s3 bucket) | -| bucket | string | S3 bucket name. | -| base_path | string | Folder within the bucket where snapshots are stored. | \ No newline at end of file +The response body is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | The name of the repository to store the snapshot. | + +
+ + Response body fields: -- freeform field -- + + {: .text-delta} + +The name of the repository to store the snapshot. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `settings` | Object | The settings for the snapshot repository. | +| `type` | String | The type of the snapshot repository. | +| `uuid` | String | The universally unique identifier. | + +
+
+ + Response body fields: -- freeform field -- > settings + + {: .text-delta} + +The settings for the snapshot repository. + +`settings` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `chunk_size` | String | The chunk size for the repository. | +| `compress` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `concurrent_streams` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `location` | String | The location where snapshots are stored. | +| `read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+ diff --git a/_api-reference/snapshots/get-snapshot-status.md b/_api-reference/snapshots/get-snapshot-status.md index 83043b7684f..130e28fdc84 100644 --- a/_api-reference/snapshots/get-snapshot-status.md +++ b/_api-reference/snapshots/get-snapshot-status.md @@ -22,39 +22,49 @@ If you use the Security plugin, you must have the `monitor_snapshot`, `create_sn GET _snapshot///_status ``` -## Path parameters - -Path parameters are optional. - -| Parameter | Data type | Description | -:--- | :--- | :--- -| repository | String | The repository containing the snapshot. | -| snapshot | List | The snapshot(s) to return. | -| index | List | The indexes to include in the response. | - -Three request variants provide flexibility: - -* `GET _snapshot/_status` returns the status of all currently running snapshots in all repositories. + +## Endpoints +```json +GET /_snapshot/_status +GET /_snapshot/{repository}/_status +GET /_snapshot/{repository}/{snapshot}/_status +``` + -* `GET _snapshot//_status` returns all currently running snapshots in the specified repository. This is the preferred variant. -* `GET _snapshot///_status` returns detailed status information for a specific snapshot(s) in the specified repository, regardless of whether it's currently running. + +## Path parameters -* `GET /_snapshot////_status` returns detailed status information only for the specified indexes in a specific snapshot in the specified repository. Note that this endpoint works only for indexes belonging to a specific snapshot. +The following table lists the available path parameters. All path parameters are optional. -Snapshot API calls only work if the total number of shards across the requested resources, such as snapshots and indexes created from snapshots, is smaller than the limit specified by the following cluster setting: +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `repository` | String | The name of the repository containing the snapshot. | +| `snapshot` | List or String | A comma-separated list of snapshot names. | -- `snapshot.max_shards_allowed_in_status_api`(Dynamic, integer): The maximum number of shards that can be included in the Snapshot Status API response. Default value is `200000`. Not applicable for [shallow snapshots v2]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/remote-store/snapshot-interoperability##shallow-snapshot-v2), where the total number and sizes of files are returned as 0. + + +## Query parameters -Using the API to return the state of snapshots that are not currently running can be very costly in terms of both machine resources and processing time when querying data in the cloud. For each snapshot, each request causes a file read of all of the snapshot's shards. -{: .warning} +The following table lists the available query parameters. All query parameters are optional. -## Request body fields +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | +| `ignore_unavailable` | Boolean | Whether to ignore any unavailable snapshots, When `false`, a `SnapshotMissingException` is thrown. _(Default: `false`)_ | +| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ Explicit operation timeout for connection to cluster-manager node | -| Field | Data type | Description | -:--- | :--- | :--- -| ignore_unavailable | Boolean | How to handle requests for unavailable snapshots and indexes. If `false`, the request returns an error for unavailable snapshots and indexes. If `true`, the request ignores unavailable snapshots and indexes, such as those that are corrupted or temporarily cannot be returned. Default is `false`.| + ## Example request @@ -383,55 +393,295 @@ The `GET _snapshot/my-opensearch-repo/my-first-snapshot/_status` request returns } ```` + ## Response body fields -| Field | Data type | Description | -:--- | :--- | :--- -| repository | String | Name of repository that contains the snapshot. | -| snapshot | String | Snapshot name. | -| uuid | String | A snapshot's universally unique identifier (UUID). | -| state | String | Snapshot's current status. See [Snapshot states](#snapshot-states). | -| include_global_state | Boolean | Whether the current cluster state is included in the snapshot. | -| shards_stats | Object | Snapshot's shard counts. See [Shard stats](#shard-stats). | -| stats | Object | Information about files included in the snapshot. `file_count`: number of files. `size_in_bytes`: total size of all files. See [Snapshot file stats](#snapshot-file-stats). | -| index | list of Objects | List of objects that contain information about the indices in the snapshot. See [Index objects](#index-objects).| - -### Snapshot states - -| State | Description | -:--- | :--- | -| FAILED | The snapshot terminated in an error and no data was stored. | -| IN_PROGRESS | The snapshot is currently running. | -| PARTIAL | The global cluster state was stored, but data from at least one shard was not stored. The `failures` property of the [Create snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-snapshot) response contains additional details. | -| SUCCESS | The snapshot finished and all shards were stored successfully. | - -### Shard stats - -All property values are integers. - -| Property | Description | -:--- | :--- | -| initializing | Number of shards that are still initializing. | -| started | Number of shards that have started but not are not finalized. | -| finalizing | Number of shards that are finalizing but are not done. | -| done | Number of shards that initialized, started, and finalized successfully. | -| failed | Number of shards that failed to be included in the snapshot. | -| total | Total number of shards included in the snapshot. | - -### Snapshot file stats - -| Property | Type | Description | -:--- | :--- | :--- | -| incremental | Object | Number and size of files that still need to be copied during snapshot creation. For completed snapshots, `incremental` provides the number and size of files that were not already in the repository and were copied as part of the incremental snapshot. | -| processed | Object | Number and size of files already uploaded to the snapshot. The processed `file_count` and `size_in_bytes` are incremented in stats after a file is uploaded. | -| total | Object | Total number and size of files that are referenced by the snapshot. | -| start_time_in_millis | Long | Time (in milliseconds) when snapshot creation began. | -| time_in_millis | Long | Total time (in milliseconds) that the snapshot took to complete. | - -### Index objects - -| Property | Type | Description | -:--- | :--- | :--- | -| shards_stats | Object | See [Shard stats](#shard-stats). | -| stats | Object | See [Snapshot file stats](#snapshot-file-stats). | -| shards | List of objects | Contains information about the shards included in the snapshot. OpenSearch returns the following properties about the shard:

**stage**: The current state of shards in the snapshot. Shard states are:

* DONE: The number of shards in the snapshot that were successfully stored in the repository.

* FAILURE: The number of shards in the snapshot that were not successfully stored in the repository.

* FINALIZE: The number of shards in the snapshot that are in the finalizing stage of being stored in the repository.

* INIT: The number of shards in the snapshot that are in the initializing stage of being stored in the repository.

* STARTED: The number of shards in the snapshot that are in the started stage of being stored in the repository.

**stats**: See [Snapshot file stats](#snapshot-file-stats).

**total**: The total number and sizes of files referenced by the snapshot.

**start_time_in_millis**: The time (in milliseconds) when snapshot creation began.

**time_in_millis**: The total amount of time (in milliseconds) that the snapshot took to complete. | +The response body is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `snapshots` | **Required** | Array of Objects | | + +
+ + Response body fields: snapshots + + {: .text-delta} + +`snapshots` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `include_global_state` | Boolean | Whether the snapshot includes the cluster state. | +| `indices` | Object | The status of indexes in the snapshot. | +| `repository` | String | The name of the repository containing the snapshot. | +| `shards_stats` | Object | The statistics about snapshot shards. | +| `snapshot` | String | The name of the snapshot. | +| `state` | String | The current state of the snapshot. | +| `stats` | Object | The detailed statistics about the snapshot. | +| `uuid` | String | The universally unique identifier. | + +
+
+ + Response body fields: snapshots > indices + + {: .text-delta} + +The status of indexes in the snapshot. + +`indices` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `shards` | Object | The status of individual shards in the snapshot. | +| `shards_stats` | Object | The statistics about snapshot shards. | +| `stats` | Object | The detailed statistics about the snapshot. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > shards + + {: .text-delta} + +The status of individual shards in the snapshot. + +`shards` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `stage` | **Required** | String | The current stage of the shard snapshot.
Valid values are:
- `DONE`: The number of shards in the snapshot that were successfully stored in the repository.
- `FAILURE`: The number of shards in the snapshot that were not successfully stored in the repository.
- `FINALIZE`: The number of shards in the snapshot that are in the finalizing stage of being stored in the repository.
- `INIT`: The number of shards in the snapshot that are in the initializing stage of being stored in the repository.
- `STARTED`: The number of shards in the snapshot that are in the started stage of being stored in the repository. | +| `stats` | **Required** | Object | The statistical summary of the shard snapshot. | +| `node` | _Optional_ | String | The unique identifier of a node. | +| `reason` | _Optional_ | String | The reason for the current shard status. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- > stats + + {: .text-delta} + +The statistical summary of the shard snapshot. + +`stats` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `incremental` | Object | The incremental statistics for the shard snapshot. | +| `processed` | Object | The processed statistics for the shard snapshot. | +| `start_time_in_millis` | Integer | The time unit for milliseconds. | +| `time` | String | 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. | +| `time_in_millis` | Integer | The time unit for milliseconds. | +| `total` | Object | The total statistics for the shard snapshot. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- > stats > incremental + + {: .text-delta} + +The incremental statistics for the shard snapshot. + +`incremental` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `file_count` | Integer | The number of files in the shard snapshot. | +| `size_in_bytes` | Integer | The size in bytes. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- > stats > processed + + {: .text-delta} + +The processed statistics for the shard snapshot. + +`processed` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `file_count` | Integer | The number of files in the shard snapshot. | +| `size_in_bytes` | Integer | The size in bytes. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- > stats > total + + {: .text-delta} + +The total statistics for the shard snapshot. + +`total` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `file_count` | Integer | The number of files in the shard snapshot. | +| `size_in_bytes` | Integer | The size in bytes. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > shards_stats + + {: .text-delta} + +The statistics about snapshot shards. + +`shards_stats` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `done` | Integer | The number of completed shard snapshots. | +| `failed` | Integer | The number of failed shard snapshots. | +| `finalizing` | Integer | The number of finalizing shard snapshots. | +| `initializing` | Integer | The number of initializing shard snapshots. | +| `started` | Integer | The number of started shard snapshots. | +| `total` | Integer | The total number of shard snapshots. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > stats + + {: .text-delta} + +The detailed statistics about the snapshot. + +`stats` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `incremental` | Object | The incremental statistics for the snapshot. | +| `processed` | Object | The processed statistics for the snapshot. | +| `start_time_in_millis` | Integer | The time unit for milliseconds. | +| `time` | String | 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. | +| `time_in_millis` | Integer | The time unit for milliseconds. | +| `total` | Object | The total statistics for the snapshot. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > stats > incremental + + {: .text-delta} + +The incremental statistics for the snapshot. + +`incremental` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `file_count` | Integer | The number of files in the snapshot. | +| `size_in_bytes` | Integer | The size in bytes. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > stats > processed + + {: .text-delta} + +The processed statistics for the snapshot. + +`processed` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `file_count` | Integer | The number of files in the snapshot. | +| `size_in_bytes` | Integer | The size in bytes. | + +
+
+ + Response body fields: snapshots > indices > -- freeform field -- > stats > total + + {: .text-delta} + +The total statistics for the snapshot. + +`total` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `file_count` | Integer | The number of files in the snapshot. | +| `size_in_bytes` | Integer | The size in bytes. | + +
+
+ + Response body fields: snapshots > shards_stats + + {: .text-delta} + +The statistics about snapshot shards. + +`shards_stats` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `done` | Integer | The number of completed shard snapshots. | +| `failed` | Integer | The number of failed shard snapshots. | +| `finalizing` | Integer | The number of finalizing shard snapshots. | +| `initializing` | Integer | The number of initializing shard snapshots. | +| `started` | Integer | The number of started shard snapshots. | +| `total` | Integer | The total number of shard snapshots. | + +
+
+ + Response body fields: snapshots > stats + + {: .text-delta} + +The detailed statistics about the snapshot. + +`stats` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `incremental` | Object | The incremental statistics for the snapshot. | +| `processed` | Object | The processed statistics for the snapshot. | +| `start_time_in_millis` | Integer | The time unit for milliseconds. | +| `time` | String | 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. | +| `time_in_millis` | Integer | The time unit for milliseconds. | +| `total` | Object | The total statistics for the snapshot. | + +
+ + + diff --git a/_api-reference/snapshots/get-snapshot.md b/_api-reference/snapshots/get-snapshot.md index c936cab6024..e38c8730a6d 100644 --- a/_api-reference/snapshots/get-snapshot.md +++ b/_api-reference/snapshots/get-snapshot.md @@ -17,6 +17,58 @@ Retrieves information about a snapshot. GET _snapshot/// ``` + + +## Endpoints +```json +GET /_snapshot/{repository}/{snapshot} +``` + + + + +## Path parameters + +The following table lists the available path parameters. + +| Parameter | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `repository` | **Required** | String | A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. | +| `snapshot` | **Required** | List or String | A comma-separated list of snapshot names to retrieve. Also accepts wildcard expressions. (`*`). - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. - To get information about any snapshots that are currently running, use `_current`. | + + + + +## Query parameters + +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | +| `ignore_unavailable` | Boolean | When `false`, the request returns an error for any snapshots that are unavailable. _(Default: `false`)_ | +| `verbose` | Boolean | When `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards contained in the snapshot. | +| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ 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. | + + + + + + + + ## Path parameters | Parameter | Data type | Description | @@ -79,22 +131,382 @@ Upon success, the response returns snapshot information: ] } ```` + + ## Response body fields -| Field | Data type | Description | -| :--- | :--- | :--- | -| snapshot | string | Snapshot name. | -| uuid | string | Snapshot's universally unique identifier (UUID). | -| version_id | int | Build ID of the Open Search version that created the snapshot. | -| version | float | Open Search version that created the snapshot. | -| indices | array | Indices in the snapshot. | -| data_streams | array | Data streams in the snapshot. | -| include_global_state | boolean | Whether the current cluster state is included in the snapshot. | -| start_time | string | Date/time when the snapshot creation process began. | -| start_time_in_millis | long | Time (in milliseconds) when the snapshot creation process began. | -| end_time | string | Date/time when the snapshot creation process ended. | -| end_time_in_millis | long | Time (in milliseconds) when the snapshot creation process ended. | -| duration_in_millis | long | Total time (in milliseconds) that the snapshot creation process lasted. | -| failures | array | Failures, if any, that occured during snapshot creation. | -| shards | object | Total number of shards created along with number of successful and failed shards. | -| state | string | Snapshot status. Possible values: `IN_PROGRESS`, `SUCCESS`, `FAILED`, `PARTIAL`. | \ No newline at end of file +The response body is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `snapshots` | **Required** | Array of Objects | | + +
+ + Response body fields: snapshots + + {: .text-delta} + +`snapshots` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `data_streams` | Array of Strings | The list of data streams included in the snapshot. | +| `duration` | String | 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. | +| `duration_in_millis` | Integer | The time unit for milliseconds. | +| `end_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `end_time_in_millis` | Integer | The time unit for milliseconds. | +| `failures` | Array of Objects | The list of shard failures that occurred during the snapshot. | +| `include_global_state` | Boolean | Whether the snapshot includes the cluster state. | +| `indices` | Array of Strings | The list of indexes included in the snapshot. | +| `metadata` | Object | The custom metadata attached to a resource. | +| `pinned_timestamp` | Integer | The time unit for milliseconds. | +| `reason` | String | The reason for the snapshot creation. | +| `remote_store_index_shallow_copy` | Boolean | Whether the snapshot uses remote store index shallow copy. | +| `shards` | Object | The statistics about the shards included in the snapshot. | +| `snapshot` | String | The name of a resource or configuration element. | +| `start_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `start_time_in_millis` | Integer | The time unit for milliseconds. | +| `state` | String | The current state of the snapshot. | +| `uuid` | String | The universally unique identifier. | +| `version` | String | The version of OpenSearch when the snapshot was created. | +| `version_id` | Integer | The internal version number of OpenSearch when the snapshot was created. | + +
+
+ + Response body fields: snapshots > end_time + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`end_time` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshots > end_time + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`end_time` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshots > end_time + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`end_time` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshots > failures + + {: .text-delta} + +The list of shard failures that occurred during the snapshot. + +`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `index` | String | The name of the index containing the failed shard. | +| `node_id` | String | The unique identifier for a resource. | +| `reason` | String | The reason for the shard failure. | +| `shard_id` | String | The unique identifier for a resource. | +| `status` | String | The status of the failed shard. | + +
+
+ + Response body fields: snapshots > metadata + + {: .text-delta} + +The custom metadata attached to a resource. + +`metadata` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | + +
+
+ + Response body fields: snapshots > metadata > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshots > shards + + {: .text-delta} + +The statistics about the shards included in the snapshot. + +`shards` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `failed` | **Required** | Integer | | +| `successful` | **Required** | Integer | | +| `total` | **Required** | Integer | | +| `failures` | _Optional_ | Array of Objects | | +| `skipped` | _Optional_ | Integer | | + +
+
+ + Response body fields: snapshots > shards > failures + + {: .text-delta} + +`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `reason` | **Required** | Object | | +| `shard` | **Required** | Integer | | +| `index` | _Optional_ | String | | +| `node` | _Optional_ | String | | +| `status` | _Optional_ | String | | + +
+
+ + Response body fields: snapshots > shards > failures > reason + + {: .text-delta} + +`reason` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshots > shards > failures > reason > caused_by + + {: .text-delta} + +`caused_by` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshots > shards > failures > reason > caused_by > root_cause + + {: .text-delta} + +`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshots > shards > failures > reason > caused_by > root_cause > suppressed + + {: .text-delta} + +`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshots > shards > failures > reason > caused_by > root_cause > suppressed > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshots > shards > failures > reason > caused_by > root_cause > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshots > shards > failures > reason > caused_by > suppressed + + {: .text-delta} + +`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshots > shards > failures > reason > caused_by > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshots > shards > failures > reason > root_cause + + {: .text-delta} + +`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshots > shards > failures > reason > suppressed + + {: .text-delta} + +`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshots > shards > failures > reason > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshots > start_time + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`start_time` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+ diff --git a/_api-reference/snapshots/restore-snapshot.md b/_api-reference/snapshots/restore-snapshot.md index 6df1397cc69..c25d1c723fa 100644 --- a/_api-reference/snapshots/restore-snapshot.md +++ b/_api-reference/snapshots/restore-snapshot.md @@ -19,6 +19,5310 @@ Restores a snapshot of a cluster or specified data streams and indices. If open indexes with the same name that you want to restore already exist in the cluster, you must close, delete, or rename the indexes. See [Example request](#example-request) for information about renaming an index. See [Close index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/close-index) for information about closing an index. {: .note} + +## Endpoints +```json +POST /_snapshot/{repository}/{snapshot}/_restore +``` + + + + +## Path parameters + +The following table lists the available path parameters. + +| Parameter | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `repository` | **Required** | String | The name of the repository containing the snapshot | +| `snapshot` | **Required** | String | The name of the snapshot to restore. | + + + + +## Query parameters + +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | +| `wait_for_completion` | Boolean | -\| Whether to return a response after the restore operation has completed. When `false`, the request returns a response when the restore operation initializes. When `true`, the request returns a response when the restore operation completes. _(Default: `false`)_ | +| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ Explicit operation timeout for connection to cluster-manager node | + + + + +## Request body fields + +Determines which settings and indexes to restore when restoring a snapshot + +The request body is optional. It is a JSON object with the following fields. + +| Property | Data type | Description | Default | +| :--- | :--- | :--- | :--- | +| `ignore_index_settings` | Array of Strings | A comma-delimited list of index settings to ignore when restoring indexes from a snapshot. | N/A | +| `ignore_unavailable` | Boolean | How to handle data streams or indexes that are missing or closed. When `false`, the request returns an error for any data stream or index that is missing or closed. When `true`, the request ignores data streams and indexes in indexes that are missing or closed. | `false` | +| `include_aliases` | Boolean | How to handle index aliases from the original snapshot. When `true`, index aliases from the original snapshot are restored. When `false`, aliases along with associated indexes are not restored. | `true` | +| `include_global_state` | Boolean | Whether to restore the current cluster state. When `false`, the cluster state is not restored. When `true`, the current cluster state is restored. | `false` | +| `index_settings` | Object | The index settings to be updated. | N/A | +| `indices` | Array of Strings or String | 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`. | N/A | +| `partial` | Boolean | How the restore operation will behave if indexes in the snapshot do not have all primary shards available. When `false`, the entire restore operation fails if any indexes in the snapshot do not have all primary shards available. When `true`, allows the restoration of a partial snapshot of indexes with unavailable shards. Only shards that were successfully included in the snapshot are restored. All missing shards are recreated as empty. By default, the entire restore operation fails if one or more indexes included in the snapshot do not have all primary shards available. To change this behavior, set `partial` to `true`. | `false` | +| `rename_alias_pattern` | String | The pattern to apply to the restored aliases. Aliases matching the rename pattern will be renamed according to the `rename_alias_replacement` setting. The rename pattern is applied as defined by the regular expression that supports referencing the original text. If two or more aliases are renamed into the same name, these aliases will be merged into one. | N/A | +| `rename_alias_replacement` | String | The rename replacement string for aliases. | N/A | +| `rename_pattern` | String | The pattern to apply to the restored data streams and indexes. Data streams and indexes matching the rename pattern will be renamed according to the `rename_replacement` setting. The rename pattern is applied as defined by the regular expression that supports referencing the original text. The request fails if two or more data streams or indexes are renamed into the same name. If you rename a restored data stream, its backing indexes are also renamed. For example, if you rename the logs data stream to `recovered-logs`, the backing index `.ds-logs-1` is renamed to `.ds-recovered-logs-1`. If you rename a restored stream, ensure an index template matches the new stream name. If there are no matching index template names, the stream cannot roll over and new backing indexes are not created. | N/A | +| `rename_replacement` | String | The rename replacement string. | N/A | +| `source_remote_store_repository` | String | The name of the remote store repository of the source index being restored. If not provided, the Snapshot Restore API will use the repository that was registered when the snapshot was created. | N/A | +| `storage_type` | String | Where will be the authoritative store of the restored indexes' data. A value of `local` indicates that all snapshot metadata and index data will be downloaded to local storage. A value of `remote_snapshot` indicates that snapshot metadata will be downloaded to the cluster, but the remote repository will remain the authoritative store of the index data. Data will be downloaded and cached as necessary to service queries. At least one node in the cluster must be configured with the search role in order to restore a snapshot using the type `remote_snapshot`. | `local` | + +
+ + Request body fields: index_settings + + {: .text-delta} + +The index settings to be updated. + +`index_settings` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | +| `analysis` | Object | | +| `analyze` | Object | | +| `analyze.max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `auto_expand_replicas` | String | | +| `blocks` | Object | | +| `blocks.metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `check_on_startup` | String | Valid values are: `checksum`, `false`, and `true`. | +| `codec` | String | | +| `composite_index.star_tree` | Object | | +| `creation_date` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `creation_date_string` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `default_pipeline` | String | | +| `final_pipeline` | String | | +| `format` | Float or String | | +| `gc_deletes` | String | 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. | +| `hidden` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `highlight` | Object | | +| `highlight.max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `index` | Object | The index settings to be updated. | +| `indexing` | Object | | +| `indexing_pressure` | Object | | +| `knn` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `knn.algo_param.ef_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `lifecycle` | Object | | +| `lifecycle.name` | String | The name of a resource or configuration element. | +| `load_fixed_bitset_filters_eagerly` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `mapping` | Object | | +| `max_docvalue_fields_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_inner_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_ngram_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_refresh_listeners` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_regex_length` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_rescore_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_script_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_shingle_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_slices_per_scroll` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_terms_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `merge` | Object | | +| `merge.scheduler.max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `mode` | String | | +| `number_of_replicas` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `number_of_routing_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `number_of_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `priority` | Float or String | | +| `provided_name` | String | The name of a resource or configuration element. | +| `queries` | Object | | +| `query_string` | Object | | +| `query_string.lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `refresh_interval` | String | 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. | +| `routing` | Object | | +| `routing_partition_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `routing_path` | Array of Strings or String | | +| `search` | Object | | +| `search.idle.after` | String | 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. | +| `settings` | Object | The index settings to be updated. | +| `similarity` | Object | | +| `soft_deletes` | Object | | +| `soft_deletes.retention_lease.period` | String | 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. | +| `sort` | Object | | +| `store` | Object | | +| `top_metrics_max_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `translog` | Object | | +| `translog.durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | +| `translog.flush_threshold_size` | String | The unique identifier of a node. | +| `uuid` | String | The universally unique identifier. | +| `verified_before_close` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | Object | | + +
+
+ + Request body fields: index_settings > analysis + + {: .text-delta} + +`analysis` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `analyzer` | Object | | +| `char_filter` | Object | | +| `filter` | Object | | +| `normalizer` | Object | | +| `tokenizer` | Object | | + +
+
+ + Request body fields: index_settings > analysis > analyzer + + {: .text-delta} + +`analyzer` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `tokenizer` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `custom`. | +| `char_filter` | _Optional_ | Array of Strings | | +| `filter` | _Optional_ | Array of Strings | | +| `position_increment_gap` | _Optional_ | Integer | | +| `position_offset_gap` | _Optional_ | Integer | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `max_output_size` | **Required** | Integer | | +| `preserve_original` | **Required** | Boolean | | +| `separator` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `fingerprint`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keyword`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `language` | **Required** | String | Valid values are: `Arabic`, `Armenian`, `Basque`, `Brazilian`, `Bulgarian`, `Catalan`, `Chinese`, `Cjk`, `Czech`, `Danish`, `Dutch`, `English`, `Estonian`, `Finnish`, `French`, `Galician`, `German`, `Greek`, `Hindi`, `Hungarian`, `Indonesian`, `Irish`, `Italian`, `Latvian`, `Norwegian`, `Persian`, `Portuguese`, `Romanian`, `Russian`, `Sorani`, `Spanish`, `Swedish`, `Thai`, and `Turkish`. | +| `stem_exclusion` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `language`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `nori`. | +| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | +| `stoptags` | _Optional_ | Array of Strings | | +| `user_dictionary` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `pattern` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `pattern`. | +| `flags` | _Optional_ | String | | +| `lowercase` | _Optional_ | Boolean | | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `simple`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `standard`. | +| `max_token_length` | _Optional_ | Integer | | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stop`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `whitespace`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `method` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | +| `mode` | **Required** | String | Valid values are: `compose`, and `decompose`. | +| `type` | **Required** | String | Valid values are: `icu_analyzer`. | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | +| `type` | **Required** | String | Valid values are: `kuromoji`. | +| `user_dictionary` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | +| `type` | **Required** | String | Valid values are: `snowball`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `dutch`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `type` | String | Valid values are: `smartcn`. | + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `stopwords` | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | String | | +| `type` | String | Valid values are: `cjk`. | + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `phone-region` | String | Optional ISO 3166 country code, defaults to "ZZ" (unknown region). | +| `type` | String | Valid values are: `phone`, and `phone-search`. | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `tokenizer` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `custom`. | +| `char_filter` | _Optional_ | Array of Strings | | +| `filter` | _Optional_ | Array of Strings | | +| `position_increment_gap` | _Optional_ | Integer | | +| `position_offset_gap` | _Optional_ | Integer | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `max_output_size` | **Required** | Integer | | +| `preserve_original` | **Required** | Boolean | | +| `separator` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `fingerprint`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords + + {: .text-delta} + +Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. + +`stopwords` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keyword`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `language` | **Required** | String | Valid values are: `Arabic`, `Armenian`, `Basque`, `Brazilian`, `Bulgarian`, `Catalan`, `Chinese`, `Cjk`, `Czech`, `Danish`, `Dutch`, `English`, `Estonian`, `Finnish`, `French`, `Galician`, `German`, `Greek`, `Hindi`, `Hungarian`, `Indonesian`, `Irish`, `Italian`, `Latvian`, `Norwegian`, `Persian`, `Portuguese`, `Romanian`, `Russian`, `Sorani`, `Spanish`, `Swedish`, `Thai`, and `Turkish`. | +| `stem_exclusion` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `language`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords + + {: .text-delta} + +Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. + +`stopwords` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `nori`. | +| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | +| `stoptags` | _Optional_ | Array of Strings | | +| `user_dictionary` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `pattern` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `pattern`. | +| `flags` | _Optional_ | String | | +| `lowercase` | _Optional_ | Boolean | | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords + + {: .text-delta} + +Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. + +`stopwords` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `simple`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `standard`. | +| `max_token_length` | _Optional_ | Integer | | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords + + {: .text-delta} + +Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. + +`stopwords` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stop`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords + + {: .text-delta} + +Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. + +`stopwords` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `whitespace`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `method` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | +| `mode` | **Required** | String | Valid values are: `compose`, and `decompose`. | +| `type` | **Required** | String | Valid values are: `icu_analyzer`. | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | +| `type` | **Required** | String | Valid values are: `kuromoji`. | +| `user_dictionary` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | +| `type` | **Required** | String | Valid values are: `snowball`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords + + {: .text-delta} + +Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. + +`stopwords` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `dutch`. | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords + + {: .text-delta} + +Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. + +`stopwords` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `type` | String | Valid values are: `smartcn`. | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `stopwords` | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | String | | +| `type` | String | Valid values are: `cjk`. | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords + + {: .text-delta} + +Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. + +`stopwords` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > analyzer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `phone-region` | String | Optional ISO 3166 country code, defaults to "ZZ" (unknown region). | +| `type` | String | Valid values are: `phone`, and `phone-search`. | + +
+
+ + Request body fields: index_settings > analysis > char_filter + + {: .text-delta} + +`char_filter` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object or String | | + +
+
+ + Request body fields: index_settings > analysis > char_filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `html_strip`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `mapping`. | +| `mappings` | _Optional_ | Array of Strings | | +| `mappings_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `pattern` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `pattern_replace`. | +| `flags` | _Optional_ | String | | +| `replacement` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `icu_normalizer`. | +| `mode` | _Optional_ | String | Valid values are: `compose`, and `decompose`. | +| `name` | _Optional_ | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `normalize_kana` | **Required** | Boolean | | +| `normalize_kanji` | **Required** | Boolean | | +| `type` | **Required** | String | Valid values are: `kuromoji_iteration_mark`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > char_filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > char_filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `html_strip`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `mapping`. | +| `mappings` | _Optional_ | Array of Strings | | +| `mappings_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `pattern` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `pattern_replace`. | +| `flags` | _Optional_ | String | | +| `replacement` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `icu_normalizer`. | +| `mode` | _Optional_ | String | Valid values are: `compose`, and `decompose`. | +| `name` | _Optional_ | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `normalize_kana` | **Required** | Boolean | | +| `normalize_kanji` | **Required** | Boolean | | +| `type` | **Required** | String | Valid values are: `kuromoji_iteration_mark`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > char_filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `html_strip`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > char_filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `mapping`. | +| `mappings` | _Optional_ | Array of Strings | | +| `mappings_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > char_filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `pattern` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `pattern_replace`. | +| `flags` | _Optional_ | String | | +| `replacement` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > char_filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `icu_normalizer`. | +| `mode` | _Optional_ | String | Valid values are: `compose`, and `decompose`. | +| `name` | _Optional_ | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > char_filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `normalize_kana` | **Required** | Boolean | | +| `normalize_kanji` | **Required** | Boolean | | +| `type` | **Required** | String | Valid values are: `kuromoji_iteration_mark`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter + + {: .text-delta} + +`filter` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object or String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `asciifolding`. | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `common_grams`. | +| `common_words` | _Optional_ | Array of Strings | | +| `common_words_path` | _Optional_ | String | | +| `ignore_case` | _Optional_ | Boolean | | +| `query_mode` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `filter` | **Required** | Array of Strings | | +| `script` | **Required** | Object or Object or String | | +| `type` | **Required** | String | Valid values are: `condition`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `delimited_payload`. | +| `delimiter` | _Optional_ | String | | +| `encoding` | _Optional_ | String | Valid values are: `float`, `identity`, and `int`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `edge_ngram`. | +| `max_gram` | _Optional_ | Integer | | +| `min_gram` | _Optional_ | Integer | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `side` | _Optional_ | String | Valid values are: `back`, and `front`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `elision`. | +| `articles` | _Optional_ | Array of Strings | | +| `articles_case` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `articles_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `fingerprint`. | +| `max_output_size` | _Optional_ | Integer | | +| `separator` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `locale` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `hunspell`. | +| `dedup` | _Optional_ | Boolean | | +| `dictionary` | _Optional_ | String | | +| `longest_only` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `hyphenation_decompounder`. | +| `hyphenation_patterns_path` | _Optional_ | String | | +| `max_subword_size` | _Optional_ | Integer | | +| `min_subword_size` | _Optional_ | Integer | | +| `min_word_size` | _Optional_ | Integer | | +| `only_longest_match` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | +| `word_list` | _Optional_ | Array of Strings | | +| `word_list_path` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keep_types`. | +| `mode` | _Optional_ | String | Valid values are: `exclude`, and `include`. | +| `types` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keep`. | +| `keep_words` | _Optional_ | Array of Strings | | +| `keep_words_case` | _Optional_ | Boolean | | +| `keep_words_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keyword_marker`. | +| `ignore_case` | _Optional_ | Boolean | | +| `keywords` | _Optional_ | Array of Strings | | +| `keywords_path` | _Optional_ | String | | +| `keywords_pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `kstem`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `length`. | +| `max` | _Optional_ | Integer | | +| `min` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `limit`. | +| `consume_all_tokens` | _Optional_ | Boolean | | +| `max_token_count` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `lowercase`. | +| `language` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `filters` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `multiplexer`. | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `ngram`. | +| `max_gram` | _Optional_ | Integer | | +| `min_gram` | _Optional_ | Integer | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `nori_part_of_speech`. | +| `stoptags` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `patterns` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `pattern_capture`. | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `pattern` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `pattern_replace`. | +| `all` | _Optional_ | Boolean | | +| `flags` | _Optional_ | String | | +| `replacement` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `persian_stem`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `porter_stem`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `script` | **Required** | Object or Object or String | | +| `type` | **Required** | String | Valid values are: `predicate_token_filter`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `remove_duplicates`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `reverse`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `shingle`. | +| `filler_token` | _Optional_ | String | | +| `max_shingle_size` | _Optional_ | Float or String | | +| `min_shingle_size` | _Optional_ | Float or String | | +| `output_unigrams` | _Optional_ | Boolean | | +| `output_unigrams_if_no_shingles` | _Optional_ | Boolean | | +| `token_separator` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | +| `type` | **Required** | String | Valid values are: `snowball`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stemmer_override`. | +| `rules` | _Optional_ | Array of Strings | | +| `rules_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stemmer`. | +| `language` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stop`. | +| `ignore_case` | _Optional_ | Boolean | | +| `remove_trailing` | _Optional_ | Boolean | | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `synonym_graph`. | +| `expand` | _Optional_ | Boolean | | +| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | +| `lenient` | _Optional_ | Boolean | | +| `synonyms` | _Optional_ | Array of Strings | | +| `synonyms_path` | _Optional_ | String | | +| `tokenizer` | _Optional_ | String | | +| `updateable` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `synonym`. | +| `expand` | _Optional_ | Boolean | | +| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | +| `lenient` | _Optional_ | Boolean | | +| `synonyms` | _Optional_ | Array of Strings | | +| `synonyms_path` | _Optional_ | String | | +| `tokenizer` | _Optional_ | String | | +| `updateable` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `trim`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `truncate`. | +| `length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `unique`. | +| `only_on_same_position` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `uppercase`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `word_delimiter_graph`. | +| `adjust_offsets` | _Optional_ | Boolean | | +| `catenate_all` | _Optional_ | Boolean | | +| `catenate_numbers` | _Optional_ | Boolean | | +| `catenate_words` | _Optional_ | Boolean | | +| `generate_number_parts` | _Optional_ | Boolean | | +| `generate_word_parts` | _Optional_ | Boolean | | +| `ignore_keywords` | _Optional_ | Boolean | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `protected_words` | _Optional_ | Array of Strings | | +| `protected_words_path` | _Optional_ | String | | +| `split_on_case_change` | _Optional_ | Boolean | | +| `split_on_numerics` | _Optional_ | Boolean | | +| `stem_english_possessive` | _Optional_ | Boolean | | +| `type_table` | _Optional_ | Array of Strings | | +| `type_table_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `word_delimiter`. | +| `catenate_all` | _Optional_ | Boolean | | +| `catenate_numbers` | _Optional_ | Boolean | | +| `catenate_words` | _Optional_ | Boolean | | +| `generate_number_parts` | _Optional_ | Boolean | | +| `generate_word_parts` | _Optional_ | Boolean | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `protected_words` | _Optional_ | Array of Strings | | +| `protected_words_path` | _Optional_ | String | | +| `split_on_case_change` | _Optional_ | Boolean | | +| `split_on_numerics` | _Optional_ | Boolean | | +| `stem_english_possessive` | _Optional_ | Boolean | | +| `type_table` | _Optional_ | Array of Strings | | +| `type_table_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `minimum_length` | **Required** | Integer | | +| `type` | **Required** | String | Valid values are: `kuromoji_stemmer`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `kuromoji_readingform`. | +| `use_romaji` | **Required** | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `stoptags` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `kuromoji_part_of_speech`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `rule_files` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `icu_collation`. | +| `alternate` | _Optional_ | String | Valid values are: `non-ignorable`, and `shifted`. | +| `caseFirst` | _Optional_ | String | Valid values are: `lower`, and `upper`. | +| `caseLevel` | _Optional_ | Boolean | | +| `country` | _Optional_ | String | | +| `decomposition` | _Optional_ | String | Valid values are: `canonical`, and `no`. | +| `hiraganaQuaternaryMode` | _Optional_ | Boolean | | +| `language` | _Optional_ | String | | +| `numeric` | _Optional_ | Boolean | | +| `rules` | _Optional_ | String | | +| `strength` | _Optional_ | String | Valid values are: `identical`, `primary`, `quaternary`, `secondary`, and `tertiary`. | +| `variableTop` | _Optional_ | String | | +| `variant` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `icu_folding`. | +| `unicode_set_filter` | **Required** | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `name` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | +| `type` | **Required** | String | Valid values are: `icu_normalizer`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `id` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `icu_transform`. | +| `dir` | _Optional_ | String | Valid values are: `forward`, and `reverse`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `encoder` | **Required** | String | Valid values are: `beider_morse`, `caverphone1`, `caverphone2`, `cologne`, `daitch_mokotoff`, `double_metaphone`, `haasephonetik`, `koelnerphonetik`, `metaphone`, `nysiis`, `refined_soundex`, and `soundex`. | +| `languageset` | **Required** | Array of Strings | | +| `name_type` | **Required** | String | Valid values are: `ashkenazi`, `generic`, and `sephardic`. | +| `rule_type` | **Required** | String | Valid values are: `approx`, and `exact`. | +| `type` | **Required** | String | Valid values are: `phonetic`. | +| `max_code_len` | _Optional_ | Integer | | +| `replace` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `dictionary_decompounder`. | +| `hyphenation_patterns_path` | _Optional_ | String | | +| `max_subword_size` | _Optional_ | Integer | | +| `min_subword_size` | _Optional_ | Integer | | +| `min_word_size` | _Optional_ | Integer | | +| `only_longest_match` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | +| `word_list` | _Optional_ | Array of Strings | | +| `word_list_path` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `smartcn_stop`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `asciifolding`. | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `common_grams`. | +| `common_words` | _Optional_ | Array of Strings | | +| `common_words_path` | _Optional_ | String | | +| `ignore_case` | _Optional_ | Boolean | | +| `query_mode` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `filter` | **Required** | Array of Strings | | +| `script` | **Required** | Object or Object or String | | +| `type` | **Required** | String | Valid values are: `condition`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `delimited_payload`. | +| `delimiter` | _Optional_ | String | | +| `encoding` | _Optional_ | String | Valid values are: `float`, `identity`, and `int`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `edge_ngram`. | +| `max_gram` | _Optional_ | Integer | | +| `min_gram` | _Optional_ | Integer | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `side` | _Optional_ | String | Valid values are: `back`, and `front`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `elision`. | +| `articles` | _Optional_ | Array of Strings | | +| `articles_case` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `articles_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `fingerprint`. | +| `max_output_size` | _Optional_ | Integer | | +| `separator` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `locale` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `hunspell`. | +| `dedup` | _Optional_ | Boolean | | +| `dictionary` | _Optional_ | String | | +| `longest_only` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `hyphenation_decompounder`. | +| `hyphenation_patterns_path` | _Optional_ | String | | +| `max_subword_size` | _Optional_ | Integer | | +| `min_subword_size` | _Optional_ | Integer | | +| `min_word_size` | _Optional_ | Integer | | +| `only_longest_match` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | +| `word_list` | _Optional_ | Array of Strings | | +| `word_list_path` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keep_types`. | +| `mode` | _Optional_ | String | Valid values are: `exclude`, and `include`. | +| `types` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keep`. | +| `keep_words` | _Optional_ | Array of Strings | | +| `keep_words_case` | _Optional_ | Boolean | | +| `keep_words_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keyword_marker`. | +| `ignore_case` | _Optional_ | Boolean | | +| `keywords` | _Optional_ | Array of Strings | | +| `keywords_path` | _Optional_ | String | | +| `keywords_pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `kstem`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `length`. | +| `max` | _Optional_ | Integer | | +| `min` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `limit`. | +| `consume_all_tokens` | _Optional_ | Boolean | | +| `max_token_count` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `lowercase`. | +| `language` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `filters` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `multiplexer`. | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `ngram`. | +| `max_gram` | _Optional_ | Integer | | +| `min_gram` | _Optional_ | Integer | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `nori_part_of_speech`. | +| `stoptags` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `patterns` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `pattern_capture`. | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `pattern` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `pattern_replace`. | +| `all` | _Optional_ | Boolean | | +| `flags` | _Optional_ | String | | +| `replacement` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `persian_stem`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `porter_stem`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `script` | **Required** | Object or Object or String | | +| `type` | **Required** | String | Valid values are: `predicate_token_filter`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `remove_duplicates`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `reverse`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `shingle`. | +| `filler_token` | _Optional_ | String | | +| `max_shingle_size` | _Optional_ | Float or String | | +| `min_shingle_size` | _Optional_ | Float or String | | +| `output_unigrams` | _Optional_ | Boolean | | +| `output_unigrams_if_no_shingles` | _Optional_ | Boolean | | +| `token_separator` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | +| `type` | **Required** | String | Valid values are: `snowball`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stemmer_override`. | +| `rules` | _Optional_ | Array of Strings | | +| `rules_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stemmer`. | +| `language` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stop`. | +| `ignore_case` | _Optional_ | Boolean | | +| `remove_trailing` | _Optional_ | Boolean | | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `synonym_graph`. | +| `expand` | _Optional_ | Boolean | | +| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | +| `lenient` | _Optional_ | Boolean | | +| `synonyms` | _Optional_ | Array of Strings | | +| `synonyms_path` | _Optional_ | String | | +| `tokenizer` | _Optional_ | String | | +| `updateable` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `synonym`. | +| `expand` | _Optional_ | Boolean | | +| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | +| `lenient` | _Optional_ | Boolean | | +| `synonyms` | _Optional_ | Array of Strings | | +| `synonyms_path` | _Optional_ | String | | +| `tokenizer` | _Optional_ | String | | +| `updateable` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `trim`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `truncate`. | +| `length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `unique`. | +| `only_on_same_position` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `uppercase`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `word_delimiter_graph`. | +| `adjust_offsets` | _Optional_ | Boolean | | +| `catenate_all` | _Optional_ | Boolean | | +| `catenate_numbers` | _Optional_ | Boolean | | +| `catenate_words` | _Optional_ | Boolean | | +| `generate_number_parts` | _Optional_ | Boolean | | +| `generate_word_parts` | _Optional_ | Boolean | | +| `ignore_keywords` | _Optional_ | Boolean | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `protected_words` | _Optional_ | Array of Strings | | +| `protected_words_path` | _Optional_ | String | | +| `split_on_case_change` | _Optional_ | Boolean | | +| `split_on_numerics` | _Optional_ | Boolean | | +| `stem_english_possessive` | _Optional_ | Boolean | | +| `type_table` | _Optional_ | Array of Strings | | +| `type_table_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `word_delimiter`. | +| `catenate_all` | _Optional_ | Boolean | | +| `catenate_numbers` | _Optional_ | Boolean | | +| `catenate_words` | _Optional_ | Boolean | | +| `generate_number_parts` | _Optional_ | Boolean | | +| `generate_word_parts` | _Optional_ | Boolean | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `protected_words` | _Optional_ | Array of Strings | | +| `protected_words_path` | _Optional_ | String | | +| `split_on_case_change` | _Optional_ | Boolean | | +| `split_on_numerics` | _Optional_ | Boolean | | +| `stem_english_possessive` | _Optional_ | Boolean | | +| `type_table` | _Optional_ | Array of Strings | | +| `type_table_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `minimum_length` | **Required** | Integer | | +| `type` | **Required** | String | Valid values are: `kuromoji_stemmer`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `kuromoji_readingform`. | +| `use_romaji` | **Required** | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `stoptags` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `kuromoji_part_of_speech`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `rule_files` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `icu_collation`. | +| `alternate` | _Optional_ | String | Valid values are: `non-ignorable`, and `shifted`. | +| `caseFirst` | _Optional_ | String | Valid values are: `lower`, and `upper`. | +| `caseLevel` | _Optional_ | Boolean | | +| `country` | _Optional_ | String | | +| `decomposition` | _Optional_ | String | Valid values are: `canonical`, and `no`. | +| `hiraganaQuaternaryMode` | _Optional_ | Boolean | | +| `language` | _Optional_ | String | | +| `numeric` | _Optional_ | Boolean | | +| `rules` | _Optional_ | String | | +| `strength` | _Optional_ | String | Valid values are: `identical`, `primary`, `quaternary`, `secondary`, and `tertiary`. | +| `variableTop` | _Optional_ | String | | +| `variant` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `icu_folding`. | +| `unicode_set_filter` | **Required** | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `name` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | +| `type` | **Required** | String | Valid values are: `icu_normalizer`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `id` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `icu_transform`. | +| `dir` | _Optional_ | String | Valid values are: `forward`, and `reverse`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `encoder` | **Required** | String | Valid values are: `beider_morse`, `caverphone1`, `caverphone2`, `cologne`, `daitch_mokotoff`, `double_metaphone`, `haasephonetik`, `koelnerphonetik`, `metaphone`, `nysiis`, `refined_soundex`, and `soundex`. | +| `languageset` | **Required** | Array of Strings | | +| `name_type` | **Required** | String | Valid values are: `ashkenazi`, `generic`, and `sephardic`. | +| `rule_type` | **Required** | String | Valid values are: `approx`, and `exact`. | +| `type` | **Required** | String | Valid values are: `phonetic`. | +| `max_code_len` | _Optional_ | Integer | | +| `replace` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `dictionary_decompounder`. | +| `hyphenation_patterns_path` | _Optional_ | String | | +| `max_subword_size` | _Optional_ | Integer | | +| `min_subword_size` | _Optional_ | Integer | | +| `min_word_size` | _Optional_ | Integer | | +| `only_longest_match` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | +| `word_list` | _Optional_ | Array of Strings | | +| `word_list_path` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `smartcn_stop`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `asciifolding`. | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `common_grams`. | +| `common_words` | _Optional_ | Array of Strings | | +| `common_words_path` | _Optional_ | String | | +| `ignore_case` | _Optional_ | Boolean | | +| `query_mode` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `filter` | **Required** | Array of Strings | | +| `script` | **Required** | Object or Object or String | | +| `type` | **Required** | String | Valid values are: `condition`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script + + {: .text-delta} + +`script` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `source` | **Required** | String | The script source. | +| `lang` | _Optional_ | String | | +| `options` | _Optional_ | Object | | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `id` | **Required** | String | The unique identifier for a resource. | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script + + {: .text-delta} + +`script` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `source` | **Required** | String | The script source. | +| `lang` | _Optional_ | String | | +| `options` | _Optional_ | Object | | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script + + {: .text-delta} + +`script` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script + + {: .text-delta} + +`script` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `source` | **Required** | String | The script source. | +| `lang` | _Optional_ | String | | +| `options` | _Optional_ | Object | | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script > options + + {: .text-delta} + +`options` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script > params + + {: .text-delta} + +Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. + +`params` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script > params > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script + + {: .text-delta} + +`script` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `id` | **Required** | String | The unique identifier for a resource. | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `delimited_payload`. | +| `delimiter` | _Optional_ | String | | +| `encoding` | _Optional_ | String | Valid values are: `float`, `identity`, and `int`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `edge_ngram`. | +| `max_gram` | _Optional_ | Integer | | +| `min_gram` | _Optional_ | Integer | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `side` | _Optional_ | String | Valid values are: `back`, and `front`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `elision`. | +| `articles` | _Optional_ | Array of Strings | | +| `articles_case` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `articles_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `fingerprint`. | +| `max_output_size` | _Optional_ | Integer | | +| `separator` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `locale` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `hunspell`. | +| `dedup` | _Optional_ | Boolean | | +| `dictionary` | _Optional_ | String | | +| `longest_only` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `hyphenation_decompounder`. | +| `hyphenation_patterns_path` | _Optional_ | String | | +| `max_subword_size` | _Optional_ | Integer | | +| `min_subword_size` | _Optional_ | Integer | | +| `min_word_size` | _Optional_ | Integer | | +| `only_longest_match` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | +| `word_list` | _Optional_ | Array of Strings | | +| `word_list_path` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keep_types`. | +| `mode` | _Optional_ | String | Valid values are: `exclude`, and `include`. | +| `types` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keep`. | +| `keep_words` | _Optional_ | Array of Strings | | +| `keep_words_case` | _Optional_ | Boolean | | +| `keep_words_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `keyword_marker`. | +| `ignore_case` | _Optional_ | Boolean | | +| `keywords` | _Optional_ | Array of Strings | | +| `keywords_path` | _Optional_ | String | | +| `keywords_pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `kstem`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `length`. | +| `max` | _Optional_ | Integer | | +| `min` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `limit`. | +| `consume_all_tokens` | _Optional_ | Boolean | | +| `max_token_count` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `lowercase`. | +| `language` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `filters` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `multiplexer`. | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `ngram`. | +| `max_gram` | _Optional_ | Integer | | +| `min_gram` | _Optional_ | Integer | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `nori_part_of_speech`. | +| `stoptags` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `patterns` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `pattern_capture`. | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `pattern` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `pattern_replace`. | +| `all` | _Optional_ | Boolean | | +| `flags` | _Optional_ | String | | +| `replacement` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `persian_stem`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `porter_stem`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `script` | **Required** | Object or Object or String | | +| `type` | **Required** | String | Valid values are: `predicate_token_filter`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script + + {: .text-delta} + +`script` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `source` | **Required** | String | The script source. | +| `lang` | _Optional_ | String | | +| `options` | _Optional_ | Object | | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `id` | **Required** | String | The unique identifier for a resource. | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > script + + {: .text-delta} + +`script` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `id` | **Required** | String | The unique identifier for a resource. | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `remove_duplicates`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `reverse`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `shingle`. | +| `filler_token` | _Optional_ | String | | +| `max_shingle_size` | _Optional_ | Float or String | | +| `min_shingle_size` | _Optional_ | Float or String | | +| `output_unigrams` | _Optional_ | Boolean | | +| `output_unigrams_if_no_shingles` | _Optional_ | Boolean | | +| `token_separator` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | +| `type` | **Required** | String | Valid values are: `snowball`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stemmer_override`. | +| `rules` | _Optional_ | Array of Strings | | +| `rules_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stemmer`. | +| `language` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `stop`. | +| `ignore_case` | _Optional_ | Boolean | | +| `remove_trailing` | _Optional_ | Boolean | | +| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | +| `stopwords_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- > stopwords + + {: .text-delta} + +Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. + +`stopwords` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `synonym_graph`. | +| `expand` | _Optional_ | Boolean | | +| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | +| `lenient` | _Optional_ | Boolean | | +| `synonyms` | _Optional_ | Array of Strings | | +| `synonyms_path` | _Optional_ | String | | +| `tokenizer` | _Optional_ | String | | +| `updateable` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `synonym`. | +| `expand` | _Optional_ | Boolean | | +| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | +| `lenient` | _Optional_ | Boolean | | +| `synonyms` | _Optional_ | Array of Strings | | +| `synonyms_path` | _Optional_ | String | | +| `tokenizer` | _Optional_ | String | | +| `updateable` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `trim`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `truncate`. | +| `length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `unique`. | +| `only_on_same_position` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `uppercase`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `word_delimiter_graph`. | +| `adjust_offsets` | _Optional_ | Boolean | | +| `catenate_all` | _Optional_ | Boolean | | +| `catenate_numbers` | _Optional_ | Boolean | | +| `catenate_words` | _Optional_ | Boolean | | +| `generate_number_parts` | _Optional_ | Boolean | | +| `generate_word_parts` | _Optional_ | Boolean | | +| `ignore_keywords` | _Optional_ | Boolean | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `protected_words` | _Optional_ | Array of Strings | | +| `protected_words_path` | _Optional_ | String | | +| `split_on_case_change` | _Optional_ | Boolean | | +| `split_on_numerics` | _Optional_ | Boolean | | +| `stem_english_possessive` | _Optional_ | Boolean | | +| `type_table` | _Optional_ | Array of Strings | | +| `type_table_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `word_delimiter`. | +| `catenate_all` | _Optional_ | Boolean | | +| `catenate_numbers` | _Optional_ | Boolean | | +| `catenate_words` | _Optional_ | Boolean | | +| `generate_number_parts` | _Optional_ | Boolean | | +| `generate_word_parts` | _Optional_ | Boolean | | +| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `protected_words` | _Optional_ | Array of Strings | | +| `protected_words_path` | _Optional_ | String | | +| `split_on_case_change` | _Optional_ | Boolean | | +| `split_on_numerics` | _Optional_ | Boolean | | +| `stem_english_possessive` | _Optional_ | Boolean | | +| `type_table` | _Optional_ | Array of Strings | | +| `type_table_path` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `minimum_length` | **Required** | Integer | | +| `type` | **Required** | String | Valid values are: `kuromoji_stemmer`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `kuromoji_readingform`. | +| `use_romaji` | **Required** | Boolean | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `stoptags` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `kuromoji_part_of_speech`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `rule_files` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `icu_collation`. | +| `alternate` | _Optional_ | String | Valid values are: `non-ignorable`, and `shifted`. | +| `caseFirst` | _Optional_ | String | Valid values are: `lower`, and `upper`. | +| `caseLevel` | _Optional_ | Boolean | | +| `country` | _Optional_ | String | | +| `decomposition` | _Optional_ | String | Valid values are: `canonical`, and `no`. | +| `hiraganaQuaternaryMode` | _Optional_ | Boolean | | +| `language` | _Optional_ | String | | +| `numeric` | _Optional_ | Boolean | | +| `rules` | _Optional_ | String | | +| `strength` | _Optional_ | String | Valid values are: `identical`, `primary`, `quaternary`, `secondary`, and `tertiary`. | +| `variableTop` | _Optional_ | String | | +| `variant` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `icu_folding`. | +| `unicode_set_filter` | **Required** | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `name` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | +| `type` | **Required** | String | Valid values are: `icu_normalizer`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `id` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `icu_transform`. | +| `dir` | _Optional_ | String | Valid values are: `forward`, and `reverse`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `encoder` | **Required** | String | Valid values are: `beider_morse`, `caverphone1`, `caverphone2`, `cologne`, `daitch_mokotoff`, `double_metaphone`, `haasephonetik`, `koelnerphonetik`, `metaphone`, `nysiis`, `refined_soundex`, and `soundex`. | +| `languageset` | **Required** | Array of Strings | | +| `name_type` | **Required** | String | Valid values are: `ashkenazi`, `generic`, and `sephardic`. | +| `rule_type` | **Required** | String | Valid values are: `approx`, and `exact`. | +| `type` | **Required** | String | Valid values are: `phonetic`. | +| `max_code_len` | _Optional_ | Integer | | +| `replace` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `dictionary_decompounder`. | +| `hyphenation_patterns_path` | _Optional_ | String | | +| `max_subword_size` | _Optional_ | Integer | | +| `min_subword_size` | _Optional_ | Integer | | +| `min_word_size` | _Optional_ | Integer | | +| `only_longest_match` | _Optional_ | Boolean | | +| `version` | _Optional_ | String | | +| `word_list` | _Optional_ | Array of Strings | | +| `word_list_path` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > filter > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `smartcn_stop`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > normalizer + + {: .text-delta} + +`normalizer` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | + +
+
+ + Request body fields: index_settings > analysis > normalizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `lowercase`. | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `custom`. | +| `char_filter` | _Optional_ | Array of Strings | | +| `filter` | _Optional_ | Array of Strings | | + +
+
+ + Request body fields: index_settings > analysis > normalizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `lowercase`. | + +
+
+ + Request body fields: index_settings > analysis > normalizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `custom`. | +| `char_filter` | _Optional_ | Array of Strings | | +| `filter` | _Optional_ | Array of Strings | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer + + {: .text-delta} + +`tokenizer` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object or String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `tokenize_on_chars` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `char_group`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `max_gram` | **Required** | Integer | | +| `min_gram` | **Required** | Integer | | +| `token_chars` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `edge_ngram`. | +| `custom_token_chars` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `buffer_size` | **Required** | Integer | | +| `type` | **Required** | String | Valid values are: `keyword`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `letter`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `lowercase`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `max_gram` | **Required** | Integer | | +| `min_gram` | **Required** | Integer | | +| `token_chars` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `ngram`. | +| `custom_token_chars` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `nori_tokenizer`. | +| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | +| `discard_punctuation` | _Optional_ | Boolean | | +| `user_dictionary` | _Optional_ | String | | +| `user_dictionary_rules` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `buffer_size` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `delimiter` | **Required** | String | | +| `reverse` | **Required** | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `skip` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `type` | **Required** | String | Valid values are: `path_hierarchy`. | +| `replacement` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `standard`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `uax_url_email`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `whitespace`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | +| `type` | **Required** | String | Valid values are: `kuromoji_tokenizer`. | +| `discard_compound_token` | _Optional_ | Boolean | | +| `discard_punctuation` | _Optional_ | Boolean | | +| `nbest_cost` | _Optional_ | Integer | | +| `nbest_examples` | _Optional_ | String | | +| `user_dictionary` | _Optional_ | String | | +| `user_dictionary_rules` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `pattern`. | +| `flags` | _Optional_ | String | | +| `group` | _Optional_ | Integer | | +| `pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `simple_pattern`. | +| `pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `simple_pattern_split`. | +| `pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `rule_files` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `smartcn_tokenizer`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `tokenize_on_chars` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `char_group`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `max_gram` | **Required** | Integer | | +| `min_gram` | **Required** | Integer | | +| `token_chars` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `edge_ngram`. | +| `custom_token_chars` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `buffer_size` | **Required** | Integer | | +| `type` | **Required** | String | Valid values are: `keyword`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `letter`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `lowercase`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `max_gram` | **Required** | Integer | | +| `min_gram` | **Required** | Integer | | +| `token_chars` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `ngram`. | +| `custom_token_chars` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `nori_tokenizer`. | +| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | +| `discard_punctuation` | _Optional_ | Boolean | | +| `user_dictionary` | _Optional_ | String | | +| `user_dictionary_rules` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `buffer_size` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `delimiter` | **Required** | String | | +| `reverse` | **Required** | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `skip` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `type` | **Required** | String | Valid values are: `path_hierarchy`. | +| `replacement` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `standard`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `uax_url_email`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `whitespace`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | +| `type` | **Required** | String | Valid values are: `kuromoji_tokenizer`. | +| `discard_compound_token` | _Optional_ | Boolean | | +| `discard_punctuation` | _Optional_ | Boolean | | +| `nbest_cost` | _Optional_ | Integer | | +| `nbest_examples` | _Optional_ | String | | +| `user_dictionary` | _Optional_ | String | | +| `user_dictionary_rules` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `pattern`. | +| `flags` | _Optional_ | String | | +| `group` | _Optional_ | Integer | | +| `pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `simple_pattern`. | +| `pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `simple_pattern_split`. | +| `pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `rule_files` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | +| `version` | _Optional_ | String | | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `smartcn_tokenizer`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `tokenize_on_chars` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `char_group`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `max_gram` | **Required** | Integer | | +| `min_gram` | **Required** | Integer | | +| `token_chars` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `edge_ngram`. | +| `custom_token_chars` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `buffer_size` | **Required** | Integer | | +| `type` | **Required** | String | Valid values are: `keyword`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `letter`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `lowercase`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `max_gram` | **Required** | Integer | | +| `min_gram` | **Required** | Integer | | +| `token_chars` | **Required** | Array of Strings | | +| `type` | **Required** | String | Valid values are: `ngram`. | +| `custom_token_chars` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `nori_tokenizer`. | +| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | +| `discard_punctuation` | _Optional_ | Boolean | | +| `user_dictionary` | _Optional_ | String | | +| `user_dictionary_rules` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `buffer_size` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `delimiter` | **Required** | String | | +| `reverse` | **Required** | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `skip` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `type` | **Required** | String | Valid values are: `path_hierarchy`. | +| `replacement` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `standard`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `uax_url_email`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `whitespace`. | +| `max_token_length` | _Optional_ | Integer | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | +| `type` | **Required** | String | Valid values are: `kuromoji_tokenizer`. | +| `discard_compound_token` | _Optional_ | Boolean | | +| `discard_punctuation` | _Optional_ | Boolean | | +| `nbest_cost` | _Optional_ | Integer | | +| `nbest_examples` | _Optional_ | String | | +| `user_dictionary` | _Optional_ | String | | +| `user_dictionary_rules` | _Optional_ | Array of Strings | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `pattern`. | +| `flags` | _Optional_ | String | | +| `group` | _Optional_ | Integer | | +| `pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `simple_pattern`. | +| `pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `simple_pattern_split`. | +| `pattern` | _Optional_ | String | | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `rule_files` | **Required** | String | | +| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analysis > tokenizer > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | Valid values are: `smartcn_tokenizer`. | +| `version` | _Optional_ | String | | + +
+
+ + Request body fields: index_settings > analyze + + {: .text-delta} + +`analyze` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > blocks + + {: .text-delta} + +`blocks` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > composite_index.star_tree + + {: .text-delta} + +`composite_index.star_tree` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `default` | Object | | +| `field` | Object | | +| `max_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > composite_index.star_tree > default + + {: .text-delta} + +`default` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `max_leaf_docs` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > composite_index.star_tree > field + + {: .text-delta} + +`field` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `default` | Object | | +| `max_base_metrics` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_date_intervals` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_dimensions` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > composite_index.star_tree > field > default + + {: .text-delta} + +`default` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `date_intervals` | Array of Strings | | +| `metrics` | Array of Strings | | + +
+
+ + Request body fields: index_settings > creation_date_string + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`creation_date_string` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > creation_date_string + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`creation_date_string` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > creation_date_string + + {: .text-delta} + +A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. + +`creation_date_string` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > highlight + + {: .text-delta} + +`highlight` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > index + + {: .text-delta} + +The index settings to be updated. + +`index` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | +| `analysis` | Object | | +| `analyze` | Object | | +| `analyze.max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `auto_expand_replicas` | String | | +| `blocks` | Object | | +| `blocks.metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `check_on_startup` | String | Valid values are: `checksum`, `false`, and `true`. | +| `codec` | String | | +| `composite_index.star_tree` | Object | | +| `creation_date` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `creation_date_string` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `default_pipeline` | String | | +| `final_pipeline` | String | | +| `format` | Float or String | | +| `gc_deletes` | String | 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. | +| `hidden` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `highlight` | Object | | +| `highlight.max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `index` | Object | The index settings to be updated. | +| `indexing` | Object | | +| `indexing_pressure` | Object | | +| `knn` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `knn.algo_param.ef_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `lifecycle` | Object | | +| `lifecycle.name` | String | The name of a resource or configuration element. | +| `load_fixed_bitset_filters_eagerly` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `mapping` | Object | | +| `max_docvalue_fields_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_inner_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_ngram_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_refresh_listeners` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_regex_length` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_rescore_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_script_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_shingle_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_slices_per_scroll` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_terms_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `merge` | Object | | +| `merge.scheduler.max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `mode` | String | | +| `number_of_replicas` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `number_of_routing_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `number_of_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `priority` | Float or String | | +| `provided_name` | String | The name of a resource or configuration element. | +| `queries` | Object | | +| `query_string` | Object | | +| `query_string.lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `refresh_interval` | String | 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. | +| `routing` | Object | | +| `routing_partition_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `routing_path` | Array of Strings or String | | +| `search` | Object | | +| `search.idle.after` | String | 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. | +| `settings` | Object | The index settings to be updated. | +| `similarity` | Object | | +| `soft_deletes` | Object | | +| `soft_deletes.retention_lease.period` | String | 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. | +| `sort` | Object | | +| `store` | Object | | +| `top_metrics_max_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `translog` | Object | | +| `translog.durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | +| `translog.flush_threshold_size` | String | The unique identifier of a node. | +| `uuid` | String | The universally unique identifier. | +| `verified_before_close` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | Object | | + +
+
+ + Request body fields: index_settings > index > indexing + + {: .text-delta} + +`indexing` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `slowlog` | Object | | + +
+
+ + Request body fields: index_settings > index > indexing > slowlog + + {: .text-delta} + +`slowlog` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `level` | String | | +| `reformat` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `source` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `threshold` | Object | | + +
+
+ + Request body fields: index_settings > index > indexing > slowlog > threshold + + {: .text-delta} + +`threshold` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `index` | Object | | + +
+
+ + Request body fields: index_settings > index > indexing > slowlog > threshold > index + + {: .text-delta} + +`index` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `debug` | String | 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. | +| `info` | String | 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. | +| `trace` | String | 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. | +| `warn` | String | 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. | + +
+
+ + Request body fields: index_settings > index > indexing_pressure + + {: .text-delta} + +`indexing_pressure` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `memory` | **Required** | Object | | + +
+
+ + Request body fields: index_settings > index > indexing_pressure > memory + + {: .text-delta} + +`memory` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `limit` | Integer or String | Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, the node will reject new replica operations. Defaults to 10% of the heap. | + +
+
+ + Request body fields: index_settings > index > lifecycle + + {: .text-delta} + +`lifecycle` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `name` | **Required** | String | The name of a resource or configuration element. | +| `indexing_complete` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `origination_date` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `parse_origination_date` | _Optional_ | Boolean | Set to `true` to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern `^.*-{date_format}-\\d+`, where the `date_format` is `yyyy.MM.dd` and the trailing digits are optional. An index that was rolled over would normally match the full format, for example `logs-2016.10.31-000002`). If the index name doesn't match the pattern, index creation fails. | +| `rollover_alias` | _Optional_ | String | The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indexes, see Rollover. | +| `step` | _Optional_ | Object | | + +
+
+ + Request body fields: index_settings > index > lifecycle > step + + {: .text-delta} + +`step` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `wait_time_threshold` | String | 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. | + +
+
+ + Request body fields: index_settings > index > mapping + + {: .text-delta} + +`mapping` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `coerce` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `depth` | Object | | +| `dimension_fields` | Object | | +| `field_name_length` | Object | | +| `ignore_malformed` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `nested_fields` | Object | | +| `nested_objects` | Object | | +| `total_fields` | Object | | + +
+
+ + Request body fields: index_settings > index > mapping > depth + + {: .text-delta} + +`depth` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `limit` | Integer or String | The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined at the root object level, then the depth is `1`. If there is one object mapping, then the depth is `2`. | + +
+
+ + Request body fields: index_settings > index > mapping > dimension_fields + + {: .text-delta} + +`dimension_fields` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `limit` | Integer or String | [preview] This functionality is in technical preview and may be changed or removed in a future release. OpenSearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. | + +
+
+ + Request body fields: index_settings > index > mapping > field_name_length + + {: .text-delta} + +`field_name_length` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `limit` | Integer or String | Setting for the maximum length of a field name. This setting isn't really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn't be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). | + +
+
+ + Request body fields: index_settings > index > mapping > nested_fields + + {: .text-delta} + +`nested_fields` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `limit` | Integer or String | The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting limits the number of unique nested types per index. | + +
+
+ + Request body fields: index_settings > index > mapping > nested_objects + + {: .text-delta} + +`nested_objects` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `limit` | Integer or String | The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. | + +
+
+ + Request body fields: index_settings > index > mapping > total_fields + + {: .text-delta} + +`total_fields` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `limit` | Integer or String | The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources. | + +
+
+ + Request body fields: index_settings > index > merge + + {: .text-delta} + +`merge` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `log_byte_size_policy` | Object | | +| `policy` | Object or String | Valid values are: `default`, `log_byte_size`, and `tiered`. | +| `policy.deletes_pct_allowed` | Float or String | | +| `policy.expunge_deletes_allowed` | Float or String | | +| `policy.floor_segment` | String | The unique identifier of a node. | +| `policy.max_merge_at_once` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `policy.max_merged_segment` | String | The unique identifier of a node. | +| `policy.reclaim_deletes_weight` | Float or String | | +| `policy.segments_per_tier` | Float or String | | +| `scheduler` | Object | | + +
+
+ + Request body fields: index_settings > index > merge > log_byte_size_policy + + {: .text-delta} + +`log_byte_size_policy` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `max_merge_segment` | String | The unique identifier of a node. | +| `max_merge_segment_forced_merge` | String | The unique identifier of a node. | +| `max_merged_docs` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `merge_factor` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `min_merge` | String | The unique identifier of a node. | +| `no_cfs_ratio` | Float or String | | + +
+
+ + Request body fields: index_settings > index > merge > policy + + {: .text-delta} + +`policy` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `deletes_pct_allowed` | Float or String | | +| `expunge_deletes_allowed` | Float or String | | +| `floor_segment` | String | The unique identifier of a node. | +| `max_merge_at_once` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_merge_at_once_explicit` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_merged_segment` | String | The unique identifier of a node. | +| `reclaim_deletes_weight` | Float or String | | +| `segments_per_tier` | Float or String | | + +
+
+ + Request body fields: index_settings > index > merge > policy + + {: .text-delta} + +`policy` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > index > merge > policy + + {: .text-delta} + +`policy` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `deletes_pct_allowed` | Float or String | | +| `expunge_deletes_allowed` | Float or String | | +| `floor_segment` | String | The unique identifier of a node. | +| `max_merge_at_once` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_merge_at_once_explicit` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_merged_segment` | String | The unique identifier of a node. | +| `reclaim_deletes_weight` | Float or String | | +| `segments_per_tier` | Float or String | | + +
+
+ + Request body fields: index_settings > index > merge > scheduler + + {: .text-delta} + +`scheduler` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `auto_throttle` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_merge_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > index > queries + + {: .text-delta} + +`queries` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `cache` | Object | | + +
+
+ + Request body fields: index_settings > index > queries > cache + + {: .text-delta} + +`cache` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `enabled` | **Required** | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > index > query_string + + {: .text-delta} + +`query_string` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > index > routing + + {: .text-delta} + +`routing` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `allocation` | Object | | +| `rebalance` | Object | | + +
+
+ + Request body fields: index_settings > index > routing > allocation + + {: .text-delta} + +`allocation` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `disk` | Object | | +| `enable` | String | Valid values are: `all`, `new_primaries`, `none`, and `primaries`. | +| `include` | Object | | +| `initial_recovery` | Object | | +| `total_primary_shards_per_node` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `total_shards_per_node` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > index > routing > allocation > disk + + {: .text-delta} + +`disk` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `threshold_enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > index > routing > allocation > include + + {: .text-delta} + +`include` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `_id` | String | The unique identifier for a resource. | +| `_tier_preference` | String | | + +
+
+ + Request body fields: index_settings > index > routing > allocation > initial_recovery + + {: .text-delta} + +`initial_recovery` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `_id` | String | The unique identifier for a resource. | + +
+
+ + Request body fields: index_settings > index > routing > rebalance + + {: .text-delta} + +`rebalance` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `enable` | **Required** | String | Valid values are: `all`, `none`, `primaries`, and `replicas`. | + +
+
+ + Request body fields: index_settings > index > search + + {: .text-delta} + +`search` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `concurrent` | Object | | +| `concurrent_segment_search` | Object | | +| `default_pipeline` | String | | +| `idle` | Object | | +| `slowlog` | Object | | +| `throttled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > index > search > concurrent + + {: .text-delta} + +`concurrent` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `max_slice_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > index > search > concurrent_segment_search + + {: .text-delta} + +`concurrent_segment_search` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `mode` | String | | + +
+
+ + Request body fields: index_settings > index > search > idle + + {: .text-delta} + +`idle` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `after` | String | 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. | + +
+
+ + Request body fields: index_settings > index > search > slowlog + + {: .text-delta} + +`slowlog` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `level` | String | | +| `reformat` | Boolean | | +| `threshold` | Object | | + +
+
+ + Request body fields: index_settings > index > search > slowlog > threshold + + {: .text-delta} + +`threshold` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `fetch` | Object | | +| `query` | Object | | + +
+
+ + Request body fields: index_settings > index > search > slowlog > threshold > fetch + + {: .text-delta} + +`fetch` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `debug` | String | 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. | +| `info` | String | 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. | +| `trace` | String | 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. | +| `warn` | String | 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. | + +
+
+ + Request body fields: index_settings > index > search > slowlog > threshold > query + + {: .text-delta} + +`query` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `debug` | String | 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. | +| `info` | String | 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. | +| `trace` | String | 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. | +| `warn` | String | 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. | + +
+
+ + Request body fields: index_settings > index > settings + + {: .text-delta} + +The index settings to be updated. + +`settings` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | +| `analysis` | Object | | +| `analyze` | Object | | +| `analyze.max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `auto_expand_replicas` | String | | +| `blocks` | Object | | +| `blocks.metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `check_on_startup` | String | Valid values are: `checksum`, `false`, and `true`. | +| `codec` | String | | +| `composite_index.star_tree` | Object | | +| `creation_date` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `creation_date_string` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `default_pipeline` | String | | +| `final_pipeline` | String | | +| `format` | Float or String | | +| `gc_deletes` | String | 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. | +| `hidden` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `highlight` | Object | | +| `highlight.max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `index` | Object | The index settings to be updated. | +| `indexing` | Object | | +| `indexing_pressure` | Object | | +| `knn` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `knn.algo_param.ef_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `lifecycle` | Object | | +| `lifecycle.name` | String | The name of a resource or configuration element. | +| `load_fixed_bitset_filters_eagerly` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `mapping` | Object | | +| `max_docvalue_fields_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_inner_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_ngram_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_refresh_listeners` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_regex_length` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_rescore_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_script_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_shingle_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_slices_per_scroll` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_terms_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `merge` | Object | | +| `merge.scheduler.max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `mode` | String | | +| `number_of_replicas` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `number_of_routing_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `number_of_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `priority` | Float or String | | +| `provided_name` | String | The name of a resource or configuration element. | +| `queries` | Object | | +| `query_string` | Object | | +| `query_string.lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `refresh_interval` | String | 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. | +| `routing` | Object | | +| `routing_partition_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `routing_path` | Array of Strings or String | | +| `search` | Object | | +| `search.idle.after` | String | 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. | +| `settings` | Object | The index settings to be updated. | +| `similarity` | Object | | +| `soft_deletes` | Object | | +| `soft_deletes.retention_lease.period` | String | 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. | +| `sort` | Object | | +| `store` | Object | | +| `top_metrics_max_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `translog` | Object | | +| `translog.durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | +| `translog.flush_threshold_size` | String | The unique identifier of a node. | +| `uuid` | String | The universally unique identifier. | +| `verified_before_close` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | Object | | + +
+
+ + Request body fields: index_settings > index > settings > similarity + + {: .text-delta} + +`similarity` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `bm25` | Object | | +| `dfi` | Object | | +| `dfr` | Object | | +| `ib` | Object | | +| `lmd` | Object | | +| `lmj` | Object | | +| `scripted_tfidf` | Object | | + +
+
+ + Request body fields: index_settings > index > settings > similarity > bm25 + + {: .text-delta} + +`bm25` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `b` | **Required** | Float | | +| `discount_overlaps` | **Required** | Boolean | | +| `k1` | **Required** | Float | | +| `type` | **Required** | String | Valid values are: `BM25`. | + +
+
+ + Request body fields: index_settings > index > settings > similarity > dfi + + {: .text-delta} + +`dfi` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `independence_measure` | **Required** | String | Valid values are:
- `chisquared`: The chi-squared measure of independence.
- `saturated`: The saturated measure of independence.
- `standardized`: The standardized measure of independence. | +| `type` | **Required** | String | Valid values are: `DFI`. | + +
+
+ + Request body fields: index_settings > index > settings > similarity > dfr + + {: .text-delta} + +`dfr` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `after_effect` | **Required** | String | Valid values are:
- `b`: The basic after effect.
- `l`: The Laplace after effect.
- `no`: No after effect. | +| `basic_model` | **Required** | String | Valid values are:
- `be`: The Bose-Einstein model.
- `d`: The divergence from independence model.
- `g`: The geometric model.
- `if`: The inverse frequency model.
- `in`: The inverse document frequency model.
- `ine`: The inverse expected document frequency model.
- `p`: The Poisson model. | +| `normalization` | **Required** | String | Valid values are:
- `h1`: The first normalization of Hazm.
- `h2`: The second normalization of Hazm.
- `h3`: The third normalization of Hazm.
- `no`: No normalization.
- `z`: The Zipfian normalization. | +| `type` | **Required** | String | Valid values are: `DFR`. | + +
+
+ + Request body fields: index_settings > index > settings > similarity > ib + + {: .text-delta} + +`ib` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `distribution` | **Required** | String | Valid values are:
- `ll`: The log-logistic distribution.
- `spl`: The smoothed power-law distribution. | +| `lambda` | **Required** | String | Valid values are:
- `df`: The document frequency Lambda.
- `ttf`: The total term frequency Lambda. | +| `normalization` | **Required** | String | Valid values are:
- `h1`: The first normalization of Hazm.
- `h2`: The second normalization of Hazm.
- `h3`: The third normalization of Hazm.
- `no`: No normalization.
- `z`: The Zipfian normalization. | +| `type` | **Required** | String | Valid values are: `IB`. | + +
+
+ + Request body fields: index_settings > index > settings > similarity > lmd + + {: .text-delta} + +`lmd` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `mu` | **Required** | Float | | +| `type` | **Required** | String | Valid values are: `LMDirichlet`. | + +
+
+ + Request body fields: index_settings > index > settings > similarity > lmj + + {: .text-delta} + +`lmj` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `lambda` | **Required** | Float | | +| `type` | **Required** | String | Valid values are: `LMJelinekMercer`. | + +
+
+ + Request body fields: index_settings > index > settings > similarity > scripted_tfidf + + {: .text-delta} + +`scripted_tfidf` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `script` | **Required** | Object or Object or String | | +| `type` | **Required** | String | Valid values are: `scripted`. | + +
+
+ + Request body fields: index_settings > index > settings > similarity > scripted_tfidf > script + + {: .text-delta} + +`script` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `source` | **Required** | String | The script source. | +| `lang` | _Optional_ | String | | +| `options` | _Optional_ | Object | | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `id` | **Required** | String | The unique identifier for a resource. | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +
+
+ + Request body fields: index_settings > index > settings > similarity > scripted_tfidf > script + + {: .text-delta} + +`script` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `id` | **Required** | String | The unique identifier for a resource. | +| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | + +
+
+ + Request body fields: index_settings > index > settings > soft_deletes + + {: .text-delta} + +`soft_deletes` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `retention` | Object | | +| `retention_lease` | Object | | + +
+
+ + Request body fields: index_settings > index > settings > soft_deletes > retention + + {: .text-delta} + +`retention` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `operations` | Integer or String | | + +
+
+ + Request body fields: index_settings > index > settings > soft_deletes > retention_lease + + {: .text-delta} + +`retention_lease` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `period` | **Required** | String | 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. | + +
+
+ + Request body fields: index_settings > index > settings > sort + + {: .text-delta} + +`sort` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `field` | Array of Strings or String | | +| `missing` | Array of Strings or String | Valid values are: `_first`, and `_last`. | +| `mode` | Array of Strings or String | Valid values are: `max`, and `min`. | +| `order` | Array of Strings or String | Valid values are: `asc`, and `desc`. | + +
+
+ + Request body fields: index_settings > index > settings > store + + {: .text-delta} + +`store` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | | +| `allow_mmap` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `fs` | _Optional_ | Object | | +| `hybrid` | _Optional_ | Object | | +| `preload` | _Optional_ | Array of Strings | | +| `stats_refresh_interval` | _Optional_ | String | 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. | + +
+
+ + Request body fields: index_settings > index > settings > store > fs + + {: .text-delta} + +`fs` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `fs_lock` | String | Valid values are: `native`, and `simple`. | + +
+
+ + Request body fields: index_settings > index > settings > store > hybrid + + {: .text-delta} + +`hybrid` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `mmap` | Object | | +| `nio` | Object | | + +
+
+ + Request body fields: index_settings > index > settings > store > hybrid > mmap + + {: .text-delta} + +`mmap` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `extensions` | Array of Strings | | + +
+
+ + Request body fields: index_settings > index > settings > store > hybrid > nio + + {: .text-delta} + +`nio` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `extensions` | Array of Strings | | + +
+
+ + Request body fields: index_settings > index > settings > translog + + {: .text-delta} + +`translog` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | +| `flush_threshold_size` | String | The unique identifier of a node. | +| `generation_threshold_size` | String | The unique identifier of a node. | +| `retention` | Object | | +| `sync_interval` | String | 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. | + +
+
+ + Request body fields: index_settings > index > settings > translog > retention + + {: .text-delta} + +`retention` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `age` | String | 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. | +| `size` | String | The unique identifier of a node. | + +
+
+ + Request body fields: index_settings > index > settings > version + + {: .text-delta} + +`version` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `created` | String | | +| `created_string` | String | | + +
+
+ + Request body fields: index_settings > index > settings > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > index > similarity + + {: .text-delta} + +`similarity` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `bm25` | Object | | +| `dfi` | Object | | +| `dfr` | Object | | +| `ib` | Object | | +| `lmd` | Object | | +| `lmj` | Object | | +| `scripted_tfidf` | Object | | + +
+
+ + Request body fields: index_settings > index > soft_deletes + + {: .text-delta} + +`soft_deletes` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `retention` | Object | | +| `retention_lease` | Object | | + +
+
+ + Request body fields: index_settings > index > sort + + {: .text-delta} + +`sort` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `field` | Array of Strings or String | | +| `missing` | Array of Strings or String | Valid values are: `_first`, and `_last`. | +| `mode` | Array of Strings or String | Valid values are: `max`, and `min`. | +| `order` | Array of Strings or String | Valid values are: `asc`, and `desc`. | + +
+
+ + Request body fields: index_settings > index > store + + {: .text-delta} + +`store` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | | +| `allow_mmap` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `fs` | _Optional_ | Object | | +| `hybrid` | _Optional_ | Object | | +| `preload` | _Optional_ | Array of Strings | | +| `stats_refresh_interval` | _Optional_ | String | 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. | + +
+
+ + Request body fields: index_settings > index > translog + + {: .text-delta} + +`translog` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | +| `flush_threshold_size` | String | The unique identifier of a node. | +| `generation_threshold_size` | String | The unique identifier of a node. | +| `retention` | Object | | +| `sync_interval` | String | 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. | + +
+
+ + Request body fields: index_settings > index > version + + {: .text-delta} + +`version` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `created` | String | | +| `created_string` | String | | + +
+
+ + Request body fields: index_settings > index > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Request body fields: index_settings > indexing + + {: .text-delta} + +`indexing` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `slowlog` | Object | | + +
+
+ + Request body fields: index_settings > indexing_pressure + + {: .text-delta} + +`indexing_pressure` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `memory` | **Required** | Object | | + +
+
+ + Request body fields: index_settings > lifecycle + + {: .text-delta} + +`lifecycle` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `name` | **Required** | String | The name of a resource or configuration element. | +| `indexing_complete` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `origination_date` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `parse_origination_date` | _Optional_ | Boolean | Set to `true` to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern `^.*-{date_format}-\\d+`, where the `date_format` is `yyyy.MM.dd` and the trailing digits are optional. An index that was rolled over would normally match the full format, for example `logs-2016.10.31-000002`). If the index name doesn't match the pattern, index creation fails. | +| `rollover_alias` | _Optional_ | String | The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indexes, see Rollover. | +| `step` | _Optional_ | Object | | + +
+
+ + Request body fields: index_settings > mapping + + {: .text-delta} + +`mapping` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `coerce` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `depth` | Object | | +| `dimension_fields` | Object | | +| `field_name_length` | Object | | +| `ignore_malformed` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `nested_fields` | Object | | +| `nested_objects` | Object | | +| `total_fields` | Object | | + +
+
+ + Request body fields: index_settings > merge + + {: .text-delta} + +`merge` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `log_byte_size_policy` | Object | | +| `policy` | Object or String | Valid values are: `default`, `log_byte_size`, and `tiered`. | +| `policy.deletes_pct_allowed` | Float or String | | +| `policy.expunge_deletes_allowed` | Float or String | | +| `policy.floor_segment` | String | The unique identifier of a node. | +| `policy.max_merge_at_once` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `policy.max_merged_segment` | String | The unique identifier of a node. | +| `policy.reclaim_deletes_weight` | Float or String | | +| `policy.segments_per_tier` | Float or String | | +| `scheduler` | Object | | + +
+
+ + Request body fields: index_settings > queries + + {: .text-delta} + +`queries` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `cache` | Object | | + +
+
+ + Request body fields: index_settings > query_string + + {: .text-delta} + +`query_string` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > routing + + {: .text-delta} + +`routing` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `allocation` | Object | | +| `rebalance` | Object | | + +
+
+ + Request body fields: index_settings > search + + {: .text-delta} + +`search` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `concurrent` | Object | | +| `concurrent_segment_search` | Object | | +| `default_pipeline` | String | | +| `idle` | Object | | +| `slowlog` | Object | | +| `throttled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | + +
+
+ + Request body fields: index_settings > settings + + {: .text-delta} + +The index settings to be updated. + +`settings` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | +| `analysis` | Object | | +| `analyze` | Object | | +| `analyze.max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `auto_expand_replicas` | String | | +| `blocks` | Object | | +| `blocks.metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `blocks.write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `check_on_startup` | String | Valid values are: `checksum`, `false`, and `true`. | +| `codec` | String | | +| `composite_index.star_tree` | Object | | +| `creation_date` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `creation_date_string` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `default_pipeline` | String | | +| `final_pipeline` | String | | +| `format` | Float or String | | +| `gc_deletes` | String | 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. | +| `hidden` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `highlight` | Object | | +| `highlight.max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `index` | Object | The index settings to be updated. | +| `indexing` | Object | | +| `indexing_pressure` | Object | | +| `knn` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `knn.algo_param.ef_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `lifecycle` | Object | | +| `lifecycle.name` | String | The name of a resource or configuration element. | +| `load_fixed_bitset_filters_eagerly` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `mapping` | Object | | +| `max_docvalue_fields_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_inner_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_ngram_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_refresh_listeners` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_regex_length` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_rescore_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_script_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_shingle_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_slices_per_scroll` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `max_terms_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `merge` | Object | | +| `merge.scheduler.max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `mode` | String | | +| `number_of_replicas` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `number_of_routing_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `number_of_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `priority` | Float or String | | +| `provided_name` | String | The name of a resource or configuration element. | +| `queries` | Object | | +| `query_string` | Object | | +| `query_string.lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `refresh_interval` | String | 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. | +| `routing` | Object | | +| `routing_partition_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `routing_path` | Array of Strings or String | | +| `search` | Object | | +| `search.idle.after` | String | 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. | +| `settings` | Object | The index settings to be updated. | +| `similarity` | Object | | +| `soft_deletes` | Object | | +| `soft_deletes.retention_lease.period` | String | 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. | +| `sort` | Object | | +| `store` | Object | | +| `top_metrics_max_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `translog` | Object | | +| `translog.durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | +| `translog.flush_threshold_size` | String | The unique identifier of a node. | +| `uuid` | String | The universally unique identifier. | +| `verified_before_close` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `version` | Object | | + +
+
+ + Request body fields: index_settings > similarity + + {: .text-delta} + +`similarity` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `bm25` | Object | | +| `dfi` | Object | | +| `dfr` | Object | | +| `ib` | Object | | +| `lmd` | Object | | +| `lmj` | Object | | +| `scripted_tfidf` | Object | | + +
+
+ + Request body fields: index_settings > soft_deletes + + {: .text-delta} + +`soft_deletes` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `retention` | Object | | +| `retention_lease` | Object | | + +
+
+ + Request body fields: index_settings > sort + + {: .text-delta} + +`sort` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `field` | Array of Strings or String | | +| `missing` | Array of Strings or String | Valid values are: `_first`, and `_last`. | +| `mode` | Array of Strings or String | Valid values are: `max`, and `min`. | +| `order` | Array of Strings or String | Valid values are: `asc`, and `desc`. | + +
+
+ + Request body fields: index_settings > store + + {: .text-delta} + +`store` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | | +| `allow_mmap` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `fs` | _Optional_ | Object | | +| `hybrid` | _Optional_ | Object | | +| `preload` | _Optional_ | Array of Strings | | +| `stats_refresh_interval` | _Optional_ | String | 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. | + +
+
+ + Request body fields: index_settings > translog + + {: .text-delta} + +`translog` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | +| `flush_threshold_size` | String | The unique identifier of a node. | +| `generation_threshold_size` | String | The unique identifier of a node. | +| `retention` | Object | | +| `sync_interval` | String | 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. | + +
+
+ + Request body fields: index_settings > version + + {: .text-delta} + +`version` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `created` | String | | +| `created_string` | String | | + +
+
+ + Request body fields: index_settings > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+ + + +## Response body fields + +The response body is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `accepted` | Boolean | Returns `true` if the restore was accepted. Present when the request had `wait_for_completion` set to `false`. | +| `snapshot` | Object | | + +
+ + Response body fields: snapshot + + {: .text-delta} + +`snapshot` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `indices` | **Required** | Array of Strings | The list of indexes that were restored. | +| `shards` | **Required** | Object | Any statistics about the restored shards. | +| `snapshot` | **Required** | String | The name of the snapshot that was restored. | + +
+
+ + Response body fields: snapshot > shards + + {: .text-delta} + +Any statistics about the restored shards. + +`shards` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `failed` | **Required** | Integer | | +| `successful` | **Required** | Integer | | +| `total` | **Required** | Integer | | +| `failures` | _Optional_ | Array of Objects | | +| `skipped` | _Optional_ | Integer | | + +
+
+ + Response body fields: snapshot > shards > failures + + {: .text-delta} + +`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `reason` | **Required** | Object | | +| `shard` | **Required** | Integer | | +| `index` | _Optional_ | String | | +| `node` | _Optional_ | String | | +| `status` | _Optional_ | String | | + +
+
+ + Response body fields: snapshot > shards > failures > reason + + {: .text-delta} + +`reason` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by + + {: .text-delta} + +`caused_by` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > root_cause + + {: .text-delta} + +`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > suppressed + + {: .text-delta} + +`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > suppressed > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > suppressed + + {: .text-delta} + +`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > caused_by > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+
+ + Response body fields: snapshot > shards > failures > reason > root_cause + + {: .text-delta} + +`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > suppressed + + {: .text-delta} + +`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `type` | **Required** | String | The type of error. | +| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | +| `caused_by` | _Optional_ | Object | | +| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | +| `root_cause` | _Optional_ | Array of Objects | | +| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | _Optional_ | Array of Objects | | + +
+
+ + Response body fields: snapshot > shards > failures > reason > -- freeform field -- + + {: .text-delta} + +Any additional information about the error. + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | + +
+ + ## Endpoints ```json diff --git a/_api-reference/snapshots/verify-snapshot-repository.md b/_api-reference/snapshots/verify-snapshot-repository.md index 8827fee0c3f..e0256a85139 100644 --- a/_api-reference/snapshots/verify-snapshot-repository.md +++ b/_api-reference/snapshots/verify-snapshot-repository.md @@ -17,6 +17,48 @@ If verification is successful, the verify snapshot repository API returns a list If you use the Security plugin, you must have the `manage cluster` privilege. {: .note} + +## Endpoints +```json +POST /_snapshot/{repository}/_verify +``` + + + + +## Path parameters + +The following table lists the available path parameters. + +| Parameter | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `repository` | **Required** | String | The name of the repository containing the snapshot. | + + + + +## Query parameters + +The following table lists the available query parameters. All query parameters are optional. + +| Parameter | Data type | Description | +| :--- | :--- | :--- | +| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | +| `timeout` | String | The amount of time to wait for a response. | + + + + ## Endpoints ```json @@ -76,8 +118,42 @@ In the preceding sample, one node is connected to the snapshot repository. If mo } ```` + ## Response body fields -| Field | Data type | Description | -:--- | :--- | :--- -| nodes | Object | A list (not an array) of nodes connected to the snapshot repository. Each node itself is a property where the node ID is the key and the name has an ID (Object) and a name (String). | \ No newline at end of file +The response body is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `nodes` | **Required** | Object | | + +
+ + Response body fields: nodes + + {: .text-delta} + +`nodes` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `-- freeform field --` | Object | | + +
+
+ + Response body fields: nodes > -- freeform field -- + + {: .text-delta} + +`-- freeform field --` is a JSON object with the following fields. + +| Property | Required | Data type | Description | +| :--- | :--- | :--- | :--- | +| `name` | **Required** | String | The name of a resource or configuration element. | + +
+ From 04cb897a8ed01a60ab188cdd2b7c53e8c1db841b Mon Sep 17 00:00:00 2001 From: Archer Date: Mon, 28 Apr 2025 14:04:56 -0500 Subject: [PATCH 2/4] Add Snapshot API edits and automation markers Signed-off-by: Archer --- .../snapshots/cleanup-snapshot-repository.md | 8 +- _api-reference/snapshots/clone-snapshot.md | 7 +- _api-reference/snapshots/create-repository.md | 113 +- _api-reference/snapshots/create-snapshot.md | 553 +- .../snapshots/delete-snapshot-repository.md | 11 +- _api-reference/snapshots/delete-snapshot.md | 14 +- .../snapshots/get-snapshot-repository.md | 69 +- .../snapshots/get-snapshot-status.md | 641 +- _api-reference/snapshots/get-snapshot.md | 453 +- _api-reference/snapshots/restore-snapshot.md | 5389 +---------------- .../snapshots/verify-snapshot-repository.md | 96 +- 11 files changed, 420 insertions(+), 6934 deletions(-) diff --git a/_api-reference/snapshots/cleanup-snapshot-repository.md b/_api-reference/snapshots/cleanup-snapshot-repository.md index 3a9038f2a9c..70e4381460d 100644 --- a/_api-reference/snapshots/cleanup-snapshot-repository.md +++ b/_api-reference/snapshots/cleanup-snapshot-repository.md @@ -1,15 +1,15 @@ --- layout: default -title: Cleanup Snapshot Repository +title: Cleanup snapshot repository parent: Snapshot APIs nav_order: 11 --- -# Cleanup Snapshot Repository +# Cleanup snapshot repository Introduced 1.0 {: .label .label-purple } -The Cleanup Snapshot Repository API clears a snapshot repository of data no longer referenced by any existing snapshot. +The Cleanup Snapshot Repository API removes data from a snapshot repository that is no longer referenced by any existing snapshot. This helps reclaim storage space and optimize repository performance. diff --git a/_api-reference/snapshots/create-repository.md b/_api-reference/snapshots/create-repository.md index 56e93cee26f..23181b3b574 100644 --- a/_api-reference/snapshots/create-repository.md +++ b/_api-reference/snapshots/create-repository.md @@ -1,23 +1,23 @@ --- layout: default -title: Register Snapshot Repository +title: Register or update snapshot repository parent: Snapshot APIs nav_order: 1 --- -# Registering or updating a snapshot repository +# Register or update snapshot reposity **Introduced 1.0** {: .label .label-purple } -You can register a new repository in which to store snapshots or update information for an existing repository by using the snapshots API. +The Register Snapshot Repository API lets you register a new repository for storing snapshots or update information for an existing repository. There are two types of snapshot repositories: -* File system (`fs`): For instructions on creating an `fs` repository, see [Register repository shared file system]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/#shared-file-system). +* File system (`fs`): Stores snapshots in a shared file system accessible to all cluster nodes. For instructions on creating an `fs` repository, see [Register repository shared file system]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/#shared-file-system). -* Amazon Simple Storage Service (Amazon S3) bucket (`s3`): For instructions on creating an `s3` repository, see [Register repository Amazon S3]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/#amazon-s3). +* Amazon Simple Storage Service (`s3`): Stores snapshots in an Amazon S3 bucket. For instructions on creating an `s3` repository, see [Register repository Amazon S3]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/#amazon-s3). -For instructions on creating a repository, see [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository). +For general repository creation instructions, see [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository). @@ -74,9 +74,9 @@ The request body is __required__. It is a JSON object with the following fields. | Property | Required | Data type | Description | | :--- | :--- | :--- | :--- | -| `settings` | **Required** | Object | The settings for the snapshot repository. | -| `type` | **Required** | String | | -| `repository` | _Optional_ | Object | The name of the repository to store the snapshot. | +| `type` | **Required** | String | The type of repository to register, either `fs` or `s3`. | +| `settings` | **Required** | Object | The settings for the snapshot repository. See [Repository specific parameters](#repository-specific-parameters) for available options. | +| `repository` | Optional | Object | The name of the repository to store the snapshot. |
@@ -108,10 +108,10 @@ The settings for the snapshot repository. | Property | Data type | Description | | :--- | :--- | :--- | | `chunk_size` | String | The chunk size for the repository. | -| `compress` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `concurrent_streams` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `compress` | Boolean or String | Whether to compress metadata files. | +| `concurrent_streams` | Integer or String | The number of concurrent streams for repository operations. | | `location` | String | The location where snapshots are stored. | -| `read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `read_only` | Boolean or String | Whether the repository is read-only. |
@@ -127,10 +127,10 @@ The settings for the snapshot repository. | Property | Data type | Description | | :--- | :--- | :--- | | `chunk_size` | String | The chunk size for the repository. | -| `compress` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `concurrent_streams` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `compress` | Boolean or String | Whether to compress metadata files. | +| `concurrent_streams` | Integer or String | The number of concurrent streams for repository operations. | | `location` | String | The location where snapshots are stored. | -| `read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `read_only` | Boolean or String | Whether the repository is read-only. |
@@ -140,10 +140,10 @@ The settings for the snapshot repository. The following table lists parameters that can be used with both the `fs` and `s3` repositories. -Request field | Description -:--- | :--- -`prefix_mode_verification` | When enabled, adds a hashed value of a random seed to the prefix for repository verification. For remote-store-enabled clusters, you can add the `setting.prefix_mode_verification` setting to the node attributes for the supplied repository. This field works with both new and existing repositories. Optional. -`shard_path_type` | Controls the path structure of shard-level blobs. Supported values are `FIXED`, `HASHED_PREFIX`, and `HASHED_INFIX`. For more information about each value, see [shard_path_type values](#shard_path_type-values)/. Default is `FIXED`. Optional. +| Request field | Data type | Description | +|:--- | :--- | :--- | +| `prefix_mode_verification` | Boolean | When enabled, adds a hashed value of a random seed to the prefix for repository verification. For remote-store-enabled clusters, you can add the `setting.prefix_mode_verification` setting to the node attributes for the supplied repository. This field works with both new and existing repositories. Optional. | +| `shard_path_type` | String | Controls the path structure of shard-level blobs. Supported values are `FIXED`, `HASHED_PREFIX`, and `HASHED_INFIX`. For more information about each value, see [shard_path_type values](#shard_path_type-values). Default is `FIXED`. Optional. | #### shard_path_type values @@ -155,37 +155,41 @@ The following values are supported in the `shard_path_type` setting: ### fs repository -Request field | Description -:--- | :--- -`location` | The file system directory for snapshots, such as a mounted directory from a file server or a Samba share. Must be accessible by all nodes. Required. -`chunk_size` | Breaks large files into chunks during snapshot operations (e.g. `64mb`, `1gb`), which is important for cloud storage providers and far less important for shared file systems. Default is `null` (unlimited). Optional. -`compress` | Whether to compress metadata files. This setting does not affect data files, which might already be compressed, depending on your index settings. Default is `false`. Optional. -`max_restore_bytes_per_sec` | The maximum rate at which snapshots restore. Default is 40 MB per second (`40m`). Optional. -`max_snapshot_bytes_per_sec` | The maximum rate at which snapshots take. Default is 40 MB per second (`40m`). Optional. -`remote_store_index_shallow_copy` | Boolean | Determines whether the snapshot of the remote store indexes are captured as a shallow copy. Default is `false`. -`shallow_snapshot_v2` | Boolean | Determines whether the snapshots of the remote store indexes are captured as a [shallow copy v2]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/remote-store/snapshot-interoperability/#shallow-snapshot-v2). Default is `false`. -`readonly` | Whether the repository is read-only. Useful when migrating from one cluster (`"readonly": false` when registering) to another cluster (`"readonly": true` when registering). Optional. +The following table lists parameters specific to `fs` repositories: + +| Request field | Data type | Description | +|:--- | :--- | :--- | +| `location` | String | The file system directory for snapshots, such as a mounted directory from a file server or a Samba share. Must be accessible by all nodes. Required. | +| `chunk_size` | String | Breaks large files into chunks during snapshot operations (e.g. `64mb`, `1gb`), which is important for cloud storage providers and far less important for shared file systems. Default is `null` (unlimited). Optional. | +| `compress` | Boolean | Whether to compress metadata files. This setting does not affect data files, which might already be compressed, depending on your index settings. Default is `false`. Optional. | +| `max_restore_bytes_per_sec` | String | The maximum rate at which snapshots restore. Default is 40 MB per second (`40m`). Optional. | +| `max_snapshot_bytes_per_sec` | String | The maximum rate at which snapshots take. Default is 40 MB per second (`40m`). Optional. | +| `remote_store_index_shallow_copy` | Boolean | Determines whether the snapshot of the remote store indexes are captured as a shallow copy. Default is `false`. Optional. | +| `shallow_snapshot_v2` | Boolean | Determines whether the snapshots of the remote store indexes are captured as a [shallow copy v2]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/remote-store/snapshot-interoperability/#shallow-snapshot-v2). Default is `false`. Optional. | +| `readonly` | Boolean | Whether the repository is read-only. Useful when migrating from one cluster (`"readonly": false` when registering) to another cluster (`"readonly": true` when registering). Optional. | #### s3 repository -Request field | Description -:--- | :--- -`base_path` | The path within the bucket in which you want to store snapshots (for example, `my/snapshot/directory`). Optional. If not specified, snapshots are stored in the S3 bucket root. -`bucket` | Name of the S3 bucket. Required. -`buffer_size` | The threshold beyond which chunks (of `chunk_size`) should be broken into pieces (of `buffer_size`) and sent to S3 using a different API. Default is the smaller of two values: 100 MB or 5% of the Java heap. Valid values are between `5mb` and `5gb`. We don't recommend changing this option. -`canned_acl` | S3 has several [canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) that the `repository-s3` plugin can add to objects as it creates them in S3. Default is `private`. Optional. -`chunk_size` | Breaks files into chunks during snapshot operations (e.g. `64mb`, `1gb`), which is important for cloud storage providers and far less important for shared file systems. Default is `1gb`. Optional. -`client` | When specifying client settings (e.g. `s3.client.default.access_key`), you can use a string other than `default` (e.g. `s3.client.backup-role.access_key`). If you used an alternate name, change this value to match. Default and recommended value is `default`. Optional. -`compress` | Whether to compress metadata files. This setting does not affect data files, which might already be compressed, depending on your index settings. Default is `false`. Optional. -`disable_chunked_encoding` | Disables chunked encoding for compatibility with some storage services. Default is `false`. Optional. -`max_restore_bytes_per_sec` | The maximum rate at which snapshots restore. Default is 40 MB per second (`40m`). Optional. -`max_snapshot_bytes_per_sec` | The maximum rate at which snapshots take. Default is 40 MB per second (`40m`). Optional. -`readonly` | Whether the repository is read-only. Useful when migrating from one cluster (`"readonly": false` when registering) to another cluster (`"readonly": true` when registering). Optional. -`remote_store_index_shallow_copy` | Boolean | Whether the snapshot of the remote store indexes is captured as a shallow copy. Default is `false`. -`shallow_snapshot_v2` | Boolean | Determines whether the snapshots of the remote store indexes are captured as a [shallow copy v2]([shallow copy v2]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/remote-store/snapshot-interoperability/#shallow-snapshot-v2). Default is `false`. -`server_side_encryption` | Whether to encrypt snapshot files in the S3 bucket. This setting uses AES-256 with S3-managed keys. See [Protecting data using server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html). Default is `false`. Optional. -`storage_class` | Specifies the [S3 storage class](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) for the snapshots files. Default is `standard`. Do not use the `glacier` and `deep_archive` storage classes. Optional. +The following table lists parameters specific to `s3` repositories: + +| Request field | Data type | Description | +|:--- | :--- | :--- | +| `bucket` | String | Name of the S3 bucket. Required. | +| `base_path` | String | The path within the bucket in which to store snapshots (for example, `my/snapshot/directory`). Optional. If not specified, snapshots are stored in the S3 bucket root. | +| `buffer_size` | String | The threshold beyond which chunks (of `chunk_size`) should be broken into pieces (of `buffer_size`) and sent to S3 using a different API. Default is the smaller of two values: 100 MB or 5% of the Java heap. Valid values are between `5mb` and `5gb`. We don't recommend changing this option. | +| `canned_acl` | String | S3 has several [canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) that the `repository-s3` plugin can add to objects as it creates them in S3. Default is `private`. Optional. | +| `chunk_size` | String | Breaks files into chunks during snapshot operations (e.g. `64mb`, `1gb`), which is important for cloud storage providers and far less important for shared file systems. Default is `1gb`. Optional. | +| `client` | String | When specifying client settings (e.g. `s3.client.default.access_key`), you can use a string other than `default` (e.g. `s3.client.backup-role.access_key`). If you used an alternate name, change this value to match. Default and recommended value is `default`. Optional. | +| `compress` | Boolean | Whether to compress metadata files. This setting does not affect data files, which might already be compressed, depending on your index settings. Default is `false`. Optional. | +| `disable_chunked_encoding` | Boolean | Disables chunked encoding for compatibility with some storage services. Default is `false`. Optional. | +| `max_restore_bytes_per_sec` | String | The maximum rate at which snapshots restore. Default is 40 MB per second (`40m`). Optional. | +| `max_snapshot_bytes_per_sec` | String | The maximum rate at which snapshots take. Default is 40 MB per second (`40m`). Optional. | +| `readonly` | Boolean | Whether the repository is read-only. Useful when migrating from one cluster (`"readonly": false` when registering) to another cluster (`"readonly": true` when registering). Optional. | +| `remote_store_index_shallow_copy` | Boolean | Whether the snapshot of the remote store indexes is captured as a shallow copy. Default is `false`. Optional. | +| `shallow_snapshot_v2` | Boolean | Determines whether the snapshots of the remote store indexes are captured as a [shallow copy v2]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/remote-store/snapshot-interoperability/#shallow-snapshot-v2). Default is `false`. Optional. | +| `server_side_encryption` | Boolean | Whether to encrypt snapshot files in the S3 bucket. This setting uses AES-256 with S3-managed keys. See [Protecting data using server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html). Default is `false`. Optional. | +| `storage_class` | String | Specifies the [S3 storage class](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) for the snapshots files. Default is `standard`. Do not use the `glacier` and `deep_archive` storage classes. Optional. | For the `base_path` parameter, do not enter the `s3://` prefix when entering your S3 bucket details. Only the name of the bucket is required. {: .note} @@ -237,18 +241,3 @@ Upon success, the following JSON object is returned: To verify that the repository was registered, use the [Get snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository) API, passing the repository name as the `repository` path parameter. {: .note} - -## Response body fields - -The response body is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `acknowledged` | **Required** | Boolean | | -| `index` | **Required** | String | | -| `shards_acknowledged` | **Required** | Boolean | | - - diff --git a/_api-reference/snapshots/create-snapshot.md b/_api-reference/snapshots/create-snapshot.md index d7a74e85e77..5f024c291c9 100644 --- a/_api-reference/snapshots/create-snapshot.md +++ b/_api-reference/snapshots/create-snapshot.md @@ -9,11 +9,10 @@ nav_order: 5 **Introduced 1.0** {: .label .label-purple } -Creates a snapshot within an existing repository. +The Create Snapshot API creates a snapshot of your cluster's data within an existing repository. Snapshots serve as backups that you can use to restore your data or migrate it between clusters. -* To learn more about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index). - -* To view a list of your repositories, see [Get snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository). +* For more information about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index). +* To view a list of your repositories, see [Get Snapshot Repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository). ## Query parameters @@ -54,452 +54,38 @@ The following table lists the available query parameters. All query parameters a | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | | `wait_for_completion` | Boolean | When `true`, the request returns a response when the snapshot is complete. When `false`, the request returns a response when the snapshot initializes. _(Default: `false`)_ | -| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ 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. | - -## Request body fields -The snapshot definition. +## Request body fields The request body is optional. It is a JSON object with the following fields. | Property | Data type | Description | Default | | :--- | :--- | :--- | :--- | -| `feature_states` | Array of Strings | A list of feature states to include in the snapshot. Each feature state includes one or more system indexes which contain related data. You can view a list of features using the Get Feature API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. | N/A | -| `ignore_unavailable` | Boolean | When `true`, the request ignores any data streams and indexes that are missing or closed. When `false`, the request returns an error for any data streams or indexes that is missing or closed. | N/A | -| `include_global_state` | Boolean | When `true`, includes the current cluster state in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. The cluster state also includes data stored in system indexes, such as watches and task records (configurable with `feature_states`). | `true` | -| `indices` | Array of Strings or String | 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`. | N/A | -| `metadata` | Object | The custom metadata attached to a resource. | N/A | -| `partial` | Boolean | When `true`, enables the restoration of a partial snapshot from indexes with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. When `false`, the entire restore operation will fail if one or more indexes included in the snapshot do not have all primary shards available. | `false` | - -
- - Request body fields: metadata - - {: .text-delta} - -The custom metadata attached to a resource. - -`metadata` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | - -
-
- - Request body fields: metadata > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
- - - -## Response body fields - -The response body is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `accepted` | Boolean | Returns `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`. | -| `snapshot` | Object | | - -
- - Response body fields: snapshot - - {: .text-delta} - -`snapshot` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `data_streams` | Array of Strings | The list of data streams included in the snapshot. | -| `duration` | String | 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. | -| `duration_in_millis` | Integer | The time unit for milliseconds. | -| `end_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | -| `end_time_in_millis` | Integer | The time unit for milliseconds. | -| `failures` | Array of Objects | The list of shard failures that occurred during the snapshot. | -| `include_global_state` | Boolean | Whether the snapshot includes the cluster state. | -| `indices` | Array of Strings | The list of indexes included in the snapshot. | -| `metadata` | Object | The custom metadata attached to a resource. | -| `pinned_timestamp` | Integer | The time unit for milliseconds. | -| `reason` | String | The reason for the snapshot creation. | -| `remote_store_index_shallow_copy` | Boolean | Whether the snapshot uses remote store index shallow copy. | -| `shards` | Object | The statistics about the shards included in the snapshot. | -| `snapshot` | String | The name of a resource or configuration element. | -| `start_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | -| `start_time_in_millis` | Integer | The time unit for milliseconds. | -| `state` | String | The current state of the snapshot. | -| `uuid` | String | The universally unique identifier. | -| `version` | String | The version of OpenSearch when the snapshot was created. | -| `version_id` | Integer | The internal version number of OpenSearch when the snapshot was created. | - -
-
- - Response body fields: snapshot > end_time - - {: .text-delta} - -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`end_time` is a JSON object with the following fields. +| `indices` | String or Array of Strings | A comma-separated list of data streams, indexes, and aliases to include in the snapshot. Supports wildcards (`*`). To include all data streams and indexes, omit this parameter or use `*` or `_all`. | N/A | +| `ignore_unavailable` | Boolean | When `true`, the request ignores any data streams and indexes that are missing or closed. When `false`, the request returns an error for any data streams or indexes that are missing or closed. | `false` | +| `include_global_state` | Boolean | When `true`, includes the current cluster state in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. The cluster state also includes data stored in system indexes, such as watches and task records (configurable with `feature_states`). | `true` | +| `partial` | Boolean | When `true`, allows the restoration of a partial snapshot if some shards are unavailable. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. When `false`, the entire restore operation will fail if one or more indexes included in the snapshot do not have all primary shards available. | `false` | +| `feature_states` | Array of Strings | A list of feature states to include in the snapshot. Each feature state includes one or more system indexes which contain related data. You can view a list of features using the Get Feature API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. | N/A | +| `metadata` | Object | Custom metadata to attach to the snapshot. | N/A | -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > end_time - - {: .text-delta} - -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`end_time` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > end_time - - {: .text-delta} - -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`end_time` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > failures - - {: .text-delta} - -The list of shard failures that occurred during the snapshot. - -`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `index` | String | The name of the index containing the failed shard. | -| `node_id` | String | The unique identifier for a resource. | -| `reason` | String | The reason for the shard failure. | -| `shard_id` | String | The unique identifier for a resource. | -| `status` | String | The status of the failed shard. | - -
-
- - Response body fields: snapshot > metadata - - {: .text-delta} - -The custom metadata attached to a resource. - -`metadata` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | - -
-
- - Response body fields: snapshot > metadata > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > shards - - {: .text-delta} - -The statistics about the shards included in the snapshot. - -`shards` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `failed` | **Required** | Integer | | -| `successful` | **Required** | Integer | | -| `total` | **Required** | Integer | | -| `failures` | _Optional_ | Array of Objects | | -| `skipped` | _Optional_ | Integer | | - -
-
- - Response body fields: snapshot > shards > failures - - {: .text-delta} - -`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `reason` | **Required** | Object | | -| `shard` | **Required** | Integer | | -| `index` | _Optional_ | String | | -| `node` | _Optional_ | String | | -| `status` | _Optional_ | String | | - -
-
- - Response body fields: snapshot > shards > failures > reason - - {: .text-delta} - -`reason` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by - - {: .text-delta} - -`caused_by` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > root_cause - - {: .text-delta} - -`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > suppressed - - {: .text-delta} - -`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > suppressed > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > suppressed - - {: .text-delta} - -`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > shards > failures > reason > root_cause - - {: .text-delta} - -`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > suppressed - - {: .text-delta} - -`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > start_time - - {: .text-delta} - -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`start_time` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
- ## Example requests -### Request without a body +### Basic request -The following request creates a snapshot called `my-first-snapshot` in an S3 repository called `my-s3-repository`. A request body is not included because it is optional. +The following request creates a snapshot called `my-first-snapshot` in an S3 repository called `my-s3-repository`: ```json POST _snapshot/my-s3-repository/my-first-snapshot ``` {% include copy-curl.html %} -### Request with a body +### Request with configuration -You can also add a request body to include or exclude certain indices or specify other settings: +You can add a request body to include or exclude specific indices or specify other settings: ```json PUT _snapshot/my-s3-repository/2 @@ -514,9 +100,11 @@ PUT _snapshot/my-s3-repository/2 ## Example responses -Upon success, the response content depends on whether you include the `wait_for_completion` query parameter. +The response content depends on whether you include the `wait_for_completion` query parameter. + +### Without `wait_for_completion` -##### `wait_for_completion` not included +When `wait_for_completion=false` (the default), the API returns a simple acknowledgment that the snapshot creation has started: ```json { @@ -524,21 +112,21 @@ Upon success, the response content depends on whether you include the `wait_for_ } ``` -To verify that the snapshot was created, use the [Get snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot) API, passing the snapshot name as the `snapshot` path parameter. +To verify that the snapshot was created, use the [Get Snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot) API, passing the snapshot name as the `snapshot` path parameter. {: .note} -### `wait_for_completion` included +### With `wait_for_completion=true` -The snapshot definition is returned. +When `wait_for_completion=true`, the API returns detailed information about the completed snapshot: ```json { - "snapshot" : { - "snapshot" : "5", - "uuid" : "ZRH4Zv7cSnuYev2JpLMJGw", - "version_id" : 136217927, - "version" : "2.0.1", - "indices" : [ + "snapshot": { + "snapshot": "5", + "uuid": "ZRH4Zv7cSnuYev2JpLMJGw", + "version_id": 136217927, + "version": "2.0.1", + "indices": [ ".opendistro-reports-instances", ".opensearch-observability", ".kibana_1", @@ -547,42 +135,59 @@ The snapshot definition is returned. ".opendistro-reports-definitions", "shakespeare" ], - "data_streams" : [ ], - "include_global_state" : true, - "state" : "SUCCESS", - "start_time" : "2022-08-10T16:52:15.277Z", - "start_time_in_millis" : 1660150335277, - "end_time" : "2022-08-10T16:52:18.699Z", - "end_time_in_millis" : 1660150338699, - "duration_in_millis" : 3422, - "failures" : [ ], - "shards" : { - "total" : 7, - "failed" : 0, - "successful" : 7 + "data_streams": [], + "include_global_state": true, + "state": "SUCCESS", + "start_time": "2022-08-10T16:52:15.277Z", + "start_time_in_millis": 1660150335277, + "end_time": "2022-08-10T16:52:18.699Z", + "end_time_in_millis": 1660150338699, + "duration_in_millis": 3422, + "failures": [], + "shards": { + "total": 7, + "failed": 0, + "successful": 7 } } } ``` -## Response body fields - -| Field | Data type | Description | -| :--- | :--- | :--- | -| snapshot | string | Snapshot name. | -| uuid | string | Snapshot's universally unique identifier (UUID). | -| version_id | int | Build ID of the Open Search version that created the snapshot. | -| version | float | Open Search version that created the snapshot. | -| indices | array | Indices in the snapshot. | -| data_streams | array | Data streams in the snapshot. | -| include_global_state | boolean | Whether the current cluster state is included in the snapshot. | -| start_time | string | Date/time when the snapshot creation process began. | -| start_time_in_millis | long | Time (in milliseconds) when the snapshot creation process began. | -| end_time | string | Date/time when the snapshot creation process ended. | -| end_time_in_millis | long | Time (in milliseconds) when the snapshot creation process ended. | -| duration_in_millis | long | Total time (in milliseconds) that the snapshot creation process lasted. | -| failures | array | Failures, if any, that occured during snapshot creation. | -| shards | object | Total number of shards created along with number of successful and failed shards. | -| state | string | Snapshot status. Possible values: `IN_PROGRESS`, `SUCCESS`, `FAILED`, `PARTIAL`. | -| remote_store_index_shallow_copy | Boolean | Whether the snapshots of the remote store indexes is captured as a shallow copy. Default is `false`. | -| pinned_timestamp | long | A timestamp (in milliseconds) pinned by the snapshot for the implicit locking of remote store files referenced by the snapshot. | \ No newline at end of file +The response body is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `accepted` | Boolean | Returns `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`. | +| `snapshot` | Object | The snapshot creation results. | + +
+ + Response body fields: snapshot + + {: .text-delta} + +`snapshot` is a JSON object with the following fields. + +| Property | Data type | Description | +| :--- | :--- | :--- | +| `data_streams` | Array of Strings | The list of data streams included in the snapshot. | +| `duration` | String | 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. | +| `duration_in_millis` | Integer | The time unit for milliseconds. | +| `end_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `end_time_in_millis` | Integer | The time unit for milliseconds. | +| `failures` | Array of Objects | The list of shard failures that occurred during the snapshot. | +| `include_global_state` | Boolean | Whether the snapshot includes the cluster state. | +| `indices` | Array of Strings | The list of indexes included in the snapshot. | +| `metadata` | Object | The custom metadata attached to a resource. | +| `pinned_timestamp` | Integer | The time unit for milliseconds. | +| `reason` | String | The reason for the snapshot creation. | +| `remote_store_index_shallow_copy` | Boolean | Whether the snapshot uses remote store index shallow copy. | +| `shards` | Object | The statistics about the shards included in the snapshot. | +| `snapshot` | String | The name of a resource or configuration element. | +| `start_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | +| `start_time_in_millis` | Integer | The time unit for milliseconds. | +| `state` | String | The current state of the snapshot. | +| `uuid` | String | The universally unique identifier. | +| `version` | String | The version of OpenSearch when the snapshot was created. | +| `version_id` | Integer | The internal version number of OpenSearch when the snapshot was created. | + diff --git a/_api-reference/snapshots/delete-snapshot-repository.md b/_api-reference/snapshots/delete-snapshot-repository.md index dd549296e6e..38f0c1f1e3d 100644 --- a/_api-reference/snapshots/delete-snapshot-repository.md +++ b/_api-reference/snapshots/delete-snapshot-repository.md @@ -9,11 +9,11 @@ nav_order: 3 **Introduced 1.0** {: .label .label-purple } -Deletes a snapshot repository configuration. - -A repository in OpenSearch is simply a configuration that maps a repository name to a type (file system or s3 repository) along with other information depending on the type. The configuration is backed by a file system location or an s3 bucket. When you invoke the API, the physical file system or s3 bucket itself is not deleted. Only the configuration is deleted. +The Delete Snapshot Repository API removes a snapshot repository configuration from the OpenSearch cluster. -To learn more about repositories, see [Register or update snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-repository). +A repository in OpenSearch is a configuration that maps a repository name to a type (file system or S3) along with storage location information. When you delete a repository, only the configuration is removed from OpenSearch—the physical storage location (file system directory or S3 bucket) and any snapshots it contains remain intact. + +For more information about repositories, see [Register Snapshot Repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-repository). ## Query parameters @@ -52,7 +53,7 @@ The following table lists the available query parameters. All query parameters a | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | | `timeout` | String | The amount of time to wait for a response. | -| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ Explicit operation timeout for connection to cluster-manager node | + diff --git a/_api-reference/snapshots/delete-snapshot.md b/_api-reference/snapshots/delete-snapshot.md index fbc1dd59085..7989346c529 100644 --- a/_api-reference/snapshots/delete-snapshot.md +++ b/_api-reference/snapshots/delete-snapshot.md @@ -9,13 +9,11 @@ nav_order: 7 **Introduced 1.0** {: .label .label-purple } -Deletes a snapshot from a repository. +The Delete Snapshot API permanently removes a snapshot from a repository. Deleting snapshots that are no longer needed helps free up storage space and keep your repository organized. -* To learn more about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index). - -* To view a list of your repositories, see [cat repositories]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-repositories). - -* To view a list of your snapshots, see [cat snapshots]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-snapshots). +* For more information about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index). +* To view a list of your repositories, see [Cat Repositories]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-repositories). +* To view a list of your snapshots, see [Cat Snapshots]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-snapshots). @@ -84,5 +82,5 @@ Upon success, the response returns the following JSON object: } ``` -To verify that the snapshot was deleted, use the [Get snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot) API, passing the snapshot name as the `snapshot` path parameter. +To verify that the snapshot was deleted, use the [Get Snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot) API, passing the repository name and snapshot name as path parameters. {: .note} diff --git a/_api-reference/snapshots/get-snapshot-repository.md b/_api-reference/snapshots/get-snapshot-repository.md index 5ea36b17112..8c1f9076afc 100644 --- a/_api-reference/snapshots/get-snapshot-repository.md +++ b/_api-reference/snapshots/get-snapshot-repository.md @@ -1,27 +1,21 @@ --- layout: default -title: Get Snapshot Repository +title: Get snapshot repository parent: Snapshot APIs nav_order: 2 --- -# Get snapshot repository. +# Get snapshot repository **Introduced 1.0** {: .label .label-purple } -Retrieves information about a snapshot repository. +The Get Snapshot Repository API retrieves information about one or more snapshot repositories in your OpenSearch cluster. -To learn more about repositories, see [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository). +For more information about repositories, see [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository). -You can also get details about a snapshot during and after snapshot creation. See [Get snapshot status]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-status/). +You can also get details about a snapshot during and after snapshot creation. See [Get Snapshot Status]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-status/). {: .note} -## Endpoints - -```json -GET /_snapshot/ -``` - ## Query parameters @@ -60,7 +55,6 @@ The following table lists the available query parameters. All query parameters a | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | | `local` | Boolean | Whether to get information from the local node. _(Default: `false`)_ | -| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ Explicit operation timeout for connection to cluster-manager node | @@ -91,52 +85,45 @@ Upon success, the response returns repositry information. This sample is for an } ```` - ## Response body fields -The response body is a JSON object with the following fields. +The response body is a JSON object where each key is a repository name and each value contains information about that repository. + +For each repository, the response includes the following fields: | Property | Data type | Description | | :--- | :--- | :--- | -| `-- freeform field --` | Object | The name of the repository to store the snapshot. | +| `type` | String | The type of the snapshot repository (e.g., `fs` or `s3`). | +| `settings` | Object | The settings configured for the snapshot repository. | +| `uuid` | String | The universally unique identifier for the repository, if applicable. | -
+
- Response body fields: -- freeform field -- + Repository settings fields {: .text-delta} -The name of the repository to store the snapshot. +The `settings` object contains fields specific to the repository type: -`-- freeform field --` is a JSON object with the following fields. +**For `fs` repositories:** | Property | Data type | Description | | :--- | :--- | :--- | -| `settings` | Object | The settings for the snapshot repository. | -| `type` | String | The type of the snapshot repository. | -| `uuid` | String | The universally unique identifier. | +| `location` | String | The file system location where snapshots are stored. | +| `chunk_size` | String | The chunk size used for the repository. | +| `compress` | Boolean | Whether metadata files are compressed. | +| `readonly` | Boolean | Whether the repository is read-only. | -
-
- - Response body fields: -- freeform field -- > settings - - {: .text-delta} - -The settings for the snapshot repository. - -`settings` is a JSON object with the following fields. +**For `s3` repositories:** | Property | Data type | Description | | :--- | :--- | :--- | -| `chunk_size` | String | The chunk size for the repository. | -| `compress` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `concurrent_streams` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `location` | String | The location where snapshots are stored. | -| `read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | +| `bucket` | String | The S3 bucket name. | +| `base_path` | String | The path within the bucket where snapshots are stored. | +| `chunk_size` | String | The chunk size used for the repository. | +| `compress` | Boolean | Whether metadata files are compressed. | +| `readonly` | Boolean | Whether the repository is read-only. | + +Additional settings may be present depending on the repository configuration.
- diff --git a/_api-reference/snapshots/get-snapshot-status.md b/_api-reference/snapshots/get-snapshot-status.md index 130e28fdc84..d40182654cb 100644 --- a/_api-reference/snapshots/get-snapshot-status.md +++ b/_api-reference/snapshots/get-snapshot-status.md @@ -1,6 +1,6 @@ --- layout: default -title: Get Snapshot Status +title: Get snapshot status parent: Snapshot APIs nav_order: 8 --- @@ -9,18 +9,13 @@ nav_order: 8 **Introduced 1.0** {: .label .label-purple } -Returns details about a snapshot’s state during and after snapshot creation. +The Get Snapshot Status API returns detailed information about a snapshot's state during and after snapshot creation. This API is useful for monitoring snapshot progress and troubleshooting issues. -To learn about snapshot creation, see [Create snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-snapshot). +For information about creating snapshots, see [Create Snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-snapshot). If you use the Security plugin, you must have the `monitor_snapshot`, `create_snapshot`, or `manage cluster` privileges. {: .note} -## Endpoints - -```json -GET _snapshot///_status -``` ## Query parameters @@ -62,7 +58,6 @@ The following table lists the available query parameters. All query parameters a | :--- | :--- | :--- | | `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | | `ignore_unavailable` | Boolean | Whether to ignore any unavailable snapshots, When `false`, a `SnapshotMissingException` is thrown. _(Default: `false`)_ | -| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ Explicit operation timeout for connection to cluster-manager node | @@ -80,608 +75,156 @@ GET _snapshot/my-opensearch-repo/my-first-snapshot/_status ## Example response -The example that follows corresponds to the request above in the [Example request](#example-request) section. +The following response shows detailed information about the snapshot's status: -The `GET _snapshot/my-opensearch-repo/my-first-snapshot/_status` request returns the following fields: - -````json +```json { - "snapshots" : [ + "snapshots": [ { - "snapshot" : "my-first-snapshot", - "repository" : "my-opensearch-repo", - "uuid" : "dCK4Qth-TymRQ7Tu7Iga0g", - "state" : "SUCCESS", - "include_global_state" : true, - "shards_stats" : { - "initializing" : 0, - "started" : 0, - "finalizing" : 0, - "done" : 7, - "failed" : 0, - "total" : 7 + "snapshot": "my-first-snapshot", + "repository": "my-opensearch-repo", + "uuid": "dCK4Qth-TymRQ7Tu7Iga0g", + "state": "SUCCESS", + "include_global_state": true, + "shards_stats": { + "initializing": 0, + "started": 0, + "finalizing": 0, + "done": 7, + "failed": 0, + "total": 7 }, - "stats" : { - "incremental" : { - "file_count" : 31, - "size_in_bytes" : 24488927 + "stats": { + "incremental": { + "file_count": 31, + "size_in_bytes": 24488927 }, - "total" : { - "file_count" : 31, - "size_in_bytes" : 24488927 + "total": { + "file_count": 31, + "size_in_bytes": 24488927 }, - "start_time_in_millis" : 1660666841667, - "time_in_millis" : 14054 + "start_time_in_millis": 1660666841667, + "time_in_millis": 14054 }, - "indices" : { - ".opensearch-observability" : { - "shards_stats" : { - "initializing" : 0, - "started" : 0, - "finalizing" : 0, - "done" : 1, - "failed" : 0, - "total" : 1 - }, - "stats" : { - "incremental" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "total" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "start_time_in_millis" : 1660666841868, - "time_in_millis" : 201 - }, - "shards" : { - "0" : { - "stage" : "DONE", - "stats" : { - "incremental" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "total" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "start_time_in_millis" : 1660666841868, - "time_in_millis" : 201 - } - } - } - }, - "shakespeare" : { - "shards_stats" : { - "initializing" : 0, - "started" : 0, - "finalizing" : 0, - "done" : 1, - "failed" : 0, - "total" : 1 - }, - "stats" : { - "incremental" : { - "file_count" : 4, - "size_in_bytes" : 18310117 - }, - "total" : { - "file_count" : 4, - "size_in_bytes" : 18310117 - }, - "start_time_in_millis" : 1660666842470, - "time_in_millis" : 13050 - }, - "shards" : { - "0" : { - "stage" : "DONE", - "stats" : { - "incremental" : { - "file_count" : 4, - "size_in_bytes" : 18310117 - }, - "total" : { - "file_count" : 4, - "size_in_bytes" : 18310117 - }, - "start_time_in_millis" : 1660666842470, - "time_in_millis" : 13050 - } - } - } - }, - "opensearch_dashboards_sample_data_flights" : { - "shards_stats" : { - "initializing" : 0, - "started" : 0, - "finalizing" : 0, - "done" : 1, - "failed" : 0, - "total" : 1 - }, - "stats" : { - "incremental" : { - "file_count" : 10, - "size_in_bytes" : 6132245 - }, - "total" : { - "file_count" : 10, - "size_in_bytes" : 6132245 - }, - "start_time_in_millis" : 1660666843476, - "time_in_millis" : 6221 - }, - "shards" : { - "0" : { - "stage" : "DONE", - "stats" : { - "incremental" : { - "file_count" : 10, - "size_in_bytes" : 6132245 - }, - "total" : { - "file_count" : 10, - "size_in_bytes" : 6132245 - }, - "start_time_in_millis" : 1660666843476, - "time_in_millis" : 6221 - } - } - } - }, - ".opendistro-reports-definitions" : { - "shards_stats" : { - "initializing" : 0, - "started" : 0, - "finalizing" : 0, - "done" : 1, - "failed" : 0, - "total" : 1 - }, - "stats" : { - "incremental" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "total" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "start_time_in_millis" : 1660666843076, - "time_in_millis" : 200 - }, - "shards" : { - "0" : { - "stage" : "DONE", - "stats" : { - "incremental" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "total" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "start_time_in_millis" : 1660666843076, - "time_in_millis" : 200 - } - } - } - }, - ".opendistro-reports-instances" : { - "shards_stats" : { - "initializing" : 0, - "started" : 0, - "finalizing" : 0, - "done" : 1, - "failed" : 0, - "total" : 1 - }, - "stats" : { - "incremental" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "total" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "start_time_in_millis" : 1660666841667, - "time_in_millis" : 201 + "indices": { + ".opensearch-observability": { + "shards_stats": { + "initializing": 0, + "started": 0, + "finalizing": 0, + "done": 1, + "failed": 0, + "total": 1 }, - "shards" : { - "0" : { - "stage" : "DONE", - "stats" : { - "incremental" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "total" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "start_time_in_millis" : 1660666841667, - "time_in_millis" : 201 - } - } - } - }, - ".kibana_1" : { - "shards_stats" : { - "initializing" : 0, - "started" : 0, - "finalizing" : 0, - "done" : 1, - "failed" : 0, - "total" : 1 - }, - "stats" : { - "incremental" : { - "file_count" : 13, - "size_in_bytes" : 45733 + "stats": { + "incremental": { + "file_count": 1, + "size_in_bytes": 208 }, - "total" : { - "file_count" : 13, - "size_in_bytes" : 45733 + "total": { + "file_count": 1, + "size_in_bytes": 208 }, - "start_time_in_millis" : 1660666842673, - "time_in_millis" : 2007 + "start_time_in_millis": 1660666841868, + "time_in_millis": 201 }, - "shards" : { - "0" : { - "stage" : "DONE", - "stats" : { - "incremental" : { - "file_count" : 13, - "size_in_bytes" : 45733 + "shards": { + "0": { + "stage": "DONE", + "stats": { + "incremental": { + "file_count": 1, + "size_in_bytes": 208 }, - "total" : { - "file_count" : 13, - "size_in_bytes" : 45733 + "total": { + "file_count": 1, + "size_in_bytes": 208 }, - "start_time_in_millis" : 1660666842673, - "time_in_millis" : 2007 - } - } - } - }, - ".opensearch-notifications-config" : { - "shards_stats" : { - "initializing" : 0, - "started" : 0, - "finalizing" : 0, - "done" : 1, - "failed" : 0, - "total" : 1 - }, - "stats" : { - "incremental" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "total" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "start_time_in_millis" : 1660666842270, - "time_in_millis" : 200 - }, - "shards" : { - "0" : { - "stage" : "DONE", - "stats" : { - "incremental" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "total" : { - "file_count" : 1, - "size_in_bytes" : 208 - }, - "start_time_in_millis" : 1660666842270, - "time_in_millis" : 200 + "start_time_in_millis": 1660666841868, + "time_in_millis": 201 } } } } + // Additional indices data omitted for brevity } } ] } -```` +``` - ## Response body fields -The response body is a JSON object with the following fields. +The response body is a JSON object with the following fields: | Property | Required | Data type | Description | | :--- | :--- | :--- | :--- | -| `snapshots` | **Required** | Array of Objects | | - -
- - Response body fields: snapshots - - {: .text-delta} +| `snapshots` | **Required** | Array of Objects | Array of snapshot status objects. | -`snapshots` is an __array of JSON objects__ (NDJSON). Each object has the following fields. +Each snapshot object in the `snapshots` array contains the following information: | Property | Data type | Description | | :--- | :--- | :--- | -| `include_global_state` | Boolean | Whether the snapshot includes the cluster state. | -| `indices` | Object | The status of indexes in the snapshot. | -| `repository` | String | The name of the repository containing the snapshot. | -| `shards_stats` | Object | The statistics about snapshot shards. | | `snapshot` | String | The name of the snapshot. | -| `state` | String | The current state of the snapshot. | -| `stats` | Object | The detailed statistics about the snapshot. | -| `uuid` | String | The universally unique identifier. | - -
-
- - Response body fields: snapshots > indices - - {: .text-delta} - -The status of indexes in the snapshot. - -`indices` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | - -
-
- - Response body fields: snapshots > indices > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `shards` | Object | The status of individual shards in the snapshot. | -| `shards_stats` | Object | The statistics about snapshot shards. | -| `stats` | Object | The detailed statistics about the snapshot. | - -
-
- - Response body fields: snapshots > indices > -- freeform field -- > shards - - {: .text-delta} - -The status of individual shards in the snapshot. - -`shards` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | - -
-
- - Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `stage` | **Required** | String | The current stage of the shard snapshot.
Valid values are:
- `DONE`: The number of shards in the snapshot that were successfully stored in the repository.
- `FAILURE`: The number of shards in the snapshot that were not successfully stored in the repository.
- `FINALIZE`: The number of shards in the snapshot that are in the finalizing stage of being stored in the repository.
- `INIT`: The number of shards in the snapshot that are in the initializing stage of being stored in the repository.
- `STARTED`: The number of shards in the snapshot that are in the started stage of being stored in the repository. | -| `stats` | **Required** | Object | The statistical summary of the shard snapshot. | -| `node` | _Optional_ | String | The unique identifier of a node. | -| `reason` | _Optional_ | String | The reason for the current shard status. | - -
-
- - Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- > stats - - {: .text-delta} - -The statistical summary of the shard snapshot. - -`stats` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `incremental` | Object | The incremental statistics for the shard snapshot. | -| `processed` | Object | The processed statistics for the shard snapshot. | -| `start_time_in_millis` | Integer | The time unit for milliseconds. | -| `time` | String | 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. | -| `time_in_millis` | Integer | The time unit for milliseconds. | -| `total` | Object | The total statistics for the shard snapshot. | - -
-
- - Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- > stats > incremental - - {: .text-delta} - -The incremental statistics for the shard snapshot. - -`incremental` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `file_count` | Integer | The number of files in the shard snapshot. | -| `size_in_bytes` | Integer | The size in bytes. | - -
-
- - Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- > stats > processed - - {: .text-delta} - -The processed statistics for the shard snapshot. - -`processed` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `file_count` | Integer | The number of files in the shard snapshot. | -| `size_in_bytes` | Integer | The size in bytes. | - -
-
- - Response body fields: snapshots > indices > -- freeform field -- > shards > -- freeform field -- > stats > total - - {: .text-delta} - -The total statistics for the shard snapshot. - -`total` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `file_count` | Integer | The number of files in the shard snapshot. | -| `size_in_bytes` | Integer | The size in bytes. | - -
-
- - Response body fields: snapshots > indices > -- freeform field -- > shards_stats - - {: .text-delta} - -The statistics about snapshot shards. - -`shards_stats` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `done` | Integer | The number of completed shard snapshots. | -| `failed` | Integer | The number of failed shard snapshots. | -| `finalizing` | Integer | The number of finalizing shard snapshots. | -| `initializing` | Integer | The number of initializing shard snapshots. | -| `started` | Integer | The number of started shard snapshots. | -| `total` | Integer | The total number of shard snapshots. | +| `repository` | String | The name of the repository containing the snapshot. | +| `uuid` | String | The universally unique identifier for the snapshot. | +| `state` | String | The current state of the snapshot. Possible values include `IN_PROGRESS`, `SUCCESS`, `FAILED`, and `PARTIAL`. | +| `include_global_state` | Boolean | Whether the snapshot includes the cluster state. | +| `shards_stats` | Object | Statistics about snapshot shards. | +| `stats` | Object | Detailed statistics about the snapshot. | +| `indices` | Object | Status of indexes included in the snapshot. | -
-
+
- Response body fields: snapshots > indices > -- freeform field -- > stats + Shard stats fields {: .text-delta} -The detailed statistics about the snapshot. - -`stats` is a JSON object with the following fields. +The `shards_stats` object contains the following fields: | Property | Data type | Description | | :--- | :--- | :--- | -| `incremental` | Object | The incremental statistics for the snapshot. | -| `processed` | Object | The processed statistics for the snapshot. | -| `start_time_in_millis` | Integer | The time unit for milliseconds. | -| `time` | String | 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. | -| `time_in_millis` | Integer | The time unit for milliseconds. | -| `total` | Object | The total statistics for the snapshot. | +| `initializing` | Integer | The number of shards in the initial stage of being stored in the repository. | +| `started` | Integer | The number of shards that have started but not completed storing data. | +| `finalizing` | Integer | The number of shards in the finalizing stage of being stored. | +| `done` | Integer | The number of shards successfully stored in the repository. | +| `failed` | Integer | The number of shards that failed to be stored in the repository. | +| `total` | Integer | The total number of shards in the snapshot. |
-
- - Response body fields: snapshots > indices > -- freeform field -- > stats > incremental - - {: .text-delta} - -The incremental statistics for the snapshot. - -`incremental` is a JSON object with the following fields. -| Property | Data type | Description | -| :--- | :--- | :--- | -| `file_count` | Integer | The number of files in the snapshot. | -| `size_in_bytes` | Integer | The size in bytes. | - -
-
+
- Response body fields: snapshots > indices > -- freeform field -- > stats > processed + Snapshot statistics fields {: .text-delta} -The processed statistics for the snapshot. - -`processed` is a JSON object with the following fields. +The `stats` object contains the following fields: | Property | Data type | Description | | :--- | :--- | :--- | -| `file_count` | Integer | The number of files in the snapshot. | -| `size_in_bytes` | Integer | The size in bytes. | +| `incremental` | Object | Statistics about incremental snapshot data, including `file_count` and `size_in_bytes`. | +| `total` | Object | Statistics about total snapshot data, including `file_count` and `size_in_bytes`. | +| `start_time_in_millis` | Integer | The time (in milliseconds) when the snapshot process began. | +| `time_in_millis` | Integer | Total time (in milliseconds) the snapshot process took. |
-
- - Response body fields: snapshots > indices > -- freeform field -- > stats > total - - {: .text-delta} - -The total statistics for the snapshot. - -`total` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `file_count` | Integer | The number of files in the snapshot. | -| `size_in_bytes` | Integer | The size in bytes. | -
-
+
- Response body fields: snapshots > shards_stats + Index details fields {: .text-delta} -The statistics about snapshot shards. - -`shards_stats` is a JSON object with the following fields. +For each index in the `indices` object, the response includes: | Property | Data type | Description | | :--- | :--- | :--- | -| `done` | Integer | The number of completed shard snapshots. | -| `failed` | Integer | The number of failed shard snapshots. | -| `finalizing` | Integer | The number of finalizing shard snapshots. | -| `initializing` | Integer | The number of initializing shard snapshots. | -| `started` | Integer | The number of started shard snapshots. | -| `total` | Integer | The total number of shard snapshots. | +| `shards_stats` | Object | Statistics about index shards, including counts for various states. | +| `stats` | Object | Detailed statistics about the index snapshot. | +| `shards` | Object | Information about individual shards, including their stage and statistics. |
-
- - Response body fields: snapshots > stats - - {: .text-delta} - -The detailed statistics about the snapshot. -`stats` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `incremental` | Object | The incremental statistics for the snapshot. | -| `processed` | Object | The processed statistics for the snapshot. | -| `start_time_in_millis` | Integer | The time unit for milliseconds. | -| `time` | String | 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. | -| `time_in_millis` | Integer | The time unit for milliseconds. | -| `total` | Object | The total statistics for the snapshot. | - -
- diff --git a/_api-reference/snapshots/get-snapshot.md b/_api-reference/snapshots/get-snapshot.md index e38c8730a6d..dbd8dc159bf 100644 --- a/_api-reference/snapshots/get-snapshot.md +++ b/_api-reference/snapshots/get-snapshot.md @@ -5,17 +5,14 @@ parent: Snapshot APIs nav_order: 6 --- -# Get snapshot. +# Get snapshot **Introduced 1.0** {: .label .label-purple } -Retrieves information about a snapshot. +The Get Snapshot API retrieves information about one or more snapshots within a repository. This information includes details about snapshot creation, included indices, and status. -## Endpoints - -```json -GET _snapshot/// -``` +* For more information about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index). +* To view a list of your repositories, see [Get Snapshot Repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository). ## Query parameters @@ -57,7 +55,6 @@ The following table lists the available query parameters. All query parameters a | `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | | `ignore_unavailable` | Boolean | When `false`, the request returns an error for any snapshots that are unavailable. _(Default: `false`)_ | | `verbose` | Boolean | When `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards contained in the snapshot. | -| `master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ 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. | @@ -69,19 +66,6 @@ component: request_body_parameters -## Path parameters - -| Parameter | Data type | Description | -| :--- | :--- | :--- | -| repository | String | The repository that contains the snapshot to retrieve. | -| snapshot | String | Snapshot to retrieve. - -## Query parameters - -| Parameter | Data type | Description | -:--- | :--- | :--- -| verbose | Boolean | Whether to show all, or just basic snapshot information. If `true`, returns all information. If `false`, omits information like start/end times, failures, and shards. Optional, defaults to `true`.| -| ignore_unavailable | Boolean | How to handle snapshots that are unavailable (corrupted or otherwise temporarily can't be returned). If `true` and the snapshot is unavailable, the request does not return the snapshot. If `false` and the snapshot is unavailable, the request returns an error. Optional, defaults to `false`.| ## Example request @@ -94,419 +78,112 @@ GET _snapshot/my-opensearch-repo/my-first-snapshot ## Example response -Upon success, the response returns snapshot information: - -````json +```json { - "snapshots" : [ + "snapshots": [ { - "snapshot" : "my-first-snapshot", - "uuid" : "3P7Qa-M8RU6l16Od5n7Lxg", - "version_id" : 136217927, - "version" : "2.0.1", - "indices" : [ - ".opensearch-observability", - ".opendistro-reports-instances", - ".opensearch-notifications-config", - "shakespeare", - ".opendistro-reports-definitions", - "opensearch_dashboards_sample_data_flights", - ".kibana_1" + "snapshot": "my-snapshot", + "uuid": "XYZ4Zv7cSnuYev2JpLMJGw", + "version_id": 136217927, + "version": "2.0.1", + "indices": [ + "index-1", + "index-2", + ".opensearch-observability" ], - "data_streams" : [ ], - "include_global_state" : true, - "state" : "SUCCESS", - "start_time" : "2022-08-11T20:30:00.399Z", - "start_time_in_millis" : 1660249800399, - "end_time" : "2022-08-11T20:30:14.851Z", - "end_time_in_millis" : 1660249814851, - "duration_in_millis" : 14452, - "failures" : [ ], - "shards" : { - "total" : 7, - "failed" : 0, - "successful" : 7 + "data_streams": [], + "include_global_state": true, + "state": "SUCCESS", + "start_time": "2022-08-10T16:52:15.277Z", + "start_time_in_millis": 1660150335277, + "end_time": "2022-08-10T16:52:18.699Z", + "end_time_in_millis": 1660150338699, + "duration_in_millis": 3422, + "failures": [], + "shards": { + "total": 5, + "failed": 0, + "successful": 5 } } ] } -```` +``` - ## Response body fields -The response body is a JSON object with the following fields. +The response body is a JSON object with the following fields: | Property | Required | Data type | Description | | :--- | :--- | :--- | :--- | -| `snapshots` | **Required** | Array of Objects | | +| `snapshots` | **Required** | Array of Objects | Array of snapshot status objects. | -
- - Response body fields: snapshots - - {: .text-delta} - -`snapshots` is an __array of JSON objects__ (NDJSON). Each object has the following fields. +Each snapshot object in the `snapshots` array contains the following information: | Property | Data type | Description | | :--- | :--- | :--- | +| `snapshot` | String | The name of the snapshot. | +| `repository` | String | The name of the repository containing the snapshot. | +| `uuid` | String | The universally unique identifier for the snapshot. | +| `version_id` | Integer | The build ID of the OpenSearch version that created the snapshot. | +| `version` | String | The OpenSearch version that created the snapshot. | +| `indices` | Array of Strings | The list of indices included in the snapshot. | | `data_streams` | Array of Strings | The list of data streams included in the snapshot. | -| `duration` | String | 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. | -| `duration_in_millis` | Integer | The time unit for milliseconds. | -| `end_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | -| `end_time_in_millis` | Integer | The time unit for milliseconds. | -| `failures` | Array of Objects | The list of shard failures that occurred during the snapshot. | +| `state` | String | The current state of the snapshot. Possible values include `IN_PROGRESS`, `SUCCESS`, `FAILED`, and `PARTIAL`. | | `include_global_state` | Boolean | Whether the snapshot includes the cluster state. | -| `indices` | Array of Strings | The list of indexes included in the snapshot. | -| `metadata` | Object | The custom metadata attached to a resource. | -| `pinned_timestamp` | Integer | The time unit for milliseconds. | -| `reason` | String | The reason for the snapshot creation. | -| `remote_store_index_shallow_copy` | Boolean | Whether the snapshot uses remote store index shallow copy. | -| `shards` | Object | The statistics about the shards included in the snapshot. | -| `snapshot` | String | The name of a resource or configuration element. | -| `start_time` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | -| `start_time_in_millis` | Integer | The time unit for milliseconds. | -| `state` | String | The current state of the snapshot. | -| `uuid` | String | The universally unique identifier. | -| `version` | String | The version of OpenSearch when the snapshot was created. | -| `version_id` | Integer | The internal version number of OpenSearch when the snapshot was created. | +| `start_time` | String | The date and time when the snapshot creation process began. | +| `start_time_in_millis` | Long | The time (in milliseconds) when the snapshot creation process began. | +| `end_time` | String | The date and time when the snapshot creation process ended. | +| `end_time_in_millis` | Long | The time (in milliseconds) when the snapshot creation process ended. | +| `duration_in_millis` | Long | The total time (in milliseconds) that the snapshot creation process lasted. | +| `failures` | Array of Objects | Any failures that occurred during snapshot creation. | +| `shards` | Object | Statistics about the shards included in the snapshot. | -
-
+
- Response body fields: snapshots > end_time + Shard stats fields {: .text-delta} -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`end_time` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | +The `shards` object contains the following fields: | Property | Data type | Description | | :--- | :--- | :--- | +| `total` | Integer | The total number of shards included in the snapshot. | +| `failed` | Integer | The number of shards that failed to be stored in the repository. | +| `successful` | Integer | The number of shards successfully stored in the repository. |
-
- - Response body fields: snapshots > end_time - - {: .text-delta} -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`end_time` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
+
- Response body fields: snapshots > end_time + Snapshot statistics fields {: .text-delta} -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`end_time` is a JSON object with the following fields. +The `stats` object contains the following fields: | Property | Data type | Description | | :--- | :--- | :--- | +| `incremental` | Object | Statistics about incremental snapshot data, including `file_count` and `size_in_bytes`. | +| `total` | Object | Statistics about total snapshot data, including `file_count` and `size_in_bytes`. | +| `start_time_in_millis` | Integer | The time (in milliseconds) when the snapshot process began. | +| `time_in_millis` | Integer | Total time (in milliseconds) the snapshot process took. |
-
- - Response body fields: snapshots > failures - - {: .text-delta} - -The list of shard failures that occurred during the snapshot. - -`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. -| Property | Data type | Description | -| :--- | :--- | :--- | -| `index` | String | The name of the index containing the failed shard. | -| `node_id` | String | The unique identifier for a resource. | -| `reason` | String | The reason for the shard failure. | -| `shard_id` | String | The unique identifier for a resource. | -| `status` | String | The status of the failed shard. | - -
-
+
- Response body fields: snapshots > metadata + Index details fields {: .text-delta} -The custom metadata attached to a resource. - -`metadata` is a JSON object with the following fields. +For each index in the `indices` object, the response includes: | Property | Data type | Description | | :--- | :--- | :--- | -| `-- freeform field --` | Object | | +| `shards_stats` | Object | Statistics about index shards, including counts for various states. | +| `stats` | Object | Detailed statistics about the index snapshot. | +| `shards` | Object | Information about individual shards, including their stage and statistics. |
-
- - Response body fields: snapshots > metadata > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshots > shards - - {: .text-delta} - -The statistics about the shards included in the snapshot. - -`shards` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `failed` | **Required** | Integer | | -| `successful` | **Required** | Integer | | -| `total` | **Required** | Integer | | -| `failures` | _Optional_ | Array of Objects | | -| `skipped` | _Optional_ | Integer | | - -
-
- - Response body fields: snapshots > shards > failures - - {: .text-delta} - -`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `reason` | **Required** | Object | | -| `shard` | **Required** | Integer | | -| `index` | _Optional_ | String | | -| `node` | _Optional_ | String | | -| `status` | _Optional_ | String | | - -
-
- - Response body fields: snapshots > shards > failures > reason - - {: .text-delta} - -`reason` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshots > shards > failures > reason > caused_by - - {: .text-delta} - -`caused_by` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshots > shards > failures > reason > caused_by > root_cause - - {: .text-delta} - -`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshots > shards > failures > reason > caused_by > root_cause > suppressed - - {: .text-delta} - -`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshots > shards > failures > reason > caused_by > root_cause > suppressed > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshots > shards > failures > reason > caused_by > root_cause > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshots > shards > failures > reason > caused_by > suppressed - - {: .text-delta} - -`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshots > shards > failures > reason > caused_by > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshots > shards > failures > reason > root_cause - - {: .text-delta} - -`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshots > shards > failures > reason > suppressed - - {: .text-delta} - -`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshots > shards > failures > reason > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshots > start_time - - {: .text-delta} - -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`start_time` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
- diff --git a/_api-reference/snapshots/restore-snapshot.md b/_api-reference/snapshots/restore-snapshot.md index c25d1c723fa..483e59aa714 100644 --- a/_api-reference/snapshots/restore-snapshot.md +++ b/_api-reference/snapshots/restore-snapshot.md @@ -61,5017 +61,64 @@ The following table lists the available query parameters. All query parameters a - -## Request body fields - -Determines which settings and indexes to restore when restoring a snapshot - -The request body is optional. It is a JSON object with the following fields. - -| Property | Data type | Description | Default | -| :--- | :--- | :--- | :--- | -| `ignore_index_settings` | Array of Strings | A comma-delimited list of index settings to ignore when restoring indexes from a snapshot. | N/A | -| `ignore_unavailable` | Boolean | How to handle data streams or indexes that are missing or closed. When `false`, the request returns an error for any data stream or index that is missing or closed. When `true`, the request ignores data streams and indexes in indexes that are missing or closed. | `false` | -| `include_aliases` | Boolean | How to handle index aliases from the original snapshot. When `true`, index aliases from the original snapshot are restored. When `false`, aliases along with associated indexes are not restored. | `true` | -| `include_global_state` | Boolean | Whether to restore the current cluster state. When `false`, the cluster state is not restored. When `true`, the current cluster state is restored. | `false` | -| `index_settings` | Object | The index settings to be updated. | N/A | -| `indices` | Array of Strings or String | 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`. | N/A | -| `partial` | Boolean | How the restore operation will behave if indexes in the snapshot do not have all primary shards available. When `false`, the entire restore operation fails if any indexes in the snapshot do not have all primary shards available. When `true`, allows the restoration of a partial snapshot of indexes with unavailable shards. Only shards that were successfully included in the snapshot are restored. All missing shards are recreated as empty. By default, the entire restore operation fails if one or more indexes included in the snapshot do not have all primary shards available. To change this behavior, set `partial` to `true`. | `false` | -| `rename_alias_pattern` | String | The pattern to apply to the restored aliases. Aliases matching the rename pattern will be renamed according to the `rename_alias_replacement` setting. The rename pattern is applied as defined by the regular expression that supports referencing the original text. If two or more aliases are renamed into the same name, these aliases will be merged into one. | N/A | -| `rename_alias_replacement` | String | The rename replacement string for aliases. | N/A | -| `rename_pattern` | String | The pattern to apply to the restored data streams and indexes. Data streams and indexes matching the rename pattern will be renamed according to the `rename_replacement` setting. The rename pattern is applied as defined by the regular expression that supports referencing the original text. The request fails if two or more data streams or indexes are renamed into the same name. If you rename a restored data stream, its backing indexes are also renamed. For example, if you rename the logs data stream to `recovered-logs`, the backing index `.ds-logs-1` is renamed to `.ds-recovered-logs-1`. If you rename a restored stream, ensure an index template matches the new stream name. If there are no matching index template names, the stream cannot roll over and new backing indexes are not created. | N/A | -| `rename_replacement` | String | The rename replacement string. | N/A | -| `source_remote_store_repository` | String | The name of the remote store repository of the source index being restored. If not provided, the Snapshot Restore API will use the repository that was registered when the snapshot was created. | N/A | -| `storage_type` | String | Where will be the authoritative store of the restored indexes' data. A value of `local` indicates that all snapshot metadata and index data will be downloaded to local storage. A value of `remote_snapshot` indicates that snapshot metadata will be downloaded to the cluster, but the remote repository will remain the authoritative store of the index data. Data will be downloaded and cached as necessary to service queries. At least one node in the cluster must be configured with the search role in order to restore a snapshot using the type `remote_snapshot`. | `local` | - -
- - Request body fields: index_settings - - {: .text-delta} - -The index settings to be updated. - -`index_settings` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | -| `analysis` | Object | | -| `analyze` | Object | | -| `analyze.max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `auto_expand_replicas` | String | | -| `blocks` | Object | | -| `blocks.metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `check_on_startup` | String | Valid values are: `checksum`, `false`, and `true`. | -| `codec` | String | | -| `composite_index.star_tree` | Object | | -| `creation_date` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `creation_date_string` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | -| `default_pipeline` | String | | -| `final_pipeline` | String | | -| `format` | Float or String | | -| `gc_deletes` | String | 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. | -| `hidden` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `highlight` | Object | | -| `highlight.max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `index` | Object | The index settings to be updated. | -| `indexing` | Object | | -| `indexing_pressure` | Object | | -| `knn` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `knn.algo_param.ef_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `lifecycle` | Object | | -| `lifecycle.name` | String | The name of a resource or configuration element. | -| `load_fixed_bitset_filters_eagerly` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `mapping` | Object | | -| `max_docvalue_fields_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_inner_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_ngram_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_refresh_listeners` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_regex_length` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_rescore_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_script_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_shingle_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_slices_per_scroll` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_terms_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `merge` | Object | | -| `merge.scheduler.max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `mode` | String | | -| `number_of_replicas` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `number_of_routing_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `number_of_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `priority` | Float or String | | -| `provided_name` | String | The name of a resource or configuration element. | -| `queries` | Object | | -| `query_string` | Object | | -| `query_string.lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `refresh_interval` | String | 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. | -| `routing` | Object | | -| `routing_partition_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `routing_path` | Array of Strings or String | | -| `search` | Object | | -| `search.idle.after` | String | 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. | -| `settings` | Object | The index settings to be updated. | -| `similarity` | Object | | -| `soft_deletes` | Object | | -| `soft_deletes.retention_lease.period` | String | 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. | -| `sort` | Object | | -| `store` | Object | | -| `top_metrics_max_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `translog` | Object | | -| `translog.durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | -| `translog.flush_threshold_size` | String | The unique identifier of a node. | -| `uuid` | String | The universally unique identifier. | -| `verified_before_close` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | Object | | - -
-
- - Request body fields: index_settings > analysis - - {: .text-delta} - -`analysis` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `analyzer` | Object | | -| `char_filter` | Object | | -| `filter` | Object | | -| `normalizer` | Object | | -| `tokenizer` | Object | | - -
-
- - Request body fields: index_settings > analysis > analyzer - - {: .text-delta} - -`analyzer` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `tokenizer` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `custom`. | -| `char_filter` | _Optional_ | Array of Strings | | -| `filter` | _Optional_ | Array of Strings | | -| `position_increment_gap` | _Optional_ | Integer | | -| `position_offset_gap` | _Optional_ | Integer | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `max_output_size` | **Required** | Integer | | -| `preserve_original` | **Required** | Boolean | | -| `separator` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `fingerprint`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keyword`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `language` | **Required** | String | Valid values are: `Arabic`, `Armenian`, `Basque`, `Brazilian`, `Bulgarian`, `Catalan`, `Chinese`, `Cjk`, `Czech`, `Danish`, `Dutch`, `English`, `Estonian`, `Finnish`, `French`, `Galician`, `German`, `Greek`, `Hindi`, `Hungarian`, `Indonesian`, `Irish`, `Italian`, `Latvian`, `Norwegian`, `Persian`, `Portuguese`, `Romanian`, `Russian`, `Sorani`, `Spanish`, `Swedish`, `Thai`, and `Turkish`. | -| `stem_exclusion` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `language`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `nori`. | -| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | -| `stoptags` | _Optional_ | Array of Strings | | -| `user_dictionary` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `pattern` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `pattern`. | -| `flags` | _Optional_ | String | | -| `lowercase` | _Optional_ | Boolean | | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `simple`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `standard`. | -| `max_token_length` | _Optional_ | Integer | | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stop`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `whitespace`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `method` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | -| `mode` | **Required** | String | Valid values are: `compose`, and `decompose`. | -| `type` | **Required** | String | Valid values are: `icu_analyzer`. | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | -| `type` | **Required** | String | Valid values are: `kuromoji`. | -| `user_dictionary` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | -| `type` | **Required** | String | Valid values are: `snowball`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `dutch`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `type` | String | Valid values are: `smartcn`. | - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `stopwords` | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | String | | -| `type` | String | Valid values are: `cjk`. | - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `phone-region` | String | Optional ISO 3166 country code, defaults to "ZZ" (unknown region). | -| `type` | String | Valid values are: `phone`, and `phone-search`. | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `tokenizer` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `custom`. | -| `char_filter` | _Optional_ | Array of Strings | | -| `filter` | _Optional_ | Array of Strings | | -| `position_increment_gap` | _Optional_ | Integer | | -| `position_offset_gap` | _Optional_ | Integer | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `max_output_size` | **Required** | Integer | | -| `preserve_original` | **Required** | Boolean | | -| `separator` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `fingerprint`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords - - {: .text-delta} - -Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - -`stopwords` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keyword`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `language` | **Required** | String | Valid values are: `Arabic`, `Armenian`, `Basque`, `Brazilian`, `Bulgarian`, `Catalan`, `Chinese`, `Cjk`, `Czech`, `Danish`, `Dutch`, `English`, `Estonian`, `Finnish`, `French`, `Galician`, `German`, `Greek`, `Hindi`, `Hungarian`, `Indonesian`, `Irish`, `Italian`, `Latvian`, `Norwegian`, `Persian`, `Portuguese`, `Romanian`, `Russian`, `Sorani`, `Spanish`, `Swedish`, `Thai`, and `Turkish`. | -| `stem_exclusion` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `language`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords - - {: .text-delta} - -Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - -`stopwords` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `nori`. | -| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | -| `stoptags` | _Optional_ | Array of Strings | | -| `user_dictionary` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `pattern` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `pattern`. | -| `flags` | _Optional_ | String | | -| `lowercase` | _Optional_ | Boolean | | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords - - {: .text-delta} - -Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - -`stopwords` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `simple`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `standard`. | -| `max_token_length` | _Optional_ | Integer | | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords - - {: .text-delta} - -Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - -`stopwords` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stop`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords - - {: .text-delta} - -Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - -`stopwords` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `whitespace`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `method` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | -| `mode` | **Required** | String | Valid values are: `compose`, and `decompose`. | -| `type` | **Required** | String | Valid values are: `icu_analyzer`. | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | -| `type` | **Required** | String | Valid values are: `kuromoji`. | -| `user_dictionary` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | -| `type` | **Required** | String | Valid values are: `snowball`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords - - {: .text-delta} - -Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - -`stopwords` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `dutch`. | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords - - {: .text-delta} - -Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - -`stopwords` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `type` | String | Valid values are: `smartcn`. | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `stopwords` | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | String | | -| `type` | String | Valid values are: `cjk`. | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- > stopwords - - {: .text-delta} - -Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - -`stopwords` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > analyzer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `phone-region` | String | Optional ISO 3166 country code, defaults to "ZZ" (unknown region). | -| `type` | String | Valid values are: `phone`, and `phone-search`. | - -
-
- - Request body fields: index_settings > analysis > char_filter - - {: .text-delta} - -`char_filter` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object or String | | - -
-
- - Request body fields: index_settings > analysis > char_filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `html_strip`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `mapping`. | -| `mappings` | _Optional_ | Array of Strings | | -| `mappings_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `pattern` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `pattern_replace`. | -| `flags` | _Optional_ | String | | -| `replacement` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `icu_normalizer`. | -| `mode` | _Optional_ | String | Valid values are: `compose`, and `decompose`. | -| `name` | _Optional_ | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `normalize_kana` | **Required** | Boolean | | -| `normalize_kanji` | **Required** | Boolean | | -| `type` | **Required** | String | Valid values are: `kuromoji_iteration_mark`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > char_filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > char_filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `html_strip`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `mapping`. | -| `mappings` | _Optional_ | Array of Strings | | -| `mappings_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `pattern` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `pattern_replace`. | -| `flags` | _Optional_ | String | | -| `replacement` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `icu_normalizer`. | -| `mode` | _Optional_ | String | Valid values are: `compose`, and `decompose`. | -| `name` | _Optional_ | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `normalize_kana` | **Required** | Boolean | | -| `normalize_kanji` | **Required** | Boolean | | -| `type` | **Required** | String | Valid values are: `kuromoji_iteration_mark`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > char_filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `html_strip`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > char_filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `mapping`. | -| `mappings` | _Optional_ | Array of Strings | | -| `mappings_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > char_filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `pattern` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `pattern_replace`. | -| `flags` | _Optional_ | String | | -| `replacement` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > char_filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `icu_normalizer`. | -| `mode` | _Optional_ | String | Valid values are: `compose`, and `decompose`. | -| `name` | _Optional_ | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > char_filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `normalize_kana` | **Required** | Boolean | | -| `normalize_kanji` | **Required** | Boolean | | -| `type` | **Required** | String | Valid values are: `kuromoji_iteration_mark`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter - - {: .text-delta} - -`filter` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object or String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `asciifolding`. | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `common_grams`. | -| `common_words` | _Optional_ | Array of Strings | | -| `common_words_path` | _Optional_ | String | | -| `ignore_case` | _Optional_ | Boolean | | -| `query_mode` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `filter` | **Required** | Array of Strings | | -| `script` | **Required** | Object or Object or String | | -| `type` | **Required** | String | Valid values are: `condition`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `delimited_payload`. | -| `delimiter` | _Optional_ | String | | -| `encoding` | _Optional_ | String | Valid values are: `float`, `identity`, and `int`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `edge_ngram`. | -| `max_gram` | _Optional_ | Integer | | -| `min_gram` | _Optional_ | Integer | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `side` | _Optional_ | String | Valid values are: `back`, and `front`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `elision`. | -| `articles` | _Optional_ | Array of Strings | | -| `articles_case` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `articles_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `fingerprint`. | -| `max_output_size` | _Optional_ | Integer | | -| `separator` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `locale` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `hunspell`. | -| `dedup` | _Optional_ | Boolean | | -| `dictionary` | _Optional_ | String | | -| `longest_only` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `hyphenation_decompounder`. | -| `hyphenation_patterns_path` | _Optional_ | String | | -| `max_subword_size` | _Optional_ | Integer | | -| `min_subword_size` | _Optional_ | Integer | | -| `min_word_size` | _Optional_ | Integer | | -| `only_longest_match` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | -| `word_list` | _Optional_ | Array of Strings | | -| `word_list_path` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keep_types`. | -| `mode` | _Optional_ | String | Valid values are: `exclude`, and `include`. | -| `types` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keep`. | -| `keep_words` | _Optional_ | Array of Strings | | -| `keep_words_case` | _Optional_ | Boolean | | -| `keep_words_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keyword_marker`. | -| `ignore_case` | _Optional_ | Boolean | | -| `keywords` | _Optional_ | Array of Strings | | -| `keywords_path` | _Optional_ | String | | -| `keywords_pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `kstem`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `length`. | -| `max` | _Optional_ | Integer | | -| `min` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `limit`. | -| `consume_all_tokens` | _Optional_ | Boolean | | -| `max_token_count` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `lowercase`. | -| `language` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `filters` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `multiplexer`. | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `ngram`. | -| `max_gram` | _Optional_ | Integer | | -| `min_gram` | _Optional_ | Integer | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `nori_part_of_speech`. | -| `stoptags` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `patterns` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `pattern_capture`. | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `pattern` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `pattern_replace`. | -| `all` | _Optional_ | Boolean | | -| `flags` | _Optional_ | String | | -| `replacement` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `persian_stem`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `porter_stem`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `script` | **Required** | Object or Object or String | | -| `type` | **Required** | String | Valid values are: `predicate_token_filter`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `remove_duplicates`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `reverse`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `shingle`. | -| `filler_token` | _Optional_ | String | | -| `max_shingle_size` | _Optional_ | Float or String | | -| `min_shingle_size` | _Optional_ | Float or String | | -| `output_unigrams` | _Optional_ | Boolean | | -| `output_unigrams_if_no_shingles` | _Optional_ | Boolean | | -| `token_separator` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | -| `type` | **Required** | String | Valid values are: `snowball`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stemmer_override`. | -| `rules` | _Optional_ | Array of Strings | | -| `rules_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stemmer`. | -| `language` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stop`. | -| `ignore_case` | _Optional_ | Boolean | | -| `remove_trailing` | _Optional_ | Boolean | | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `synonym_graph`. | -| `expand` | _Optional_ | Boolean | | -| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | -| `lenient` | _Optional_ | Boolean | | -| `synonyms` | _Optional_ | Array of Strings | | -| `synonyms_path` | _Optional_ | String | | -| `tokenizer` | _Optional_ | String | | -| `updateable` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `synonym`. | -| `expand` | _Optional_ | Boolean | | -| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | -| `lenient` | _Optional_ | Boolean | | -| `synonyms` | _Optional_ | Array of Strings | | -| `synonyms_path` | _Optional_ | String | | -| `tokenizer` | _Optional_ | String | | -| `updateable` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `trim`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `truncate`. | -| `length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `unique`. | -| `only_on_same_position` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `uppercase`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `word_delimiter_graph`. | -| `adjust_offsets` | _Optional_ | Boolean | | -| `catenate_all` | _Optional_ | Boolean | | -| `catenate_numbers` | _Optional_ | Boolean | | -| `catenate_words` | _Optional_ | Boolean | | -| `generate_number_parts` | _Optional_ | Boolean | | -| `generate_word_parts` | _Optional_ | Boolean | | -| `ignore_keywords` | _Optional_ | Boolean | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `protected_words` | _Optional_ | Array of Strings | | -| `protected_words_path` | _Optional_ | String | | -| `split_on_case_change` | _Optional_ | Boolean | | -| `split_on_numerics` | _Optional_ | Boolean | | -| `stem_english_possessive` | _Optional_ | Boolean | | -| `type_table` | _Optional_ | Array of Strings | | -| `type_table_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `word_delimiter`. | -| `catenate_all` | _Optional_ | Boolean | | -| `catenate_numbers` | _Optional_ | Boolean | | -| `catenate_words` | _Optional_ | Boolean | | -| `generate_number_parts` | _Optional_ | Boolean | | -| `generate_word_parts` | _Optional_ | Boolean | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `protected_words` | _Optional_ | Array of Strings | | -| `protected_words_path` | _Optional_ | String | | -| `split_on_case_change` | _Optional_ | Boolean | | -| `split_on_numerics` | _Optional_ | Boolean | | -| `stem_english_possessive` | _Optional_ | Boolean | | -| `type_table` | _Optional_ | Array of Strings | | -| `type_table_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `minimum_length` | **Required** | Integer | | -| `type` | **Required** | String | Valid values are: `kuromoji_stemmer`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `kuromoji_readingform`. | -| `use_romaji` | **Required** | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `stoptags` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `kuromoji_part_of_speech`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `rule_files` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `icu_collation`. | -| `alternate` | _Optional_ | String | Valid values are: `non-ignorable`, and `shifted`. | -| `caseFirst` | _Optional_ | String | Valid values are: `lower`, and `upper`. | -| `caseLevel` | _Optional_ | Boolean | | -| `country` | _Optional_ | String | | -| `decomposition` | _Optional_ | String | Valid values are: `canonical`, and `no`. | -| `hiraganaQuaternaryMode` | _Optional_ | Boolean | | -| `language` | _Optional_ | String | | -| `numeric` | _Optional_ | Boolean | | -| `rules` | _Optional_ | String | | -| `strength` | _Optional_ | String | Valid values are: `identical`, `primary`, `quaternary`, `secondary`, and `tertiary`. | -| `variableTop` | _Optional_ | String | | -| `variant` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `icu_folding`. | -| `unicode_set_filter` | **Required** | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `name` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | -| `type` | **Required** | String | Valid values are: `icu_normalizer`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `id` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `icu_transform`. | -| `dir` | _Optional_ | String | Valid values are: `forward`, and `reverse`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `encoder` | **Required** | String | Valid values are: `beider_morse`, `caverphone1`, `caverphone2`, `cologne`, `daitch_mokotoff`, `double_metaphone`, `haasephonetik`, `koelnerphonetik`, `metaphone`, `nysiis`, `refined_soundex`, and `soundex`. | -| `languageset` | **Required** | Array of Strings | | -| `name_type` | **Required** | String | Valid values are: `ashkenazi`, `generic`, and `sephardic`. | -| `rule_type` | **Required** | String | Valid values are: `approx`, and `exact`. | -| `type` | **Required** | String | Valid values are: `phonetic`. | -| `max_code_len` | _Optional_ | Integer | | -| `replace` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `dictionary_decompounder`. | -| `hyphenation_patterns_path` | _Optional_ | String | | -| `max_subword_size` | _Optional_ | Integer | | -| `min_subword_size` | _Optional_ | Integer | | -| `min_word_size` | _Optional_ | Integer | | -| `only_longest_match` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | -| `word_list` | _Optional_ | Array of Strings | | -| `word_list_path` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `smartcn_stop`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `asciifolding`. | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `common_grams`. | -| `common_words` | _Optional_ | Array of Strings | | -| `common_words_path` | _Optional_ | String | | -| `ignore_case` | _Optional_ | Boolean | | -| `query_mode` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `filter` | **Required** | Array of Strings | | -| `script` | **Required** | Object or Object or String | | -| `type` | **Required** | String | Valid values are: `condition`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `delimited_payload`. | -| `delimiter` | _Optional_ | String | | -| `encoding` | _Optional_ | String | Valid values are: `float`, `identity`, and `int`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `edge_ngram`. | -| `max_gram` | _Optional_ | Integer | | -| `min_gram` | _Optional_ | Integer | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `side` | _Optional_ | String | Valid values are: `back`, and `front`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `elision`. | -| `articles` | _Optional_ | Array of Strings | | -| `articles_case` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `articles_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `fingerprint`. | -| `max_output_size` | _Optional_ | Integer | | -| `separator` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `locale` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `hunspell`. | -| `dedup` | _Optional_ | Boolean | | -| `dictionary` | _Optional_ | String | | -| `longest_only` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `hyphenation_decompounder`. | -| `hyphenation_patterns_path` | _Optional_ | String | | -| `max_subword_size` | _Optional_ | Integer | | -| `min_subword_size` | _Optional_ | Integer | | -| `min_word_size` | _Optional_ | Integer | | -| `only_longest_match` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | -| `word_list` | _Optional_ | Array of Strings | | -| `word_list_path` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keep_types`. | -| `mode` | _Optional_ | String | Valid values are: `exclude`, and `include`. | -| `types` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keep`. | -| `keep_words` | _Optional_ | Array of Strings | | -| `keep_words_case` | _Optional_ | Boolean | | -| `keep_words_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keyword_marker`. | -| `ignore_case` | _Optional_ | Boolean | | -| `keywords` | _Optional_ | Array of Strings | | -| `keywords_path` | _Optional_ | String | | -| `keywords_pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `kstem`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `length`. | -| `max` | _Optional_ | Integer | | -| `min` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `limit`. | -| `consume_all_tokens` | _Optional_ | Boolean | | -| `max_token_count` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `lowercase`. | -| `language` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `filters` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `multiplexer`. | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `ngram`. | -| `max_gram` | _Optional_ | Integer | | -| `min_gram` | _Optional_ | Integer | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `nori_part_of_speech`. | -| `stoptags` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `patterns` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `pattern_capture`. | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `pattern` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `pattern_replace`. | -| `all` | _Optional_ | Boolean | | -| `flags` | _Optional_ | String | | -| `replacement` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `persian_stem`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `porter_stem`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `script` | **Required** | Object or Object or String | | -| `type` | **Required** | String | Valid values are: `predicate_token_filter`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `remove_duplicates`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `reverse`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `shingle`. | -| `filler_token` | _Optional_ | String | | -| `max_shingle_size` | _Optional_ | Float or String | | -| `min_shingle_size` | _Optional_ | Float or String | | -| `output_unigrams` | _Optional_ | Boolean | | -| `output_unigrams_if_no_shingles` | _Optional_ | Boolean | | -| `token_separator` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | -| `type` | **Required** | String | Valid values are: `snowball`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stemmer_override`. | -| `rules` | _Optional_ | Array of Strings | | -| `rules_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stemmer`. | -| `language` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stop`. | -| `ignore_case` | _Optional_ | Boolean | | -| `remove_trailing` | _Optional_ | Boolean | | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `synonym_graph`. | -| `expand` | _Optional_ | Boolean | | -| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | -| `lenient` | _Optional_ | Boolean | | -| `synonyms` | _Optional_ | Array of Strings | | -| `synonyms_path` | _Optional_ | String | | -| `tokenizer` | _Optional_ | String | | -| `updateable` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `synonym`. | -| `expand` | _Optional_ | Boolean | | -| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | -| `lenient` | _Optional_ | Boolean | | -| `synonyms` | _Optional_ | Array of Strings | | -| `synonyms_path` | _Optional_ | String | | -| `tokenizer` | _Optional_ | String | | -| `updateable` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `trim`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `truncate`. | -| `length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `unique`. | -| `only_on_same_position` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `uppercase`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `word_delimiter_graph`. | -| `adjust_offsets` | _Optional_ | Boolean | | -| `catenate_all` | _Optional_ | Boolean | | -| `catenate_numbers` | _Optional_ | Boolean | | -| `catenate_words` | _Optional_ | Boolean | | -| `generate_number_parts` | _Optional_ | Boolean | | -| `generate_word_parts` | _Optional_ | Boolean | | -| `ignore_keywords` | _Optional_ | Boolean | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `protected_words` | _Optional_ | Array of Strings | | -| `protected_words_path` | _Optional_ | String | | -| `split_on_case_change` | _Optional_ | Boolean | | -| `split_on_numerics` | _Optional_ | Boolean | | -| `stem_english_possessive` | _Optional_ | Boolean | | -| `type_table` | _Optional_ | Array of Strings | | -| `type_table_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `word_delimiter`. | -| `catenate_all` | _Optional_ | Boolean | | -| `catenate_numbers` | _Optional_ | Boolean | | -| `catenate_words` | _Optional_ | Boolean | | -| `generate_number_parts` | _Optional_ | Boolean | | -| `generate_word_parts` | _Optional_ | Boolean | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `protected_words` | _Optional_ | Array of Strings | | -| `protected_words_path` | _Optional_ | String | | -| `split_on_case_change` | _Optional_ | Boolean | | -| `split_on_numerics` | _Optional_ | Boolean | | -| `stem_english_possessive` | _Optional_ | Boolean | | -| `type_table` | _Optional_ | Array of Strings | | -| `type_table_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `minimum_length` | **Required** | Integer | | -| `type` | **Required** | String | Valid values are: `kuromoji_stemmer`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `kuromoji_readingform`. | -| `use_romaji` | **Required** | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `stoptags` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `kuromoji_part_of_speech`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `rule_files` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `icu_collation`. | -| `alternate` | _Optional_ | String | Valid values are: `non-ignorable`, and `shifted`. | -| `caseFirst` | _Optional_ | String | Valid values are: `lower`, and `upper`. | -| `caseLevel` | _Optional_ | Boolean | | -| `country` | _Optional_ | String | | -| `decomposition` | _Optional_ | String | Valid values are: `canonical`, and `no`. | -| `hiraganaQuaternaryMode` | _Optional_ | Boolean | | -| `language` | _Optional_ | String | | -| `numeric` | _Optional_ | Boolean | | -| `rules` | _Optional_ | String | | -| `strength` | _Optional_ | String | Valid values are: `identical`, `primary`, `quaternary`, `secondary`, and `tertiary`. | -| `variableTop` | _Optional_ | String | | -| `variant` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `icu_folding`. | -| `unicode_set_filter` | **Required** | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `name` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | -| `type` | **Required** | String | Valid values are: `icu_normalizer`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `id` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `icu_transform`. | -| `dir` | _Optional_ | String | Valid values are: `forward`, and `reverse`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `encoder` | **Required** | String | Valid values are: `beider_morse`, `caverphone1`, `caverphone2`, `cologne`, `daitch_mokotoff`, `double_metaphone`, `haasephonetik`, `koelnerphonetik`, `metaphone`, `nysiis`, `refined_soundex`, and `soundex`. | -| `languageset` | **Required** | Array of Strings | | -| `name_type` | **Required** | String | Valid values are: `ashkenazi`, `generic`, and `sephardic`. | -| `rule_type` | **Required** | String | Valid values are: `approx`, and `exact`. | -| `type` | **Required** | String | Valid values are: `phonetic`. | -| `max_code_len` | _Optional_ | Integer | | -| `replace` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `dictionary_decompounder`. | -| `hyphenation_patterns_path` | _Optional_ | String | | -| `max_subword_size` | _Optional_ | Integer | | -| `min_subword_size` | _Optional_ | Integer | | -| `min_word_size` | _Optional_ | Integer | | -| `only_longest_match` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | -| `word_list` | _Optional_ | Array of Strings | | -| `word_list_path` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `smartcn_stop`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `asciifolding`. | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `common_grams`. | -| `common_words` | _Optional_ | Array of Strings | | -| `common_words_path` | _Optional_ | String | | -| `ignore_case` | _Optional_ | Boolean | | -| `query_mode` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `filter` | **Required** | Array of Strings | | -| `script` | **Required** | Object or Object or String | | -| `type` | **Required** | String | Valid values are: `condition`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script - - {: .text-delta} - -`script` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `source` | **Required** | String | The script source. | -| `lang` | _Optional_ | String | | -| `options` | _Optional_ | Object | | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `id` | **Required** | String | The unique identifier for a resource. | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script - - {: .text-delta} - -`script` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `source` | **Required** | String | The script source. | -| `lang` | _Optional_ | String | | -| `options` | _Optional_ | Object | | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script - - {: .text-delta} - -`script` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script - - {: .text-delta} - -`script` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `source` | **Required** | String | The script source. | -| `lang` | _Optional_ | String | | -| `options` | _Optional_ | Object | | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script > options - - {: .text-delta} - -`options` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script > params - - {: .text-delta} - -Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. - -`params` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script > params > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script - - {: .text-delta} - -`script` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `id` | **Required** | String | The unique identifier for a resource. | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `delimited_payload`. | -| `delimiter` | _Optional_ | String | | -| `encoding` | _Optional_ | String | Valid values are: `float`, `identity`, and `int`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `edge_ngram`. | -| `max_gram` | _Optional_ | Integer | | -| `min_gram` | _Optional_ | Integer | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `side` | _Optional_ | String | Valid values are: `back`, and `front`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `elision`. | -| `articles` | _Optional_ | Array of Strings | | -| `articles_case` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `articles_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `fingerprint`. | -| `max_output_size` | _Optional_ | Integer | | -| `separator` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `locale` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `hunspell`. | -| `dedup` | _Optional_ | Boolean | | -| `dictionary` | _Optional_ | String | | -| `longest_only` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `hyphenation_decompounder`. | -| `hyphenation_patterns_path` | _Optional_ | String | | -| `max_subword_size` | _Optional_ | Integer | | -| `min_subword_size` | _Optional_ | Integer | | -| `min_word_size` | _Optional_ | Integer | | -| `only_longest_match` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | -| `word_list` | _Optional_ | Array of Strings | | -| `word_list_path` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keep_types`. | -| `mode` | _Optional_ | String | Valid values are: `exclude`, and `include`. | -| `types` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keep`. | -| `keep_words` | _Optional_ | Array of Strings | | -| `keep_words_case` | _Optional_ | Boolean | | -| `keep_words_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `keyword_marker`. | -| `ignore_case` | _Optional_ | Boolean | | -| `keywords` | _Optional_ | Array of Strings | | -| `keywords_path` | _Optional_ | String | | -| `keywords_pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `kstem`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `length`. | -| `max` | _Optional_ | Integer | | -| `min` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `limit`. | -| `consume_all_tokens` | _Optional_ | Boolean | | -| `max_token_count` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `lowercase`. | -| `language` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `filters` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `multiplexer`. | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `ngram`. | -| `max_gram` | _Optional_ | Integer | | -| `min_gram` | _Optional_ | Integer | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `nori_part_of_speech`. | -| `stoptags` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `patterns` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `pattern_capture`. | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `pattern` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `pattern_replace`. | -| `all` | _Optional_ | Boolean | | -| `flags` | _Optional_ | String | | -| `replacement` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `persian_stem`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `porter_stem`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `script` | **Required** | Object or Object or String | | -| `type` | **Required** | String | Valid values are: `predicate_token_filter`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script - - {: .text-delta} - -`script` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `source` | **Required** | String | The script source. | -| `lang` | _Optional_ | String | | -| `options` | _Optional_ | Object | | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `id` | **Required** | String | The unique identifier for a resource. | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > script - - {: .text-delta} - -`script` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `id` | **Required** | String | The unique identifier for a resource. | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `remove_duplicates`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `reverse`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `shingle`. | -| `filler_token` | _Optional_ | String | | -| `max_shingle_size` | _Optional_ | Float or String | | -| `min_shingle_size` | _Optional_ | Float or String | | -| `output_unigrams` | _Optional_ | Boolean | | -| `output_unigrams_if_no_shingles` | _Optional_ | Boolean | | -| `token_separator` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `language` | **Required** | String | Valid values are: `Armenian`, `Basque`, `Catalan`, `Danish`, `Dutch`, `English`, `Finnish`, `French`, `German`, `German2`, `Hungarian`, `Italian`, `Kp`, `Lovins`, `Norwegian`, `Porter`, `Portuguese`, `Romanian`, `Russian`, `Spanish`, `Swedish`, and `Turkish`. | -| `type` | **Required** | String | Valid values are: `snowball`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stemmer_override`. | -| `rules` | _Optional_ | Array of Strings | | -| `rules_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stemmer`. | -| `language` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `stop`. | -| `ignore_case` | _Optional_ | Boolean | | -| `remove_trailing` | _Optional_ | Boolean | | -| `stopwords` | _Optional_ | Object | Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. | -| `stopwords_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- > stopwords - - {: .text-delta} - -Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - -`stopwords` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `synonym_graph`. | -| `expand` | _Optional_ | Boolean | | -| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | -| `lenient` | _Optional_ | Boolean | | -| `synonyms` | _Optional_ | Array of Strings | | -| `synonyms_path` | _Optional_ | String | | -| `tokenizer` | _Optional_ | String | | -| `updateable` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `synonym`. | -| `expand` | _Optional_ | Boolean | | -| `format` | _Optional_ | String | Valid values are: `solr`, and `wordnet`. | -| `lenient` | _Optional_ | Boolean | | -| `synonyms` | _Optional_ | Array of Strings | | -| `synonyms_path` | _Optional_ | String | | -| `tokenizer` | _Optional_ | String | | -| `updateable` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `trim`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `truncate`. | -| `length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `unique`. | -| `only_on_same_position` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `uppercase`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `word_delimiter_graph`. | -| `adjust_offsets` | _Optional_ | Boolean | | -| `catenate_all` | _Optional_ | Boolean | | -| `catenate_numbers` | _Optional_ | Boolean | | -| `catenate_words` | _Optional_ | Boolean | | -| `generate_number_parts` | _Optional_ | Boolean | | -| `generate_word_parts` | _Optional_ | Boolean | | -| `ignore_keywords` | _Optional_ | Boolean | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `protected_words` | _Optional_ | Array of Strings | | -| `protected_words_path` | _Optional_ | String | | -| `split_on_case_change` | _Optional_ | Boolean | | -| `split_on_numerics` | _Optional_ | Boolean | | -| `stem_english_possessive` | _Optional_ | Boolean | | -| `type_table` | _Optional_ | Array of Strings | | -| `type_table_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `word_delimiter`. | -| `catenate_all` | _Optional_ | Boolean | | -| `catenate_numbers` | _Optional_ | Boolean | | -| `catenate_words` | _Optional_ | Boolean | | -| `generate_number_parts` | _Optional_ | Boolean | | -| `generate_word_parts` | _Optional_ | Boolean | | -| `preserve_original` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `protected_words` | _Optional_ | Array of Strings | | -| `protected_words_path` | _Optional_ | String | | -| `split_on_case_change` | _Optional_ | Boolean | | -| `split_on_numerics` | _Optional_ | Boolean | | -| `stem_english_possessive` | _Optional_ | Boolean | | -| `type_table` | _Optional_ | Array of Strings | | -| `type_table_path` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `minimum_length` | **Required** | Integer | | -| `type` | **Required** | String | Valid values are: `kuromoji_stemmer`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `kuromoji_readingform`. | -| `use_romaji` | **Required** | Boolean | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `stoptags` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `kuromoji_part_of_speech`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `rule_files` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `icu_collation`. | -| `alternate` | _Optional_ | String | Valid values are: `non-ignorable`, and `shifted`. | -| `caseFirst` | _Optional_ | String | Valid values are: `lower`, and `upper`. | -| `caseLevel` | _Optional_ | Boolean | | -| `country` | _Optional_ | String | | -| `decomposition` | _Optional_ | String | Valid values are: `canonical`, and `no`. | -| `hiraganaQuaternaryMode` | _Optional_ | Boolean | | -| `language` | _Optional_ | String | | -| `numeric` | _Optional_ | Boolean | | -| `rules` | _Optional_ | String | | -| `strength` | _Optional_ | String | Valid values are: `identical`, `primary`, `quaternary`, `secondary`, and `tertiary`. | -| `variableTop` | _Optional_ | String | | -| `variant` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `icu_folding`. | -| `unicode_set_filter` | **Required** | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `name` | **Required** | String | Valid values are: `nfc`, `nfkc`, and `nfkc_cf`. | -| `type` | **Required** | String | Valid values are: `icu_normalizer`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `id` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `icu_transform`. | -| `dir` | _Optional_ | String | Valid values are: `forward`, and `reverse`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `encoder` | **Required** | String | Valid values are: `beider_morse`, `caverphone1`, `caverphone2`, `cologne`, `daitch_mokotoff`, `double_metaphone`, `haasephonetik`, `koelnerphonetik`, `metaphone`, `nysiis`, `refined_soundex`, and `soundex`. | -| `languageset` | **Required** | Array of Strings | | -| `name_type` | **Required** | String | Valid values are: `ashkenazi`, `generic`, and `sephardic`. | -| `rule_type` | **Required** | String | Valid values are: `approx`, and `exact`. | -| `type` | **Required** | String | Valid values are: `phonetic`. | -| `max_code_len` | _Optional_ | Integer | | -| `replace` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `dictionary_decompounder`. | -| `hyphenation_patterns_path` | _Optional_ | String | | -| `max_subword_size` | _Optional_ | Integer | | -| `min_subword_size` | _Optional_ | Integer | | -| `min_word_size` | _Optional_ | Integer | | -| `only_longest_match` | _Optional_ | Boolean | | -| `version` | _Optional_ | String | | -| `word_list` | _Optional_ | Array of Strings | | -| `word_list_path` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > filter > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `smartcn_stop`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > normalizer - - {: .text-delta} - -`normalizer` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | - -
-
- - Request body fields: index_settings > analysis > normalizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `lowercase`. | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `custom`. | -| `char_filter` | _Optional_ | Array of Strings | | -| `filter` | _Optional_ | Array of Strings | | - -
-
- - Request body fields: index_settings > analysis > normalizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `lowercase`. | - -
-
- - Request body fields: index_settings > analysis > normalizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `custom`. | -| `char_filter` | _Optional_ | Array of Strings | | -| `filter` | _Optional_ | Array of Strings | | - -
-
- - Request body fields: index_settings > analysis > tokenizer - - {: .text-delta} - -`tokenizer` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object or String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `tokenize_on_chars` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `char_group`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `max_gram` | **Required** | Integer | | -| `min_gram` | **Required** | Integer | | -| `token_chars` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `edge_ngram`. | -| `custom_token_chars` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `buffer_size` | **Required** | Integer | | -| `type` | **Required** | String | Valid values are: `keyword`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `letter`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `lowercase`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `max_gram` | **Required** | Integer | | -| `min_gram` | **Required** | Integer | | -| `token_chars` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `ngram`. | -| `custom_token_chars` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `nori_tokenizer`. | -| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | -| `discard_punctuation` | _Optional_ | Boolean | | -| `user_dictionary` | _Optional_ | String | | -| `user_dictionary_rules` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `buffer_size` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `delimiter` | **Required** | String | | -| `reverse` | **Required** | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `skip` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `type` | **Required** | String | Valid values are: `path_hierarchy`. | -| `replacement` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `standard`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `uax_url_email`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `whitespace`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | -| `type` | **Required** | String | Valid values are: `kuromoji_tokenizer`. | -| `discard_compound_token` | _Optional_ | Boolean | | -| `discard_punctuation` | _Optional_ | Boolean | | -| `nbest_cost` | _Optional_ | Integer | | -| `nbest_examples` | _Optional_ | String | | -| `user_dictionary` | _Optional_ | String | | -| `user_dictionary_rules` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `pattern`. | -| `flags` | _Optional_ | String | | -| `group` | _Optional_ | Integer | | -| `pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `simple_pattern`. | -| `pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `simple_pattern_split`. | -| `pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `rule_files` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `smartcn_tokenizer`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `tokenize_on_chars` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `char_group`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `max_gram` | **Required** | Integer | | -| `min_gram` | **Required** | Integer | | -| `token_chars` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `edge_ngram`. | -| `custom_token_chars` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `buffer_size` | **Required** | Integer | | -| `type` | **Required** | String | Valid values are: `keyword`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `letter`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `lowercase`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `max_gram` | **Required** | Integer | | -| `min_gram` | **Required** | Integer | | -| `token_chars` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `ngram`. | -| `custom_token_chars` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `nori_tokenizer`. | -| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | -| `discard_punctuation` | _Optional_ | Boolean | | -| `user_dictionary` | _Optional_ | String | | -| `user_dictionary_rules` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `buffer_size` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `delimiter` | **Required** | String | | -| `reverse` | **Required** | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `skip` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `type` | **Required** | String | Valid values are: `path_hierarchy`. | -| `replacement` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `standard`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `uax_url_email`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `whitespace`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | -| `type` | **Required** | String | Valid values are: `kuromoji_tokenizer`. | -| `discard_compound_token` | _Optional_ | Boolean | | -| `discard_punctuation` | _Optional_ | Boolean | | -| `nbest_cost` | _Optional_ | Integer | | -| `nbest_examples` | _Optional_ | String | | -| `user_dictionary` | _Optional_ | String | | -| `user_dictionary_rules` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `pattern`. | -| `flags` | _Optional_ | String | | -| `group` | _Optional_ | Integer | | -| `pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `simple_pattern`. | -| `pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `simple_pattern_split`. | -| `pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `rule_files` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | -| `version` | _Optional_ | String | | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `smartcn_tokenizer`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `tokenize_on_chars` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `char_group`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `max_gram` | **Required** | Integer | | -| `min_gram` | **Required** | Integer | | -| `token_chars` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `edge_ngram`. | -| `custom_token_chars` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `buffer_size` | **Required** | Integer | | -| `type` | **Required** | String | Valid values are: `keyword`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `letter`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `lowercase`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `max_gram` | **Required** | Integer | | -| `min_gram` | **Required** | Integer | | -| `token_chars` | **Required** | Array of Strings | | -| `type` | **Required** | String | Valid values are: `ngram`. | -| `custom_token_chars` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `nori_tokenizer`. | -| `decompound_mode` | _Optional_ | String | Valid values are: `discard`, `mixed`, and `none`. | -| `discard_punctuation` | _Optional_ | Boolean | | -| `user_dictionary` | _Optional_ | String | | -| `user_dictionary_rules` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `buffer_size` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `delimiter` | **Required** | String | | -| `reverse` | **Required** | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `skip` | **Required** | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `type` | **Required** | String | Valid values are: `path_hierarchy`. | -| `replacement` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `standard`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `uax_url_email`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `whitespace`. | -| `max_token_length` | _Optional_ | Integer | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `mode` | **Required** | String | Valid values are: `extended`, `normal`, and `search`. | -| `type` | **Required** | String | Valid values are: `kuromoji_tokenizer`. | -| `discard_compound_token` | _Optional_ | Boolean | | -| `discard_punctuation` | _Optional_ | Boolean | | -| `nbest_cost` | _Optional_ | Integer | | -| `nbest_examples` | _Optional_ | String | | -| `user_dictionary` | _Optional_ | String | | -| `user_dictionary_rules` | _Optional_ | Array of Strings | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `pattern`. | -| `flags` | _Optional_ | String | | -| `group` | _Optional_ | Integer | | -| `pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `simple_pattern`. | -| `pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `simple_pattern_split`. | -| `pattern` | _Optional_ | String | | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `rule_files` | **Required** | String | | -| `type` | **Required** | String | Valid values are: `icu_tokenizer`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analysis > tokenizer > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | Valid values are: `smartcn_tokenizer`. | -| `version` | _Optional_ | String | | - -
-
- - Request body fields: index_settings > analyze - - {: .text-delta} - -`analyze` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > blocks - - {: .text-delta} - -`blocks` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > composite_index.star_tree - - {: .text-delta} - -`composite_index.star_tree` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `default` | Object | | -| `field` | Object | | -| `max_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > composite_index.star_tree > default - - {: .text-delta} - -`default` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `max_leaf_docs` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > composite_index.star_tree > field - - {: .text-delta} - -`field` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `default` | Object | | -| `max_base_metrics` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_date_intervals` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_dimensions` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > composite_index.star_tree > field > default - - {: .text-delta} - -`default` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `date_intervals` | Array of Strings | | -| `metrics` | Array of Strings | | - -
-
- - Request body fields: index_settings > creation_date_string - - {: .text-delta} - -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`creation_date_string` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > creation_date_string - - {: .text-delta} - -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`creation_date_string` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > creation_date_string - - {: .text-delta} - -A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. - -`creation_date_string` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > highlight - - {: .text-delta} - -`highlight` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > index - - {: .text-delta} - -The index settings to be updated. - -`index` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | -| `analysis` | Object | | -| `analyze` | Object | | -| `analyze.max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `auto_expand_replicas` | String | | -| `blocks` | Object | | -| `blocks.metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `check_on_startup` | String | Valid values are: `checksum`, `false`, and `true`. | -| `codec` | String | | -| `composite_index.star_tree` | Object | | -| `creation_date` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `creation_date_string` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | -| `default_pipeline` | String | | -| `final_pipeline` | String | | -| `format` | Float or String | | -| `gc_deletes` | String | 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. | -| `hidden` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `highlight` | Object | | -| `highlight.max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `index` | Object | The index settings to be updated. | -| `indexing` | Object | | -| `indexing_pressure` | Object | | -| `knn` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `knn.algo_param.ef_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `lifecycle` | Object | | -| `lifecycle.name` | String | The name of a resource or configuration element. | -| `load_fixed_bitset_filters_eagerly` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `mapping` | Object | | -| `max_docvalue_fields_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_inner_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_ngram_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_refresh_listeners` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_regex_length` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_rescore_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_script_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_shingle_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_slices_per_scroll` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_terms_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `merge` | Object | | -| `merge.scheduler.max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `mode` | String | | -| `number_of_replicas` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `number_of_routing_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `number_of_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `priority` | Float or String | | -| `provided_name` | String | The name of a resource or configuration element. | -| `queries` | Object | | -| `query_string` | Object | | -| `query_string.lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `refresh_interval` | String | 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. | -| `routing` | Object | | -| `routing_partition_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `routing_path` | Array of Strings or String | | -| `search` | Object | | -| `search.idle.after` | String | 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. | -| `settings` | Object | The index settings to be updated. | -| `similarity` | Object | | -| `soft_deletes` | Object | | -| `soft_deletes.retention_lease.period` | String | 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. | -| `sort` | Object | | -| `store` | Object | | -| `top_metrics_max_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `translog` | Object | | -| `translog.durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | -| `translog.flush_threshold_size` | String | The unique identifier of a node. | -| `uuid` | String | The universally unique identifier. | -| `verified_before_close` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | Object | | - -
-
- - Request body fields: index_settings > index > indexing - - {: .text-delta} - -`indexing` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `slowlog` | Object | | - -
-
- - Request body fields: index_settings > index > indexing > slowlog - - {: .text-delta} - -`slowlog` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `level` | String | | -| `reformat` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `source` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `threshold` | Object | | - -
-
- - Request body fields: index_settings > index > indexing > slowlog > threshold - - {: .text-delta} - -`threshold` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `index` | Object | | - -
-
- - Request body fields: index_settings > index > indexing > slowlog > threshold > index - - {: .text-delta} - -`index` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `debug` | String | 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. | -| `info` | String | 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. | -| `trace` | String | 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. | -| `warn` | String | 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. | - -
-
- - Request body fields: index_settings > index > indexing_pressure - - {: .text-delta} - -`indexing_pressure` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `memory` | **Required** | Object | | - -
-
- - Request body fields: index_settings > index > indexing_pressure > memory - - {: .text-delta} - -`memory` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `limit` | Integer or String | Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, the node will reject new replica operations. Defaults to 10% of the heap. | - -
-
- - Request body fields: index_settings > index > lifecycle - - {: .text-delta} - -`lifecycle` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `name` | **Required** | String | The name of a resource or configuration element. | -| `indexing_complete` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `origination_date` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `parse_origination_date` | _Optional_ | Boolean | Set to `true` to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern `^.*-{date_format}-\\d+`, where the `date_format` is `yyyy.MM.dd` and the trailing digits are optional. An index that was rolled over would normally match the full format, for example `logs-2016.10.31-000002`). If the index name doesn't match the pattern, index creation fails. | -| `rollover_alias` | _Optional_ | String | The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indexes, see Rollover. | -| `step` | _Optional_ | Object | | - -
-
- - Request body fields: index_settings > index > lifecycle > step - - {: .text-delta} - -`step` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `wait_time_threshold` | String | 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. | - -
-
- - Request body fields: index_settings > index > mapping - - {: .text-delta} - -`mapping` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `coerce` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `depth` | Object | | -| `dimension_fields` | Object | | -| `field_name_length` | Object | | -| `ignore_malformed` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `nested_fields` | Object | | -| `nested_objects` | Object | | -| `total_fields` | Object | | - -
-
- - Request body fields: index_settings > index > mapping > depth - - {: .text-delta} - -`depth` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `limit` | Integer or String | The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined at the root object level, then the depth is `1`. If there is one object mapping, then the depth is `2`. | - -
-
- - Request body fields: index_settings > index > mapping > dimension_fields - - {: .text-delta} - -`dimension_fields` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `limit` | Integer or String | [preview] This functionality is in technical preview and may be changed or removed in a future release. OpenSearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. | - -
-
- - Request body fields: index_settings > index > mapping > field_name_length - - {: .text-delta} - -`field_name_length` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `limit` | Integer or String | Setting for the maximum length of a field name. This setting isn't really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn't be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). | - -
-
- - Request body fields: index_settings > index > mapping > nested_fields - - {: .text-delta} - -`nested_fields` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `limit` | Integer or String | The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting limits the number of unique nested types per index. | - -
-
- - Request body fields: index_settings > index > mapping > nested_objects - - {: .text-delta} - -`nested_objects` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `limit` | Integer or String | The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. | - -
-
- - Request body fields: index_settings > index > mapping > total_fields - - {: .text-delta} - -`total_fields` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `limit` | Integer or String | The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources. | - -
-
- - Request body fields: index_settings > index > merge - - {: .text-delta} - -`merge` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `log_byte_size_policy` | Object | | -| `policy` | Object or String | Valid values are: `default`, `log_byte_size`, and `tiered`. | -| `policy.deletes_pct_allowed` | Float or String | | -| `policy.expunge_deletes_allowed` | Float or String | | -| `policy.floor_segment` | String | The unique identifier of a node. | -| `policy.max_merge_at_once` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `policy.max_merged_segment` | String | The unique identifier of a node. | -| `policy.reclaim_deletes_weight` | Float or String | | -| `policy.segments_per_tier` | Float or String | | -| `scheduler` | Object | | - -
-
- - Request body fields: index_settings > index > merge > log_byte_size_policy - - {: .text-delta} - -`log_byte_size_policy` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `max_merge_segment` | String | The unique identifier of a node. | -| `max_merge_segment_forced_merge` | String | The unique identifier of a node. | -| `max_merged_docs` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `merge_factor` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `min_merge` | String | The unique identifier of a node. | -| `no_cfs_ratio` | Float or String | | - -
-
- - Request body fields: index_settings > index > merge > policy - - {: .text-delta} - -`policy` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `deletes_pct_allowed` | Float or String | | -| `expunge_deletes_allowed` | Float or String | | -| `floor_segment` | String | The unique identifier of a node. | -| `max_merge_at_once` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_merge_at_once_explicit` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_merged_segment` | String | The unique identifier of a node. | -| `reclaim_deletes_weight` | Float or String | | -| `segments_per_tier` | Float or String | | - -
-
- - Request body fields: index_settings > index > merge > policy - - {: .text-delta} - -`policy` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > index > merge > policy - - {: .text-delta} - -`policy` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `deletes_pct_allowed` | Float or String | | -| `expunge_deletes_allowed` | Float or String | | -| `floor_segment` | String | The unique identifier of a node. | -| `max_merge_at_once` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_merge_at_once_explicit` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_merged_segment` | String | The unique identifier of a node. | -| `reclaim_deletes_weight` | Float or String | | -| `segments_per_tier` | Float or String | | - -
-
- - Request body fields: index_settings > index > merge > scheduler - - {: .text-delta} - -`scheduler` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `auto_throttle` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_merge_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > index > queries - - {: .text-delta} - -`queries` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `cache` | Object | | - -
-
- - Request body fields: index_settings > index > queries > cache - - {: .text-delta} - -`cache` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `enabled` | **Required** | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > index > query_string - - {: .text-delta} - -`query_string` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > index > routing - - {: .text-delta} - -`routing` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `allocation` | Object | | -| `rebalance` | Object | | - -
-
- - Request body fields: index_settings > index > routing > allocation - - {: .text-delta} - -`allocation` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `disk` | Object | | -| `enable` | String | Valid values are: `all`, `new_primaries`, `none`, and `primaries`. | -| `include` | Object | | -| `initial_recovery` | Object | | -| `total_primary_shards_per_node` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `total_shards_per_node` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > index > routing > allocation > disk - - {: .text-delta} - -`disk` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `threshold_enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > index > routing > allocation > include - - {: .text-delta} - -`include` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `_id` | String | The unique identifier for a resource. | -| `_tier_preference` | String | | - -
-
- - Request body fields: index_settings > index > routing > allocation > initial_recovery - - {: .text-delta} - -`initial_recovery` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `_id` | String | The unique identifier for a resource. | - -
-
- - Request body fields: index_settings > index > routing > rebalance - - {: .text-delta} - -`rebalance` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `enable` | **Required** | String | Valid values are: `all`, `none`, `primaries`, and `replicas`. | - -
-
- - Request body fields: index_settings > index > search - - {: .text-delta} - -`search` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `concurrent` | Object | | -| `concurrent_segment_search` | Object | | -| `default_pipeline` | String | | -| `idle` | Object | | -| `slowlog` | Object | | -| `throttled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > index > search > concurrent - - {: .text-delta} - -`concurrent` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `max_slice_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > index > search > concurrent_segment_search - - {: .text-delta} - -`concurrent_segment_search` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `mode` | String | | - -
-
- - Request body fields: index_settings > index > search > idle - - {: .text-delta} - -`idle` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `after` | String | 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. | - -
-
- - Request body fields: index_settings > index > search > slowlog - - {: .text-delta} - -`slowlog` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `level` | String | | -| `reformat` | Boolean | | -| `threshold` | Object | | - -
-
- - Request body fields: index_settings > index > search > slowlog > threshold - - {: .text-delta} - -`threshold` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `fetch` | Object | | -| `query` | Object | | - -
-
- - Request body fields: index_settings > index > search > slowlog > threshold > fetch - - {: .text-delta} - -`fetch` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `debug` | String | 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. | -| `info` | String | 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. | -| `trace` | String | 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. | -| `warn` | String | 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. | - -
-
- - Request body fields: index_settings > index > search > slowlog > threshold > query - - {: .text-delta} - -`query` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `debug` | String | 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. | -| `info` | String | 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. | -| `trace` | String | 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. | -| `warn` | String | 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. | - -
-
- - Request body fields: index_settings > index > settings - - {: .text-delta} - -The index settings to be updated. - -`settings` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | -| `analysis` | Object | | -| `analyze` | Object | | -| `analyze.max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `auto_expand_replicas` | String | | -| `blocks` | Object | | -| `blocks.metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `check_on_startup` | String | Valid values are: `checksum`, `false`, and `true`. | -| `codec` | String | | -| `composite_index.star_tree` | Object | | -| `creation_date` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `creation_date_string` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | -| `default_pipeline` | String | | -| `final_pipeline` | String | | -| `format` | Float or String | | -| `gc_deletes` | String | 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. | -| `hidden` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `highlight` | Object | | -| `highlight.max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `index` | Object | The index settings to be updated. | -| `indexing` | Object | | -| `indexing_pressure` | Object | | -| `knn` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `knn.algo_param.ef_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `lifecycle` | Object | | -| `lifecycle.name` | String | The name of a resource or configuration element. | -| `load_fixed_bitset_filters_eagerly` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `mapping` | Object | | -| `max_docvalue_fields_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_inner_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_ngram_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_refresh_listeners` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_regex_length` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_rescore_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_script_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_shingle_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_slices_per_scroll` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_terms_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `merge` | Object | | -| `merge.scheduler.max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `mode` | String | | -| `number_of_replicas` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `number_of_routing_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `number_of_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `priority` | Float or String | | -| `provided_name` | String | The name of a resource or configuration element. | -| `queries` | Object | | -| `query_string` | Object | | -| `query_string.lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `refresh_interval` | String | 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. | -| `routing` | Object | | -| `routing_partition_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `routing_path` | Array of Strings or String | | -| `search` | Object | | -| `search.idle.after` | String | 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. | -| `settings` | Object | The index settings to be updated. | -| `similarity` | Object | | -| `soft_deletes` | Object | | -| `soft_deletes.retention_lease.period` | String | 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. | -| `sort` | Object | | -| `store` | Object | | -| `top_metrics_max_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `translog` | Object | | -| `translog.durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | -| `translog.flush_threshold_size` | String | The unique identifier of a node. | -| `uuid` | String | The universally unique identifier. | -| `verified_before_close` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | Object | | - -
-
- - Request body fields: index_settings > index > settings > similarity - - {: .text-delta} - -`similarity` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `bm25` | Object | | -| `dfi` | Object | | -| `dfr` | Object | | -| `ib` | Object | | -| `lmd` | Object | | -| `lmj` | Object | | -| `scripted_tfidf` | Object | | - -
-
- - Request body fields: index_settings > index > settings > similarity > bm25 - - {: .text-delta} - -`bm25` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `b` | **Required** | Float | | -| `discount_overlaps` | **Required** | Boolean | | -| `k1` | **Required** | Float | | -| `type` | **Required** | String | Valid values are: `BM25`. | - -
-
- - Request body fields: index_settings > index > settings > similarity > dfi - - {: .text-delta} - -`dfi` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `independence_measure` | **Required** | String | Valid values are:
- `chisquared`: The chi-squared measure of independence.
- `saturated`: The saturated measure of independence.
- `standardized`: The standardized measure of independence. | -| `type` | **Required** | String | Valid values are: `DFI`. | - -
-
- - Request body fields: index_settings > index > settings > similarity > dfr - - {: .text-delta} - -`dfr` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `after_effect` | **Required** | String | Valid values are:
- `b`: The basic after effect.
- `l`: The Laplace after effect.
- `no`: No after effect. | -| `basic_model` | **Required** | String | Valid values are:
- `be`: The Bose-Einstein model.
- `d`: The divergence from independence model.
- `g`: The geometric model.
- `if`: The inverse frequency model.
- `in`: The inverse document frequency model.
- `ine`: The inverse expected document frequency model.
- `p`: The Poisson model. | -| `normalization` | **Required** | String | Valid values are:
- `h1`: The first normalization of Hazm.
- `h2`: The second normalization of Hazm.
- `h3`: The third normalization of Hazm.
- `no`: No normalization.
- `z`: The Zipfian normalization. | -| `type` | **Required** | String | Valid values are: `DFR`. | - -
-
- - Request body fields: index_settings > index > settings > similarity > ib - - {: .text-delta} - -`ib` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `distribution` | **Required** | String | Valid values are:
- `ll`: The log-logistic distribution.
- `spl`: The smoothed power-law distribution. | -| `lambda` | **Required** | String | Valid values are:
- `df`: The document frequency Lambda.
- `ttf`: The total term frequency Lambda. | -| `normalization` | **Required** | String | Valid values are:
- `h1`: The first normalization of Hazm.
- `h2`: The second normalization of Hazm.
- `h3`: The third normalization of Hazm.
- `no`: No normalization.
- `z`: The Zipfian normalization. | -| `type` | **Required** | String | Valid values are: `IB`. | - -
-
- - Request body fields: index_settings > index > settings > similarity > lmd - - {: .text-delta} - -`lmd` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `mu` | **Required** | Float | | -| `type` | **Required** | String | Valid values are: `LMDirichlet`. | - -
-
- - Request body fields: index_settings > index > settings > similarity > lmj - - {: .text-delta} - -`lmj` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `lambda` | **Required** | Float | | -| `type` | **Required** | String | Valid values are: `LMJelinekMercer`. | - -
-
- - Request body fields: index_settings > index > settings > similarity > scripted_tfidf - - {: .text-delta} - -`scripted_tfidf` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `script` | **Required** | Object or Object or String | | -| `type` | **Required** | String | Valid values are: `scripted`. | - -
-
- - Request body fields: index_settings > index > settings > similarity > scripted_tfidf > script - - {: .text-delta} - -`script` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `source` | **Required** | String | The script source. | -| `lang` | _Optional_ | String | | -| `options` | _Optional_ | Object | | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `id` | **Required** | String | The unique identifier for a resource. | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -
-
- - Request body fields: index_settings > index > settings > similarity > scripted_tfidf > script - - {: .text-delta} - -`script` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `id` | **Required** | String | The unique identifier for a resource. | -| `params` | _Optional_ | Object | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. | - -
-
- - Request body fields: index_settings > index > settings > soft_deletes - - {: .text-delta} - -`soft_deletes` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `retention` | Object | | -| `retention_lease` | Object | | - -
-
- - Request body fields: index_settings > index > settings > soft_deletes > retention - - {: .text-delta} - -`retention` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `operations` | Integer or String | | - -
-
- - Request body fields: index_settings > index > settings > soft_deletes > retention_lease - - {: .text-delta} - -`retention_lease` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `period` | **Required** | String | 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. | - -
-
- - Request body fields: index_settings > index > settings > sort - - {: .text-delta} - -`sort` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `field` | Array of Strings or String | | -| `missing` | Array of Strings or String | Valid values are: `_first`, and `_last`. | -| `mode` | Array of Strings or String | Valid values are: `max`, and `min`. | -| `order` | Array of Strings or String | Valid values are: `asc`, and `desc`. | - -
-
- - Request body fields: index_settings > index > settings > store - - {: .text-delta} - -`store` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | | -| `allow_mmap` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `fs` | _Optional_ | Object | | -| `hybrid` | _Optional_ | Object | | -| `preload` | _Optional_ | Array of Strings | | -| `stats_refresh_interval` | _Optional_ | String | 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. | - -
-
- - Request body fields: index_settings > index > settings > store > fs - - {: .text-delta} - -`fs` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `fs_lock` | String | Valid values are: `native`, and `simple`. | - -
-
- - Request body fields: index_settings > index > settings > store > hybrid - - {: .text-delta} - -`hybrid` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `mmap` | Object | | -| `nio` | Object | | - -
-
- - Request body fields: index_settings > index > settings > store > hybrid > mmap - - {: .text-delta} - -`mmap` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `extensions` | Array of Strings | | - -
-
- - Request body fields: index_settings > index > settings > store > hybrid > nio - - {: .text-delta} - -`nio` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `extensions` | Array of Strings | | - -
-
- - Request body fields: index_settings > index > settings > translog - - {: .text-delta} - -`translog` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | -| `flush_threshold_size` | String | The unique identifier of a node. | -| `generation_threshold_size` | String | The unique identifier of a node. | -| `retention` | Object | | -| `sync_interval` | String | 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. | - -
-
- - Request body fields: index_settings > index > settings > translog > retention - - {: .text-delta} - -`retention` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `age` | String | 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. | -| `size` | String | The unique identifier of a node. | - -
-
- - Request body fields: index_settings > index > settings > version - - {: .text-delta} - -`version` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `created` | String | | -| `created_string` | String | | - -
-
- - Request body fields: index_settings > index > settings > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > index > similarity - - {: .text-delta} - -`similarity` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `bm25` | Object | | -| `dfi` | Object | | -| `dfr` | Object | | -| `ib` | Object | | -| `lmd` | Object | | -| `lmj` | Object | | -| `scripted_tfidf` | Object | | - -
-
- - Request body fields: index_settings > index > soft_deletes - - {: .text-delta} - -`soft_deletes` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `retention` | Object | | -| `retention_lease` | Object | | - -
-
- - Request body fields: index_settings > index > sort - - {: .text-delta} - -`sort` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `field` | Array of Strings or String | | -| `missing` | Array of Strings or String | Valid values are: `_first`, and `_last`. | -| `mode` | Array of Strings or String | Valid values are: `max`, and `min`. | -| `order` | Array of Strings or String | Valid values are: `asc`, and `desc`. | - -
-
- - Request body fields: index_settings > index > store - - {: .text-delta} - -`store` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | | -| `allow_mmap` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `fs` | _Optional_ | Object | | -| `hybrid` | _Optional_ | Object | | -| `preload` | _Optional_ | Array of Strings | | -| `stats_refresh_interval` | _Optional_ | String | 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. | - -
-
- - Request body fields: index_settings > index > translog - - {: .text-delta} - -`translog` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | -| `flush_threshold_size` | String | The unique identifier of a node. | -| `generation_threshold_size` | String | The unique identifier of a node. | -| `retention` | Object | | -| `sync_interval` | String | 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. | - -
-
- - Request body fields: index_settings > index > version - - {: .text-delta} - -`version` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `created` | String | | -| `created_string` | String | | - -
-
- - Request body fields: index_settings > index > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Request body fields: index_settings > indexing - - {: .text-delta} - -`indexing` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `slowlog` | Object | | - -
-
- - Request body fields: index_settings > indexing_pressure - - {: .text-delta} - -`indexing_pressure` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `memory` | **Required** | Object | | - -
-
- - Request body fields: index_settings > lifecycle - - {: .text-delta} - -`lifecycle` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `name` | **Required** | String | The name of a resource or configuration element. | -| `indexing_complete` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `origination_date` | _Optional_ | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `parse_origination_date` | _Optional_ | Boolean | Set to `true` to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern `^.*-{date_format}-\\d+`, where the `date_format` is `yyyy.MM.dd` and the trailing digits are optional. An index that was rolled over would normally match the full format, for example `logs-2016.10.31-000002`). If the index name doesn't match the pattern, index creation fails. | -| `rollover_alias` | _Optional_ | String | The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indexes, see Rollover. | -| `step` | _Optional_ | Object | | - -
-
- - Request body fields: index_settings > mapping - - {: .text-delta} - -`mapping` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `coerce` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `depth` | Object | | -| `dimension_fields` | Object | | -| `field_name_length` | Object | | -| `ignore_malformed` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `nested_fields` | Object | | -| `nested_objects` | Object | | -| `total_fields` | Object | | - -
-
- - Request body fields: index_settings > merge - - {: .text-delta} - -`merge` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `log_byte_size_policy` | Object | | -| `policy` | Object or String | Valid values are: `default`, `log_byte_size`, and `tiered`. | -| `policy.deletes_pct_allowed` | Float or String | | -| `policy.expunge_deletes_allowed` | Float or String | | -| `policy.floor_segment` | String | The unique identifier of a node. | -| `policy.max_merge_at_once` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `policy.max_merged_segment` | String | The unique identifier of a node. | -| `policy.reclaim_deletes_weight` | Float or String | | -| `policy.segments_per_tier` | Float or String | | -| `scheduler` | Object | | - -
-
- - Request body fields: index_settings > queries - - {: .text-delta} - -`queries` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `cache` | Object | | - -
-
- - Request body fields: index_settings > query_string - - {: .text-delta} - -`query_string` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > routing - - {: .text-delta} - -`routing` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `allocation` | Object | | -| `rebalance` | Object | | - -
-
- - Request body fields: index_settings > search - - {: .text-delta} - -`search` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `concurrent` | Object | | -| `concurrent_segment_search` | Object | | -| `default_pipeline` | String | | -| `idle` | Object | | -| `slowlog` | Object | | -| `throttled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | - -
-
- - Request body fields: index_settings > settings - - {: .text-delta} - -The index settings to be updated. - -`settings` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `-- freeform field --` | Object | | -| `analysis` | Object | | -| `analyze` | Object | | -| `analyze.max_token_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `auto_expand_replicas` | String | | -| `blocks` | Object | | -| `blocks.metadata` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read_only` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.read_only_allow_delete` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `blocks.write` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `check_on_startup` | String | Valid values are: `checksum`, `false`, and `true`. | -| `codec` | String | | -| `composite_index.star_tree` | Object | | -| `creation_date` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `creation_date_string` | Object or String | A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. | -| `default_pipeline` | String | | -| `final_pipeline` | String | | -| `format` | Float or String | | -| `gc_deletes` | String | 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. | -| `hidden` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `highlight` | Object | | -| `highlight.max_analyzed_offset` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `index` | Object | The index settings to be updated. | -| `indexing` | Object | | -| `indexing_pressure` | Object | | -| `knn` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `knn.algo_param.ef_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `lifecycle` | Object | | -| `lifecycle.name` | String | The name of a resource or configuration element. | -| `load_fixed_bitset_filters_eagerly` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `mapping` | Object | | -| `max_docvalue_fields_search` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_inner_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_ngram_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_refresh_listeners` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_regex_length` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_rescore_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_result_window` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_script_fields` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_shingle_diff` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_slices_per_scroll` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `max_terms_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `merge` | Object | | -| `merge.scheduler.max_thread_count` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `mode` | String | | -| `number_of_replicas` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `number_of_routing_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `number_of_shards` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `priority` | Float or String | | -| `provided_name` | String | The name of a resource or configuration element. | -| `queries` | Object | | -| `query_string` | Object | | -| `query_string.lenient` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `refresh_interval` | String | 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. | -| `routing` | Object | | -| `routing_partition_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `routing_path` | Array of Strings or String | | -| `search` | Object | | -| `search.idle.after` | String | 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. | -| `settings` | Object | The index settings to be updated. | -| `similarity` | Object | | -| `soft_deletes` | Object | | -| `soft_deletes.retention_lease.period` | String | 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. | -| `sort` | Object | | -| `store` | Object | | -| `top_metrics_max_size` | Integer or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `translog` | Object | | -| `translog.durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | -| `translog.flush_threshold_size` | String | The unique identifier of a node. | -| `uuid` | String | The universally unique identifier. | -| `verified_before_close` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `version` | Object | | - -
-
- - Request body fields: index_settings > similarity - - {: .text-delta} - -`similarity` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `bm25` | Object | | -| `dfi` | Object | | -| `dfr` | Object | | -| `ib` | Object | | -| `lmd` | Object | | -| `lmj` | Object | | -| `scripted_tfidf` | Object | | - -
-
- - Request body fields: index_settings > soft_deletes - - {: .text-delta} - -`soft_deletes` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `enabled` | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `retention` | Object | | -| `retention_lease` | Object | | - -
-
- - Request body fields: index_settings > sort - - {: .text-delta} - -`sort` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `field` | Array of Strings or String | | -| `missing` | Array of Strings or String | Valid values are: `_first`, and `_last`. | -| `mode` | Array of Strings or String | Valid values are: `max`, and `min`. | -| `order` | Array of Strings or String | Valid values are: `asc`, and `desc`. | - -
-
- - Request body fields: index_settings > store - - {: .text-delta} +## Request body fields -`store` is a JSON object with the following fields. +The request body is optional. It is a JSON object with the following fields. -| Property | Required | Data type | Description | +| Property | Data type | Description | Default | | :--- | :--- | :--- | :--- | -| `type` | **Required** | String | | -| `allow_mmap` | _Optional_ | Boolean or String | Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. | -| `fs` | _Optional_ | Object | | -| `hybrid` | _Optional_ | Object | | -| `preload` | _Optional_ | Array of Strings | | -| `stats_refresh_interval` | _Optional_ | String | 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. | - -
-
- - Request body fields: index_settings > translog - - {: .text-delta} - -`translog` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | -| `durability` | String | Valid values are: `ASYNC`, `REQUEST`, `async`, and `request`. | -| `flush_threshold_size` | String | The unique identifier of a node. | -| `generation_threshold_size` | String | The unique identifier of a node. | -| `retention` | Object | | -| `sync_interval` | String | 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. | +| `indices` | String or Array of Strings | A comma-separated list of data streams, indices, and aliases to restore from the snapshot. Supports wildcards (`*`). To restore all data streams and indices, omit this parameter or use `*` or `_all`. | All indices in the snapshot | +| `ignore_unavailable` | Boolean | When `true`, the request ignores any data streams and indices that are missing or closed. When `false`, the request returns an error for any missing or closed data streams or indices. | `false` | +| `include_global_state` | Boolean | When `true`, restores the cluster state from the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. | `false` | +| `include_aliases` | Boolean | When `true`, restores index aliases from the original snapshot. When `false`, aliases along with associated indices are not restored. | `true` | +| `partial` | Boolean | When `true`, allows the restoration of a partial snapshot from indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. When `false`, the entire restore operation fails if any indices in the snapshot do not have all primary shards available. | `false` | +| `index_settings` | Object | Index settings to add or change in all restored indices. Use this parameter to override index settings during snapshot restoration. For data streams, these settings are applied to the restored backing indices. | N/A | +| `ignore_index_settings` | Array of Strings | A comma-separated list of index settings that you don't want to restore from a snapshot. | N/A | +| `rename_pattern` | String | A pattern to apply to the restored data streams and indices. Data streams and indices matching the rename pattern will be renamed according to the `rename_replacement` setting. Uses regular expression syntax that supports referencing the original text. | N/A | +| `rename_replacement` | String | The replacement string used with `rename_pattern` to rename restored data streams and indices. | N/A | +| `rename_alias_pattern` | String | A pattern to apply to the restored aliases. Aliases matching the pattern will be renamed according to the `rename_alias_replacement` setting. Uses regular expression syntax that supports referencing the original text. | N/A | +| `rename_alias_replacement` | String | The replacement string used with `rename_alias_pattern` to rename restored aliases. | N/A | +| `source_remote_store_repository` | String | The name of the remote store repository of the source index being restored. If not provided, the Snapshot Restore API will use the repository that was registered when the snapshot was created. | N/A | +| `storage_type` | String | Where the authoritative store of the restored indices' data will be. A value of `local` indicates that all snapshot metadata and index data will be downloaded to local storage. A value of `remote_snapshot` indicates that snapshot metadata will be downloaded to the cluster, but the remote repository will remain the authoritative store of the index data, which will be downloaded and cached as needed. | `local` | -
-
- - Request body fields: index_settings > version - - {: .text-delta} +## Example request -`version` is a JSON object with the following fields. +The following request restores the `opendistro-reports-definitions` index from `my-first-snapshot`, renaming it to `opendistro-reports-definitions_restored` (because duplicate open index names in a cluster are not allowed): -| Property | Data type | Description | -| :--- | :--- | :--- | -| `created` | String | | -| `created_string` | String | | +```json +POST /_snapshot/my-opensearch-repo/my-first-snapshot/_restore +{ + "indices": "opendistro-reports-definitions", + "ignore_unavailable": true, + "include_global_state": false, + "rename_pattern": "(.+)", + "rename_replacement": "$1_restored", + "include_aliases": false +} +``` +{% include copy-curl.html %} -
-
- - Request body fields: index_settings > -- freeform field -- - - {: .text-delta} +## Example response -`-- freeform field --` is a JSON object with the following fields. +Upon success, the response returns the following JSON object: -| Property | Data type | Description | -| :--- | :--- | :--- | +```json +{ + "snapshot": { + "snapshot": "my-first-snapshot", + "indices": [], + "shards": { + "total": 0, + "failed": 0, + "successful": 0 + } + } +} +``` -
- +If open indices in a snapshot already exist in a cluster, and you don't delete, close, or rename them, the API returns an error. +{: .note} - ## Response body fields The response body is a JSON object with the following fields. @@ -5079,9 +126,9 @@ The response body is a JSON object with the following fields. | Property | Data type | Description | | :--- | :--- | :--- | | `accepted` | Boolean | Returns `true` if the restore was accepted. Present when the request had `wait_for_completion` set to `false`. | -| `snapshot` | Object | | +| `snapshot` | Object | Information about the restored snapshot. | -
+
Response body fields: snapshot @@ -5089,344 +136,26 @@ The response body is a JSON object with the following fields. `snapshot` is a JSON object with the following fields. -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `indices` | **Required** | Array of Strings | The list of indexes that were restored. | -| `shards` | **Required** | Object | Any statistics about the restored shards. | -| `snapshot` | **Required** | String | The name of the snapshot that was restored. | - -
-
- - Response body fields: snapshot > shards - - {: .text-delta} - -Any statistics about the restored shards. - -`shards` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `failed` | **Required** | Integer | | -| `successful` | **Required** | Integer | | -| `total` | **Required** | Integer | | -| `failures` | _Optional_ | Array of Objects | | -| `skipped` | _Optional_ | Integer | | - -
-
- - Response body fields: snapshot > shards > failures - - {: .text-delta} - -`failures` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `reason` | **Required** | Object | | -| `shard` | **Required** | Integer | | -| `index` | _Optional_ | String | | -| `node` | _Optional_ | String | | -| `status` | _Optional_ | String | | - -
-
- - Response body fields: snapshot > shards > failures > reason - - {: .text-delta} - -`reason` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by - - {: .text-delta} - -`caused_by` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > root_cause - - {: .text-delta} - -`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > suppressed - - {: .text-delta} - -`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > suppressed > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > root_cause > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Data type | Description | -| :--- | :--- | :--- | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > suppressed - - {: .text-delta} - -`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > caused_by > -- freeform field -- - - {: .text-delta} - -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. - | Property | Data type | Description | | :--- | :--- | :--- | +| `snapshot` | String | The name of the snapshot that was restored. | +| `indices` | Array of Strings | The list of indices that were restored. | +| `shards` | Object | Statistics about the restored shards. |
-
- - Response body fields: snapshot > shards > failures > reason > root_cause - - {: .text-delta} - -`root_cause` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
- - Response body fields: snapshot > shards > failures > reason > suppressed - - {: .text-delta} -`suppressed` is an __array of JSON objects__ (NDJSON). Each object has the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `type` | **Required** | String | The type of error. | -| `-- freeform field --` | _Optional_ | Object | Any additional information about the error. | -| `caused_by` | _Optional_ | Object | | -| `reason` | _Optional_ | String | A human-readable explanation of the error, in English. | -| `root_cause` | _Optional_ | Array of Objects | | -| `stack_trace` | _Optional_ | String | The server stack trace, present only if the `error_trace=true` parameter was sent with the request. | -| `suppressed` | _Optional_ | Array of Objects | | - -
-
+
- Response body fields: snapshot > shards > failures > reason > -- freeform field -- + Response body fields: snapshot > shards {: .text-delta} -Any additional information about the error. - -`-- freeform field --` is a JSON object with the following fields. +`shards` is a JSON object with the following fields. | Property | Data type | Description | | :--- | :--- | :--- | +| `total` | Integer | The total number of shards that were restored. | +| `successful` | Integer | The number of shards that were successfully restored. | +| `failed` | Integer | The number of shards that failed to be restored. | -
- - -## Endpoints - -```json -POST _snapshot///_restore -``` - -## Path parameters - -| Parameter | Data type | Description | -:--- | :--- | :--- -| repository | String | Repository containing the snapshot to restore. | -| snapshot | String | Snapshot to restore. | - -## Query parameters - -Parameter | Data type | Description -:--- | :--- | :--- -wait_for_completion | Boolean | Whether to wait for snapshot restoration to complete before continuing. | - -## Request body fields - -All request body parameters are optional. - -| Parameter | Data type | Description | -:--- | :--- | :--- -| ignore_unavailable | Boolean | How to handle data streams or indices that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. If `true`, the request ignores data streams and indices in indices that are missing or closed. Defaults to `false`. | -| ignore_index_settings | Boolean | A comma-delimited list of index settings that you don't want to restore from a snapshot. | -| include_aliases | Boolean | How to handle index aliases from the original snapshot. If `true`, index aliases from the original snapshot are restored. If `false`, aliases along with associated indices are not restored. Defaults to `true`. | -| include_global_state | Boolean | Whether to restore the current cluster state1. If `false`, the cluster state is not restored. If true, the current cluster state is restored. Defaults to `false`.| -| index_settings | String | A comma-delimited list of settings to add or change in all restored indices. Use this parameter to override index settings during snapshot restoration. For data streams, these index settings are applied to the restored backing indices. | -| indices | String | A comma-delimited list of data streams and indices to restore from the snapshot. Multi-index syntax is supported. By default, a restore operation includes all data streams and indices in the snapshot. If this argument is provided, the restore operation only includes the data streams and indices that you specify. | -| partial | Boolean | How the restore operation will behave if indices in the snapshot do not have all primary shards available. If `false`, the entire restore operation fails if any indices in the snapshot do not have all primary shards available.

If `true`, allows the restoration of a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot are restored. All missing shards are recreated as empty. By default, the entire restore operation fails if one or more indices included in the snapshot do not have all primary shards available. To change this behavior, set `partial` to `true`. Defaults to `false`. | -| rename_pattern | String | The pattern to apply to the restored data streams and indexes. Data streams and indexes matching the rename pattern will be renamed according to the `rename_replacement` setting.

The rename pattern is applied as defined by the regular expression that supports referencing the original text.

The request fails if two or more data streams or indexes are renamed to the same name. If you rename a restored data stream, its backing indexes are also renamed. For example, if you rename the logs data stream to `recovered-logs`, the backing index `.ds-logs-1` is renamed to `.ds-recovered-logs-1`.

If you rename a restored stream, ensure an index template matches the new stream name. If there are no matching index template names, the stream cannot roll over, and new backing indexes are not created.| -| rename_replacement | String | The rename replacement string.| -| rename_alias_pattern | String | The pattern to apply to the restored aliases. Aliases matching the rename pattern will be renamed according to the `rename_alias_replacement` setting.

The rename pattern is applied as defined by the regular expression that supports referencing the original text.

If two or more aliases are renamed to the same name, these aliases will be merged into one.| -| rename_alias_replacement | String | The rename replacement string for aliases.| -| source_remote_store_repository | String | The name of the remote store repository of the source index being restored. If not provided, the Snapshot Restore API will use the repository that was registered when the snapshot was created. -| wait_for_completion | Boolean | Whether to return a response after the restore operation has completed. If `false`, the request returns a response when the restore operation initializes. If `true`, the request returns a response when the restore operation completes. Defaults to `false`. | - -1The cluster state includes: -* Persistent cluster settings -* Index templates -* Legacy index templates -* Ingest pipelines -* Index lifecycle policies - -## Example request - -The following request restores the `opendistro-reports-definitions` index from `my-first-snapshot`. The `rename_pattern` and `rename_replacement` combination causes the index to be renamed to `opendistro-reports-definitions_restored` because duplicate open index names in a cluster are not allowed. - -````json -POST /_snapshot/my-opensearch-repo/my-first-snapshot/_restore -{ - "indices": "opendistro-reports-definitions", - "ignore_unavailable": true, - "include_global_state": false, - "rename_pattern": "(.+)", - "rename_replacement": "$1_restored", - "include_aliases": false -} -```` - -## Example response - -Upon success, the response returns the following JSON object: - -````json -{ - "snapshot" : { - "snapshot" : "my-first-snapshot", - "indices" : [ ], - "shards" : { - "total" : 0, - "failed" : 0, - "successful" : 0 - } - } -} -```` -Except for the snapshot name, all properties are empty or `0`. This is because any changes made to the volume after the snapshot was generated are lost. However, if you invoke the [Get snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot) API to examine the snapshot, a fully populated snapshot object is returned. - -## Response body fields - -| Field | Data type | Description | -| :--- | :--- | :--- | -| snapshot | string | Snapshot name. | -| indices | array | Indices in the snapshot. | -| shards | object | Total number of shards created along with number of successful and failed shards. | - -If open indices in a snapshot already exist in a cluster, and you don't delete, close, or rename them, the API returns an error like the following: -{: .note} - -````json -{ - "error" : { - "root_cause" : [ - { - "type" : "snapshot_restore_exception", - "reason" : "[my-opensearch-repo:my-first-snapshot/dCK4Qth-TymRQ7Tu7Iga0g] cannot restore index [.opendistro-reports-definitions] because an open index with same name already exists in the cluster. Either close or delete the existing index or restore the index under a different name by providing a rename pattern and replacement name" - } - ], - "type" : "snapshot_restore_exception", - "reason" : "[my-opensearch-repo:my-first-snapshot/dCK4Qth-TymRQ7Tu7Iga0g] cannot restore index [.opendistro-reports-definitions] because an open index with same name already exists in the cluster. Either close or delete the existing index or restore the index under a different name by providing a rename pattern and replacement name" - }, - "status" : 500 -} -```` +
\ No newline at end of file diff --git a/_api-reference/snapshots/verify-snapshot-repository.md b/_api-reference/snapshots/verify-snapshot-repository.md index e0256a85139..ddd8f0df0b9 100644 --- a/_api-reference/snapshots/verify-snapshot-repository.md +++ b/_api-reference/snapshots/verify-snapshot-repository.md @@ -2,17 +2,12 @@ layout: default title: Verify Snaphot Repository parent: Snapshot APIs - nav_order: 4 --- -# Verify snapshot repository -**Introduced 1.0** -{: .label .label-purple } - -Verifies that a snapshot repository is functional. Verifies the repository on each node in a cluster. +The Verify Snapshot Repository API confirms that a snapshot repository is functional across all nodes in a cluster. This verification helps ensure that the repository is properly configured and accessible before you attempt to create or restore snapshots. -If verification is successful, the verify snapshot repository API returns a list of nodes connected to the snapshot repository. If verification failed, the API returns an error. +If verification is successful, the API returns a list of nodes connected to the snapshot repository. If verification fails, the API returns an error. If you use the Security plugin, you must have the `manage cluster` privilege. {: .note} @@ -58,102 +53,65 @@ The following table lists the available query parameters. All query parameters a - -## Endpoints - -```json -GET _snapshot// -``` - -## Path parameters - -Path parameters are optional. - -| Parameter | Data type | Description | -:--- | :--- | :--- -| repository | String | Name of repository to verify. | - -## Query parameters - -| Parameter | Data type | Description | -:--- | :--- | :--- -| cluster_manager_timeout | Time | Amount of time to wait for a connection to the cluster manager node. Optional, defaults to `30s`. | -| timeout | Time | The period of time to wait for a response. If a response is not received before the timeout value, the request fails and returns an error. Defaults to `30s`. | - ## Example request -The following request verifies that the my-opensearch-repo is functional: +The following request verifies that the `my-opensearch-repo` repository is functional with custom timeout settings: -````json +```json POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s -```` +``` +{% include copy-curl.html %} ## Example response -The example that follows corresponds to the request above in the [Example request](#example-request) section. - -The `POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s` request returns the following fields: +The response includes a list of all nodes that can access the repository: -````json +```json { - "nodes" : { - "by1kztwTRoeCyg4iGU5Y8A" : { - "name" : "opensearch-node1" + "nodes": { + "by1kztwTRoeCyg4iGU5Y8A": { + "name": "opensearch-node1" } } } -```` +``` -In the preceding sample, one node is connected to the snapshot repository. If more were connected, you would see them in the response. Example: +In this example, one node is connected to the snapshot repository. If multiple nodes can access the repository, they would all be listed in the response, as shown in this example: -````json +```json { - "nodes" : { - "lcfL6jv2jo6sMEtp4idMvg" : { - "name" : "node-1" + "nodes": { + "lcfL6jv2jo6sMEtp4idMvg": { + "name": "node-1" }, - "rEPtFT/B+cuuOHnQn0jy4s" : { - "name" : "node-2" + "rEPtFT/B+cuuOHnQn0jy4s": { + "name": "node-2" + } } } -```` +``` - ## Response body fields The response body is a JSON object with the following fields. | Property | Required | Data type | Description | | :--- | :--- | :--- | :--- | -| `nodes` | **Required** | Object | | +| `nodes` | **Required** | Object | A map of node IDs to node information for each node that can access the repository. | -
+
Response body fields: nodes {: .text-delta} -`nodes` is a JSON object with the following fields. +For each node that can access the repository, the `nodes` object contains a key-value pair where: +- The key is the node ID (a string) +- The value is an object containing node information | Property | Data type | Description | | :--- | :--- | :--- | -| `-- freeform field --` | Object | | +| `name` | String | The name of the node. |
-
- - Response body fields: nodes > -- freeform field -- - - {: .text-delta} - -`-- freeform field --` is a JSON object with the following fields. - -| Property | Required | Data type | Description | -| :--- | :--- | :--- | :--- | -| `name` | **Required** | String | The name of a resource or configuration element. | -
- From d2f50ad01339a029e27bce4ed01434c46caa6fbb Mon Sep 17 00:00:00 2001 From: Archer Date: Mon, 28 Apr 2025 14:22:18 -0500 Subject: [PATCH 3/4] Fix vale errors Signed-off-by: Archer --- _api-reference/snapshots/create-snapshot.md | 10 ++++----- .../snapshots/delete-snapshot-repository.md | 2 +- _api-reference/snapshots/delete-snapshot.md | 8 +++---- .../snapshots/get-snapshot-status.md | 2 +- _api-reference/snapshots/get-snapshot.md | 8 +++---- _api-reference/snapshots/restore-snapshot.md | 22 +++++++++---------- 6 files changed, 25 insertions(+), 27 deletions(-) diff --git a/_api-reference/snapshots/create-snapshot.md b/_api-reference/snapshots/create-snapshot.md index 5f024c291c9..98e84319cf3 100644 --- a/_api-reference/snapshots/create-snapshot.md +++ b/_api-reference/snapshots/create-snapshot.md @@ -11,8 +11,8 @@ nav_order: 5 The Create Snapshot API creates a snapshot of your cluster's data within an existing repository. Snapshots serve as backups that you can use to restore your data or migrate it between clusters. -* For more information about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index). -* To view a list of your repositories, see [Get Snapshot Repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository). +* For more information about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index/). +* To view a list of your repositories, see [Get Snapshot Repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository/).