Skip to content

Commit

Permalink
Restore Snapshot Request: Add line breaks
Browse files Browse the repository at this point in the history
Signed-off-by: Spencer G. Jones <spencer.jones2@tylertech.com>
  • Loading branch information
mispencer committed Nov 18, 2024
1 parent c6b437a commit 0ba119d
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions spec/namespaces/snapshot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -357,17 +357,27 @@ components:
$ref: '../schemas/_common.yaml#/components/schemas/Indices'
partial:
type: boolean
description: 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`.
description: |-
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:
type: string
description: The 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. 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 indices are renamed into the same name. If you rename a restored data stream, its backing indices 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 indices are not created.
description: |-
The 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.
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 indices are renamed into the same name.
If you rename a restored data stream, its backing indices 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 indices are not created.
rename_replacement:
type: string
description: The rename replacement string.
rename_alias_pattern:
x-version-added: '2.18'
type: string
description: 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.
description: |-
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.
rename_alias_replacement:
x-version-added: '2.18'
type: string
Expand All @@ -379,7 +389,11 @@ components:
storage_type:
x-version-added: '2.7'
type: string
description: '`local` indicates that all snapshot metadata and index data will be downloaded to local storage. `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`. Defaults to `local`.'
description: |-
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`.
Defaults to `local`.
description: Details of what to restore
responses:
snapshot.cleanup_repository@200:
Expand Down

0 comments on commit 0ba119d

Please sign in to comment.