elasticsearch/_async/client/snapshot.py [514:656]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
repository: str,
snapshot: t.Union[str, t.Sequence[str]],
after: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
from_sort_value: t.Optional[str] = None,
human: t.Optional[bool] = None,
ignore_unavailable: t.Optional[bool] = None,
include_repository: t.Optional[bool] = None,
index_details: t.Optional[bool] = None,
index_names: t.Optional[bool] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
offset: t.Optional[int] = None,
order: t.Optional[t.Union[str, t.Literal["asc", "desc"]]] = None,
pretty: t.Optional[bool] = None,
size: t.Optional[int] = None,
slm_policy_filter: t.Optional[str] = None,
sort: t.Optional[
t.Union[
str,
t.Literal[
"duration",
"failed_shard_count",
"index_count",
"name",
"repository",
"shard_count",
"start_time",
],
]
] = None,
verbose: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
Get snapshot information.
NOTE: The after parameter and next field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.
It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.
Snapshots concurrently created may be seen during an iteration.
``_
:param repository: A comma-separated list of snapshot repository names used to
limit the request. Wildcard (`*`) expressions are supported.
:param snapshot: A comma-separated list of snapshot names to retrieve Wildcards
(`*`) are supported. * 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`.
:param after: An offset identifier to start pagination from as returned by the
next field in the response body.
:param from_sort_value: The value of the current sort column at which to start
retrieval. It can be a string `snapshot-` or a repository name when sorting
by snapshot or repository name. It can be a millisecond time value or a number
when sorting by `index-` or shard count.
:param ignore_unavailable: If `false`, the request returns an error for any snapshots
that are unavailable.
:param include_repository: If `true`, the response includes the repository name
in each snapshot.
:param index_details: If `true`, the response includes additional information
about each index in the snapshot comprising the number of shards in the index,
the total size of the index in bytes, and the maximum number of segments
per shard in the index. The default is `false`, meaning that this information
is omitted.
:param index_names: If `true`, the response includes the name of each index in
each snapshot.
:param master_timeout: The period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails
and returns an error.
:param offset: Numeric offset to start pagination from based on the snapshots
matching this request. Using a non-zero value for this parameter is mutually
exclusive with using the after parameter. Defaults to 0.
:param order: The sort order. Valid values are `asc` for ascending and `desc`
for descending order. The default behavior is ascending order.
:param size: The maximum number of snapshots to return. The default is 0, which
means to return all that match the request without limit.
:param slm_policy_filter: Filter snapshots by a comma-separated list of snapshot
lifecycle management (SLM) policy names that snapshots belong to. You can
use wildcards (`*`) and combinations of wildcards followed by exclude patterns
starting with `-`. For example, the pattern `*,-policy-a-\\*` will return
all snapshots except for those that were created by an SLM policy with a
name starting with `policy-a-`. Note that the wildcard pattern `*` matches
all snapshots created by an SLM policy but not those snapshots that were
not created by an SLM policy. To include snapshots that were not created
by an SLM policy, you can use the special pattern `_none` that will match
all snapshots without an SLM policy.
:param sort: The sort order for the result. The default behavior is sorting by
snapshot start time stamp.
:param verbose: If `true`, returns additional information about each snapshot
such as the version of Elasticsearch which took the snapshot, the start and
end times of the snapshot, and the number of shards snapshotted. NOTE: The
parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`,
and `sort` are not supported when you set `verbose=false` and the sort order
for requests with `verbose=false` is undefined.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'repository'")
if snapshot in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'snapshot'")
__path_parts: t.Dict[str, str] = {
"repository": _quote(repository),
"snapshot": _quote(snapshot),
}
__path = f'/_snapshot/{__path_parts["repository"]}/{__path_parts["snapshot"]}'
__query: t.Dict[str, t.Any] = {}
if after is not None:
__query["after"] = after
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if from_sort_value is not None:
__query["from_sort_value"] = from_sort_value
if human is not None:
__query["human"] = human
if ignore_unavailable is not None:
__query["ignore_unavailable"] = ignore_unavailable
if include_repository is not None:
__query["include_repository"] = include_repository
if index_details is not None:
__query["index_details"] = index_details
if index_names is not None:
__query["index_names"] = index_names
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if offset is not None:
__query["offset"] = offset
if order is not None:
__query["order"] = order
if pretty is not None:
__query["pretty"] = pretty
if size is not None:
__query["size"] = size
if slm_policy_filter is not None:
__query["slm_policy_filter"] = slm_policy_filter
if sort is not None:
__query["sort"] = sort
if verbose is not None:
__query["verbose"] = verbose
__headers = {"accept": "application/json"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elasticsearch/_sync/client/snapshot.py [514:656]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
repository: str,
snapshot: t.Union[str, t.Sequence[str]],
after: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
from_sort_value: t.Optional[str] = None,
human: t.Optional[bool] = None,
ignore_unavailable: t.Optional[bool] = None,
include_repository: t.Optional[bool] = None,
index_details: t.Optional[bool] = None,
index_names: t.Optional[bool] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
offset: t.Optional[int] = None,
order: t.Optional[t.Union[str, t.Literal["asc", "desc"]]] = None,
pretty: t.Optional[bool] = None,
size: t.Optional[int] = None,
slm_policy_filter: t.Optional[str] = None,
sort: t.Optional[
t.Union[
str,
t.Literal[
"duration",
"failed_shard_count",
"index_count",
"name",
"repository",
"shard_count",
"start_time",
],
]
] = None,
verbose: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
Get snapshot information.
NOTE: The after parameter and next field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.
It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.
Snapshots concurrently created may be seen during an iteration.
``_
:param repository: A comma-separated list of snapshot repository names used to
limit the request. Wildcard (`*`) expressions are supported.
:param snapshot: A comma-separated list of snapshot names to retrieve Wildcards
(`*`) are supported. * 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`.
:param after: An offset identifier to start pagination from as returned by the
next field in the response body.
:param from_sort_value: The value of the current sort column at which to start
retrieval. It can be a string `snapshot-` or a repository name when sorting
by snapshot or repository name. It can be a millisecond time value or a number
when sorting by `index-` or shard count.
:param ignore_unavailable: If `false`, the request returns an error for any snapshots
that are unavailable.
:param include_repository: If `true`, the response includes the repository name
in each snapshot.
:param index_details: If `true`, the response includes additional information
about each index in the snapshot comprising the number of shards in the index,
the total size of the index in bytes, and the maximum number of segments
per shard in the index. The default is `false`, meaning that this information
is omitted.
:param index_names: If `true`, the response includes the name of each index in
each snapshot.
:param master_timeout: The period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails
and returns an error.
:param offset: Numeric offset to start pagination from based on the snapshots
matching this request. Using a non-zero value for this parameter is mutually
exclusive with using the after parameter. Defaults to 0.
:param order: The sort order. Valid values are `asc` for ascending and `desc`
for descending order. The default behavior is ascending order.
:param size: The maximum number of snapshots to return. The default is 0, which
means to return all that match the request without limit.
:param slm_policy_filter: Filter snapshots by a comma-separated list of snapshot
lifecycle management (SLM) policy names that snapshots belong to. You can
use wildcards (`*`) and combinations of wildcards followed by exclude patterns
starting with `-`. For example, the pattern `*,-policy-a-\\*` will return
all snapshots except for those that were created by an SLM policy with a
name starting with `policy-a-`. Note that the wildcard pattern `*` matches
all snapshots created by an SLM policy but not those snapshots that were
not created by an SLM policy. To include snapshots that were not created
by an SLM policy, you can use the special pattern `_none` that will match
all snapshots without an SLM policy.
:param sort: The sort order for the result. The default behavior is sorting by
snapshot start time stamp.
:param verbose: If `true`, returns additional information about each snapshot
such as the version of Elasticsearch which took the snapshot, the start and
end times of the snapshot, and the number of shards snapshotted. NOTE: The
parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`,
and `sort` are not supported when you set `verbose=false` and the sort order
for requests with `verbose=false` is undefined.
"""
if repository in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'repository'")
if snapshot in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'snapshot'")
__path_parts: t.Dict[str, str] = {
"repository": _quote(repository),
"snapshot": _quote(snapshot),
}
__path = f'/_snapshot/{__path_parts["repository"]}/{__path_parts["snapshot"]}'
__query: t.Dict[str, t.Any] = {}
if after is not None:
__query["after"] = after
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if from_sort_value is not None:
__query["from_sort_value"] = from_sort_value
if human is not None:
__query["human"] = human
if ignore_unavailable is not None:
__query["ignore_unavailable"] = ignore_unavailable
if include_repository is not None:
__query["include_repository"] = include_repository
if index_details is not None:
__query["index_details"] = index_details
if index_names is not None:
__query["index_names"] = index_names
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if offset is not None:
__query["offset"] = offset
if order is not None:
__query["order"] = order
if pretty is not None:
__query["pretty"] = pretty
if size is not None:
__query["size"] = size
if slm_policy_filter is not None:
__query["slm_policy_filter"] = slm_policy_filter
if sort is not None:
__query["sort"] = sort
if verbose is not None:
__query["verbose"] = verbose
__headers = {"accept": "application/json"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -