Struct QueryOptions

pub struct QueryOptions {

    pub wait_index: u64,
    pub prefix: String,
    pub params: HashMap<String, String>,
    pub headers: HashMap<String, String>,
    pub allow_stale: bool,
    pub next_token: String,
    pub reverse: bool,
    pub per_page: i32,
    pub filter: String,
    pub namespace: String,
    pub wait_time: TimeDelta,
    pub auth_token: String,
    pub region: String,
}

QueryOptions are used to parametrize a query

This struct was generated based on the Go types of the official Nomad API client.

Fields

wait_index: u64

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

prefix: String

If set, used as prefix for resource list searches

params: HashMap<String, String>

Set HTTP parameters on the query.

headers: HashMap<String, String>

Set HTTP headers on the query.

allow_stale: bool

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

next_token: String

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.

reverse: bool

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

Currently only supported by specific endpoints.

per_page: i32

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

filter: String

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

namespace: String

Namespace is the target namespace for the query.

wait_time: TimeDelta

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

auth_token: String

AuthToken is the secret ID of an ACL token

region: String

Providing a datacenter overwrites the region provided by the Config

Implementations

impl QueryOptions

pub fn builder() -> QueryOptionsBuilder

Trait Implementations

impl Clone for QueryOptions

fn clone(&self) -> QueryOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for QueryOptions

fn eq(&self, other: &QueryOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for QueryOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QueryOptions