Package io.envoyproxy.envoy.api.v2.route

Interface RetryPolicyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RetryPolicy, RetryPolicy.Builder
    public interface RetryPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getRetryOn

        String getRetryOn()
         Specifies the conditions under which retry takes place. These are the same
 conditions documented for :ref:`config_http_filters_router_x-envoy-retry-on` and
 :ref:`config_http_filters_router_x-envoy-retry-grpc-on`.
        string retry_on = 1;
        Returns:
        The retryOn.

      • getRetryOnBytes

        com.google.protobuf.ByteString getRetryOnBytes()
         Specifies the conditions under which retry takes place. These are the same
 conditions documented for :ref:`config_http_filters_router_x-envoy-retry-on` and
 :ref:`config_http_filters_router_x-envoy-retry-grpc-on`.
        string retry_on = 1;
        Returns:
        The bytes for retryOn.

      • hasNumRetries

        boolean hasNumRetries()
         Specifies the allowed number of retries. This parameter is optional and
 defaults to 1. These are the same conditions documented for
 :ref:`config_http_filters_router_x-envoy-max-retries`.
        .google.protobuf.UInt32Value num_retries = 2;
        Returns:
        Whether the numRetries field is set.

      • getNumRetries

        com.google.protobuf.UInt32Value getNumRetries()
         Specifies the allowed number of retries. This parameter is optional and
 defaults to 1. These are the same conditions documented for
 :ref:`config_http_filters_router_x-envoy-max-retries`.
        .google.protobuf.UInt32Value num_retries = 2;
        Returns:
        The numRetries.

      • getNumRetriesOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getNumRetriesOrBuilder()
         Specifies the allowed number of retries. This parameter is optional and
 defaults to 1. These are the same conditions documented for
 :ref:`config_http_filters_router_x-envoy-max-retries`.
        .google.protobuf.UInt32Value num_retries = 2;

      • hasPerTryTimeout

        boolean hasPerTryTimeout()
         Specifies a non-zero upstream timeout per retry attempt. This parameter is optional. The
 same conditions documented for
 :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms` apply.
 .. note::
   If left unspecified, Envoy will use the global
   :ref:`route timeout <envoy_api_field_route.RouteAction.timeout>` for the request.
   Consequently, when using a :ref:`5xx <config_http_filters_router_x-envoy-retry-on>` based
   retry policy, a request that times out will not be retried as the total timeout budget
   would have been exhausted.
        .google.protobuf.Duration per_try_timeout = 3;
        Returns:
        Whether the perTryTimeout field is set.

      • getPerTryTimeout

        com.google.protobuf.Duration getPerTryTimeout()
         Specifies a non-zero upstream timeout per retry attempt. This parameter is optional. The
 same conditions documented for
 :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms` apply.
 .. note::
   If left unspecified, Envoy will use the global
   :ref:`route timeout <envoy_api_field_route.RouteAction.timeout>` for the request.
   Consequently, when using a :ref:`5xx <config_http_filters_router_x-envoy-retry-on>` based
   retry policy, a request that times out will not be retried as the total timeout budget
   would have been exhausted.
        .google.protobuf.Duration per_try_timeout = 3;
        Returns:
        The perTryTimeout.

      • getPerTryTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getPerTryTimeoutOrBuilder()
         Specifies a non-zero upstream timeout per retry attempt. This parameter is optional. The
 same conditions documented for
 :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms` apply.
 .. note::
   If left unspecified, Envoy will use the global
   :ref:`route timeout <envoy_api_field_route.RouteAction.timeout>` for the request.
   Consequently, when using a :ref:`5xx <config_http_filters_router_x-envoy-retry-on>` based
   retry policy, a request that times out will not be retried as the total timeout budget
   would have been exhausted.
        .google.protobuf.Duration per_try_timeout = 3;

      • hasRetryPriority

        boolean hasRetryPriority()
         Specifies an implementation of a RetryPriority which is used to determine the
 distribution of load across priorities used for retries. Refer to
 :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more details.
        .envoy.api.v2.route.RetryPolicy.RetryPriority retry_priority = 4;
        Returns:
        Whether the retryPriority field is set.

      • getRetryPriority

        RetryPolicy.RetryPriority getRetryPriority()
         Specifies an implementation of a RetryPriority which is used to determine the
 distribution of load across priorities used for retries. Refer to
 :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more details.
        .envoy.api.v2.route.RetryPolicy.RetryPriority retry_priority = 4;
        Returns:
        The retryPriority.

      • getRetryPriorityOrBuilder

        RetryPolicy.RetryPriorityOrBuilder getRetryPriorityOrBuilder()
         Specifies an implementation of a RetryPriority which is used to determine the
 distribution of load across priorities used for retries. Refer to
 :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more details.
        .envoy.api.v2.route.RetryPolicy.RetryPriority retry_priority = 4;

      • getRetryHostPredicateList

        List<RetryPolicy.RetryHostPredicate> getRetryHostPredicateList()
         Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
        repeated .envoy.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

      • getRetryHostPredicate

        RetryPolicy.RetryHostPredicate getRetryHostPredicate​(int index)
         Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
        repeated .envoy.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

      • getRetryHostPredicateCount

        int getRetryHostPredicateCount()
         Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
        repeated .envoy.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

      • getRetryHostPredicateOrBuilderList

        List<? extends RetryPolicy.RetryHostPredicateOrBuilder> getRetryHostPredicateOrBuilderList()
         Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
        repeated .envoy.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

      • getRetryHostPredicateOrBuilder

        RetryPolicy.RetryHostPredicateOrBuilder getRetryHostPredicateOrBuilder​(int index)
         Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
        repeated .envoy.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

      • getHostSelectionRetryMaxAttempts

        long getHostSelectionRetryMaxAttempts()
         The maximum number of times host selection will be reattempted before giving up, at which
 point the host that was last selected will be routed to. If unspecified, this will default to
 retrying once.
        int64 host_selection_retry_max_attempts = 6;
        Returns:
        The hostSelectionRetryMaxAttempts.

      • getRetriableStatusCodesList

        List<Integer> getRetriableStatusCodesList()
         HTTP status codes that should trigger a retry in addition to those specified by retry_on.
        repeated uint32 retriable_status_codes = 7;
        Returns:
        A list containing the retriableStatusCodes.

      • getRetriableStatusCodesCount

        int getRetriableStatusCodesCount()
         HTTP status codes that should trigger a retry in addition to those specified by retry_on.
        repeated uint32 retriable_status_codes = 7;
        Returns:
        The count of retriableStatusCodes.

      • getRetriableStatusCodes

        int getRetriableStatusCodes​(int index)
         HTTP status codes that should trigger a retry in addition to those specified by retry_on.
        repeated uint32 retriable_status_codes = 7;
        Parameters:
        index - The index of the element to return.
        Returns:
        The retriableStatusCodes at the given index.

      • hasRetryBackOff

        boolean hasRetryBackOff()
         Specifies parameters that control retry back off. This parameter is optional, in which case the
 default base interval is 25 milliseconds or, if set, the current value of the
 `upstream.base_retry_backoff_ms` runtime parameter. The default maximum interval is 10 times
 the base interval. The documentation for :ref:`config_http_filters_router_x-envoy-max-retries`
 describes Envoy's back-off algorithm.
        .envoy.api.v2.route.RetryPolicy.RetryBackOff retry_back_off = 8;
        Returns:
        Whether the retryBackOff field is set.

      • getRetryBackOff

        RetryPolicy.RetryBackOff getRetryBackOff()
         Specifies parameters that control retry back off. This parameter is optional, in which case the
 default base interval is 25 milliseconds or, if set, the current value of the
 `upstream.base_retry_backoff_ms` runtime parameter. The default maximum interval is 10 times
 the base interval. The documentation for :ref:`config_http_filters_router_x-envoy-max-retries`
 describes Envoy's back-off algorithm.
        .envoy.api.v2.route.RetryPolicy.RetryBackOff retry_back_off = 8;
        Returns:
        The retryBackOff.

      • getRetryBackOffOrBuilder

        RetryPolicy.RetryBackOffOrBuilder getRetryBackOffOrBuilder()
         Specifies parameters that control retry back off. This parameter is optional, in which case the
 default base interval is 25 milliseconds or, if set, the current value of the
 `upstream.base_retry_backoff_ms` runtime parameter. The default maximum interval is 10 times
 the base interval. The documentation for :ref:`config_http_filters_router_x-envoy-max-retries`
 describes Envoy's back-off algorithm.
        .envoy.api.v2.route.RetryPolicy.RetryBackOff retry_back_off = 8;

      • getRetriableHeadersList

        List<HeaderMatcher> getRetriableHeadersList()
         HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_headers = 9;

      • getRetriableHeaders

        HeaderMatcher getRetriableHeaders​(int index)
         HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_headers = 9;

      • getRetriableHeadersCount

        int getRetriableHeadersCount()
         HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_headers = 9;

      • getRetriableHeadersOrBuilderList

        List<? extends HeaderMatcherOrBuilder> getRetriableHeadersOrBuilderList()
         HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_headers = 9;

      • getRetriableHeadersOrBuilder

        HeaderMatcherOrBuilder getRetriableHeadersOrBuilder​(int index)
         HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_headers = 9;

      • getRetriableRequestHeadersList

        List<HeaderMatcher> getRetriableRequestHeadersList()
         HTTP headers which must be present in the request for retries to be attempted.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_request_headers = 10;

      • getRetriableRequestHeaders

        HeaderMatcher getRetriableRequestHeaders​(int index)
         HTTP headers which must be present in the request for retries to be attempted.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_request_headers = 10;

      • getRetriableRequestHeadersCount

        int getRetriableRequestHeadersCount()
         HTTP headers which must be present in the request for retries to be attempted.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_request_headers = 10;

      • getRetriableRequestHeadersOrBuilderList

        List<? extends HeaderMatcherOrBuilder> getRetriableRequestHeadersOrBuilderList()
         HTTP headers which must be present in the request for retries to be attempted.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_request_headers = 10;

      • getRetriableRequestHeadersOrBuilder

        HeaderMatcherOrBuilder getRetriableRequestHeadersOrBuilder​(int index)
         HTTP headers which must be present in the request for retries to be attempted.
        repeated .envoy.api.v2.route.HeaderMatcher retriable_request_headers = 10;