Struct opensearch::SearchShards

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

Builder for the Search Shards API

Returns information about the indices and shards that a search request would be executed against.

Implementations

impl<'a, 'b, B> SearchShards<'a, 'b, B>

where B: Body,

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

Creates a new instance of SearchShards with the specified API parts

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

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

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

where T: Serialize,

The body for the API call

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

Include the stack trace of returned errors.

pub fn expand_wildcards(self, expand_wildcards: &'b [ExpandWildcards]) -> Self

Whether to expand wildcard expression to concrete indices that are open, closed or both.

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 ignore_unavailable(self, ignore_unavailable: bool) -> Self

Whether specified concrete indices should be ignored when unavailable (missing or closed)

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

Return local information, do not retrieve the state from cluster-manager node (default: false)

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

Specify the node or shard the operation should be performed on (default: random)

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

Specific routing 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 async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Search Shards API that can be awaited

Trait Implementations

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

fn clone(&self) -> SearchShards<'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 SearchShards<'a, 'b, B>

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

Formats the value using the given formatter.