Interface HedgePolicyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HedgePolicy, HedgePolicy.Builder

    public interface HedgePolicyOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      FractionalPercent getAdditionalRequestChance()
      Specifies a probability that an additional upstream request should be sent on top of what is specified by initial_requests.
      FractionalPercentOrBuilder getAdditionalRequestChanceOrBuilder()
      Specifies a probability that an additional upstream request should be sent on top of what is specified by initial_requests.
      boolean getHedgeOnPerTryTimeout()
      Indicates that a hedged request should be sent when the per-try timeout is hit.
      com.google.protobuf.UInt32Value getInitialRequests()
      Specifies the number of initial requests that should be sent upstream.
      com.google.protobuf.UInt32ValueOrBuilder getInitialRequestsOrBuilder()
      Specifies the number of initial requests that should be sent upstream.
      boolean hasAdditionalRequestChance()
      Specifies a probability that an additional upstream request should be sent on top of what is specified by initial_requests.
      boolean hasInitialRequests()
      Specifies the number of initial requests that should be sent upstream.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • hasInitialRequests

        boolean hasInitialRequests()
         Specifies the number of initial requests that should be sent upstream.
         Must be at least 1.
         Defaults to 1.
         [#not-implemented-hide:]
         
        .google.protobuf.UInt32Value initial_requests = 1 [(.validate.rules) = { ... }
        Returns:
        Whether the initialRequests field is set.
      • getInitialRequests

        com.google.protobuf.UInt32Value getInitialRequests()
         Specifies the number of initial requests that should be sent upstream.
         Must be at least 1.
         Defaults to 1.
         [#not-implemented-hide:]
         
        .google.protobuf.UInt32Value initial_requests = 1 [(.validate.rules) = { ... }
        Returns:
        The initialRequests.
      • getInitialRequestsOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getInitialRequestsOrBuilder()
         Specifies the number of initial requests that should be sent upstream.
         Must be at least 1.
         Defaults to 1.
         [#not-implemented-hide:]
         
        .google.protobuf.UInt32Value initial_requests = 1 [(.validate.rules) = { ... }
      • hasAdditionalRequestChance

        boolean hasAdditionalRequestChance()
         Specifies a probability that an additional upstream request should be sent
         on top of what is specified by initial_requests.
         Defaults to 0.
         [#not-implemented-hide:]
         
        .envoy.type.v3.FractionalPercent additional_request_chance = 2;
        Returns:
        Whether the additionalRequestChance field is set.
      • getAdditionalRequestChance

        FractionalPercent getAdditionalRequestChance()
         Specifies a probability that an additional upstream request should be sent
         on top of what is specified by initial_requests.
         Defaults to 0.
         [#not-implemented-hide:]
         
        .envoy.type.v3.FractionalPercent additional_request_chance = 2;
        Returns:
        The additionalRequestChance.
      • getAdditionalRequestChanceOrBuilder

        FractionalPercentOrBuilder getAdditionalRequestChanceOrBuilder()
         Specifies a probability that an additional upstream request should be sent
         on top of what is specified by initial_requests.
         Defaults to 0.
         [#not-implemented-hide:]
         
        .envoy.type.v3.FractionalPercent additional_request_chance = 2;
      • getHedgeOnPerTryTimeout

        boolean getHedgeOnPerTryTimeout()
         Indicates that a hedged request should be sent when the per-try timeout is hit.
         This means that a retry will be issued without resetting the original request, leaving multiple upstream requests in flight.
         The first request to complete successfully will be the one returned to the caller.
        
         * At any time, a successful response (i.e. not triggering any of the retry-on conditions) would be returned to the client.
         * Before per-try timeout, an error response (per retry-on conditions) would be retried immediately or returned ot the client
         if there are no more retries left.
         * After per-try timeout, an error response would be discarded, as a retry in the form of a hedged request is already in progress.
        
         Note: For this to have effect, you must have a :ref:`RetryPolicy <envoy_v3_api_msg_config.route.v3.RetryPolicy>` that retries at least
         one error code and specifies a maximum number of retries.
        
         Defaults to false.
         
        bool hedge_on_per_try_timeout = 3;
        Returns:
        The hedgeOnPerTryTimeout.