Struct bigml::wait::WaitOptions

pub struct WaitOptions { /* fields omitted */ }

Options controlling how long we wait and what makes us give up. This uses a "builder" pattern, so you can write:

use std::time::Duration;
use bigml::wait::WaitOptions;

let options = WaitOptions::default()
    .timeout(Duration::from_secs(120))
    .allowed_errors(5);

Methods

impl WaitOptions

pub fn timeout<D: Into<Option<Duration>>>(self, timeout: D) -> Self

Set an optional timeout after which to abandon this wait.

pub fn retry_interval(self, interval: Duration) -> Self

How long should we wait between retries? Defaults to 10 seconds. Note that BigML has suggested not polling more often than every 4 seconds, (to avoid losing API access) so if you set a lower value, this will be

pub fn backoff_type(self, backoff_type: BackoffType) -> Self

Should we use linear (default) or exponential backoff?

pub fn allowed_errors(self, count: u16) -> Self

How many errors should be ignored before giving up? This can be useful for long-running Execution jobs, where we don't want a transient network error to result in failure.

Trait Implementations

impl Default for WaitOptions

fn default() -> Self

Returns the "default value" for a type.