Struct elasticsearch::snapshot::SnapshotRepositoryAnalyze

pub struct SnapshotRepositoryAnalyze<'a, 'b, B> { /* fields omitted */ }

Builder for the Snapshot Repository Analyze API

Analyzes a repository for correctness and performance

Implementations

impl<'a, 'b, B> SnapshotRepositoryAnalyze<'a, 'b, B> where
    B: Body, 

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

Creates a new instance of SnapshotRepositoryAnalyze with the specified API parts

pub fn blob_count(self, blob_count: i64) -> Self

Number of blobs to create during the test. Defaults to 100.

pub fn body<T>(self, body: T) -> SnapshotRepositoryAnalyze<'a, 'b, JsonBody<T>> where
    T: Serialize, 

The body for the API call

pub fn concurrency(self, concurrency: i64) -> Self

Number of operations to run concurrently during the test. Defaults to 10.

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

Whether to return detailed results or a summary. Defaults to ‘false’ so that only the summary is returned.

pub fn early_read_node_count(self, early_read_node_count: i64) -> Self

Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the ‘rare_action_probability’ parameter is also relevant. Defaults to 2.

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 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 max_blob_size(self, max_blob_size: &'b str) -> Self

Maximum size of a blob to create during the test, e.g ‘1gb’ or ‘100mb’. Defaults to ‘10mb’.

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

Maximum total size of all blobs to create during the test, e.g ‘1tb’ or ‘100gb’. Defaults to ‘1gb’.

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

Pretty format the returned JSON response.

pub fn rare_action_probability(self, rare_action_probability: i64) -> Self

Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02.

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

Whether to rarely abort writes before they complete. Defaults to ‘true’.

pub fn read_node_count(self, read_node_count: i64) -> Self

Number of nodes on which to read a blob after writing. Defaults to 10.

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 seed(self, seed: i64) -> Self

Seed for the random number generator used to create the test workload. Defaults to a random value.

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 timeout(self, timeout: &'b str) -> Self

Explicit operation timeout. Defaults to ‘30s’.

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

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

Trait Implementations

impl<'a, 'b, B: Clone> Clone for SnapshotRepositoryAnalyze<'a, 'b, B>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, 'b, B: Debug> Debug for SnapshotRepositoryAnalyze<'a, 'b, B>

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

Formats the value using the given formatter.