Struct QueryOptionsBuilder

pub struct QueryOptionsBuilder { /* private fields */ }

Builder for QueryOptions.

Implementations

impl QueryOptionsBuilder

pub fn region(&mut self, value: String) -> &mut Self

Providing a datacenter overwrites the region provided by the Config

pub fn allow_stale(&mut self, value: bool) -> &mut Self

AllowStale allows any Nomad server (non-leader) to service a read. This allows for lower latency and higher throughput

pub fn auth_token(&mut self, value: String) -> &mut Self

AuthToken is the secret ID of an ACL token

pub fn wait_index(&mut self, value: u64) -> &mut Self

WaitIndex is used to enable a blocking query. Waits until the timeout or the next index is reached

pub fn prefix(&mut self, value: String) -> &mut Self

If set, used as prefix for resource list searches

pub fn next_token(&mut self, value: String) -> &mut Self

NextToken is the token used to indicate where to start paging for queries that support paginated lists. This token should be the ID of the next object after the last one seen in the previous response.

pub fn namespace(&mut self, value: String) -> &mut Self

Namespace is the target namespace for the query.

pub fn filter(&mut self, value: String) -> &mut Self

Filter specifies the go-bexpr filter expression to be used for filtering the data prior to returning a response

pub fn reverse(&mut self, value: bool) -> &mut Self

Reverse is used to reverse the default order of list results.

Currently only supported by specific endpoints.

pub fn wait_time(&mut self, value: TimeDelta) -> &mut Self

WaitTime is used to bound the duration of a wait. Defaults to that of the Config, but can be overridden.

pub fn params(&mut self, value: HashMap<String, String>) -> &mut Self

Set HTTP parameters on the query.

pub fn headers(&mut self, value: HashMap<String, String>) -> &mut Self

Set HTTP headers on the query.

pub fn per_page(&mut self, value: i32) -> &mut Self

PerPage is the number of entries to be returned in queries that support paginated lists.

pub fn build(&self) -> Result<QueryOptions, QueryOptionsBuilderError>

Builds a new QueryOptions.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for QueryOptionsBuilder

fn clone(&self) -> QueryOptionsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for QueryOptionsBuilder

fn default() -> Self

Returns the “default value” for a type.