Struct elasticsearch::snapshot::SnapshotGet

pub struct SnapshotGet<'a, 'b> { /* private fields */ }

Builder for the Snapshot Get API

Returns information about a snapshot.

Implementations

impl<'a, 'b> SnapshotGet<'a, 'b>

pub fn new(transport: &'a Transport, parts: SnapshotGetParts<'b>) -> Self

Creates a new instance of SnapshotGet with the specified API parts

pub fn after(self, after: &'b str) -> Self

Offset identifier to start pagination from as returned by the ‘next’ field in the response body.

pub fn error_trace(self, error_trace: bool) -> Self

Include the stack trace of returned errors.

pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self

A comma-separated list of filters used to reduce the response.

pub fn from_sort_value(self, from_sort_value: &'b str) -> Self

Value of the current sort column at which to start retrieval.

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

pub fn human(self, human: bool) -> Self

Return human readable values for statistics.

pub fn ignore_unavailable(self, ignore_unavailable: bool) -> Self

Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown

pub fn include_repository(self, include_repository: bool) -> Self

Whether to include the repository name in the snapshot info. Defaults to true.

pub fn index_details(self, index_details: bool) -> Self

Whether to include details of each index in the snapshot, if those details are available. Defaults to false.

pub fn index_names(self, index_names: bool) -> Self

Whether to include the name of each index in the snapshot. Defaults to true.

pub fn master_timeout(self, master_timeout: &'b str) -> Self

Explicit operation timeout for connection to master node

pub fn offset(self, offset: &'b str) -> Self

Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0

pub fn order(self, order: Order) -> Self

Sort order

pub fn pretty(self, pretty: bool) -> Self

Pretty format the returned JSON response.

pub fn request_timeout(self, timeout: Duration) -> Self

Sets a request timeout for this API call.

The timeout is applied from when the request starts connecting until the response body has finished.

pub fn size(self, size: &'b str) -> Self

Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit.

pub fn slm_policy_filter(self, slm_policy_filter: &'b str) -> Self

Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern ‘_none’ to match snapshots without an SLM policy

pub fn sort(self, sort: Sort) -> Self

Allows setting a sort order for the result. Defaults to start_time

pub fn source(self, source: &'b str) -> Self

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

pub fn verbose(self, verbose: bool) -> Self

Whether to show verbose snapshot info or only show the basic info found in the repository index blob

pub async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Snapshot Get API that can be awaited

Trait Implementations

impl<'a, 'b> Clone for SnapshotGet<'a, 'b>

fn clone(&self) -> SnapshotGet<'a, 'b>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, 'b> Debug for SnapshotGet<'a, 'b>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.