Struct How

pub struct How {
    pub be_nice: bool,
    pub client_timeout: Duration,
    pub api_token: Option<String>,
    pub trace_context: Option<TraceContext>,
}

Controls of how to execute a task

Fields

be_nice: bool

The be-nice flag is used to reduce load for the models you intend to use. This is commonly used if you are conducting experiments or trying things out that create a large load on the aleph-alpha-api and you do not want to increase queue time for other users too much.

(!) This increases how often you get a Busy response.

client_timeout: Duration

The maximum duration of a request before the client cancels the request. This is not passed on to the server but only handled by the client locally, i.e. the client will not wait longer than this duration for a response.

api_token: Option<String>

API token used to authenticate the request, overwrites the default token provided on setup Default token may not provide the tracking or permission that is wanted for the request

trace_context: Option<TraceContext>

Optionally pass a trace context to propagate tracing information through distributed systems.

Trait Implementations

impl Clone for How

fn clone(&self) -> How

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for How

fn default() -> Self

Returns the “default value” for a type.

impl Hash for How

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for How

fn eq(&self, other: &How) -> 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 Eq for How

impl StructuralPartialEq for How