Struct LongRunning

#[non_exhaustive]
pub struct LongRunning {
    pub initial_poll_delay: Option<Duration>,
    pub poll_delay_multiplier: f32,
    pub max_poll_delay: Option<Duration>,
    pub total_poll_timeout: Option<Duration>,
}

Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. Java).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

initial_poll_delay: Option<Duration>

Initial delay after which the first poll request will be made. Default value: 5 seconds.

poll_delay_multiplier: f32

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.

max_poll_delay: Option<Duration>

Maximum time between two subsequent poll requests. Default value: 45 seconds.

total_poll_timeout: Option<Duration>

Total polling timeout. Default value: 5 minutes.

Implementations

impl LongRunning

pub fn set_initial_poll_delay<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of initial_poll_delay.

pub fn set_poll_delay_multiplier<T: Into<f32>>(self, v: T) -> Self

Sets the value of poll_delay_multiplier.

pub fn set_max_poll_delay<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of max_poll_delay.

pub fn set_total_poll_timeout<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of total_poll_timeout.

Trait Implementations

impl Clone for LongRunning

fn clone(&self) -> LongRunning

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LongRunning

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

Formats the value using the given formatter.

impl Default for LongRunning

fn default() -> LongRunning

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LongRunning

where LongRunning: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for LongRunning

fn typename() -> &'static str

The typename of this message.

impl PartialEq for LongRunning

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

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 LongRunning