Struct HTTPRouteRulesRetry

pub struct HTTPRouteRulesRetry {
    pub attempts: Option<i64>,
    pub backoff: Option<String>,
    pub codes: Option<Vec<i64>>,
}

Retry defines the configuration for when to retry an HTTP request.

Support: Extended

Fields

attempts: Option<i64>

Attempts specifies the maxmimum number of times an individual request from the gateway to a backend should be retried.

If the maximum number of retries has been attempted without a successful response from the backend, the Gateway MUST return an error.

When this field is unspecified, the number of times to attempt to retry a backend request is implementation-specific.

Support: Extended

backoff: Option<String>

Backoff specifies the minimum duration a Gateway should wait between retry attempts and is represented in Gateway API Duration formatting.

For example, setting the rules[].retry.backoff field to the value 100ms will cause a backend request to first be retried approximately 100 milliseconds after timing out or receiving a response code configured to be retryable.

An implementation MAY use an exponential or alternative backoff strategy for subsequent retry attempts, MAY cap the maximum backoff duration to some amount greater than the specified minimum, and MAY add arbitrary jitter to stagger requests, as long as unsuccessful backend requests are not retried before the configured minimum duration.

If a Request timeout (rules[].timeouts.request) is configured on the route, the entire duration of the initial request and any retry attempts MUST not exceed the Request timeout duration. If any retry attempts are still in progress when the Request timeout duration has been reached, these SHOULD be canceled if possible and the Gateway MUST immediately return a timeout error.

If a BackendRequest timeout (rules[].timeouts.backendRequest) is configured on the route, any retry attempts which reach the configured BackendRequest timeout duration without a response SHOULD be canceled if possible and the Gateway should wait for at least the specified backoff duration before attempting to retry the backend request again.

If a BackendRequest timeout is not configured on the route, retry attempts MAY time out after an implementation default duration, or MAY remain pending until a configured Request timeout or implementation default duration for total request time is reached.

When this field is unspecified, the time to wait between retry attempts is implementation-specific.

Support: Extended

codes: Option<Vec<i64>>

Codes defines the HTTP response status codes for which a backend request should be retried.

Support: Extended

Trait Implementations

impl Clone for HTTPRouteRulesRetry

fn clone(&self) -> HTTPRouteRulesRetry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HTTPRouteRulesRetry

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

Formats the value using the given formatter.

impl Default for HTTPRouteRulesRetry

fn default() -> HTTPRouteRulesRetry

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HTTPRouteRulesRetry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for HTTPRouteRulesRetry

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for HTTPRouteRulesRetry

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

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 HTTPRouteRulesRetry