Struct HttpRetryPolicy

#[non_exhaustive]
pub struct HttpRetryPolicy {
    pub per_retry_timeout: Option<Duration>,
    pub max_retries: i64,
    pub http_retry_events: Option<Vec<String>>,
    pub tcp_retry_events: Option<Vec<TcpRetryPolicyEvent>>,
}

An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout. Both server-error and gateway-error under httpRetryEvents include the Envoy reset policy. For more information on the reset policy, see the Envoy documentation.

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.

per_retry_timeout: Option<Duration>

The timeout for each retry attempt.

max_retries: i64

The maximum number of retry attempts.

http_retry_events: Option<Vec<String>>

Specify at least one of the following values.

• server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

• gateway-error – HTTP status codes 502, 503, and 504

• client-error – HTTP status code 409

• stream-error – Retry on refused stream

tcp_retry_events: Option<Vec<TcpRetryPolicyEvent>>

Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

Implementations

impl HttpRetryPolicy

pub fn per_retry_timeout(&self) -> Option<&Duration>

The timeout for each retry attempt.

pub fn max_retries(&self) -> i64

The maximum number of retry attempts.

pub fn http_retry_events(&self) -> &[String]

Specify at least one of the following values.

• server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

• gateway-error – HTTP status codes 502, 503, and 504

• client-error – HTTP status code 409

• stream-error – Retry on refused stream

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .http_retry_events.is_none().

pub fn tcp_retry_events(&self) -> &[TcpRetryPolicyEvent]

Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tcp_retry_events.is_none().

impl HttpRetryPolicy

pub fn builder() -> HttpRetryPolicyBuilder

Creates a new builder-style object to manufacture HttpRetryPolicy.

Trait Implementations

impl Clone for HttpRetryPolicy

fn clone(&self) -> HttpRetryPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRetryPolicy

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

Formats the value using the given formatter.

impl PartialEq for HttpRetryPolicy

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