Package io.envoyproxy.envoy.config.cluster.v3

Interface CircuitBreakers.ThresholdsOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.UInt32Value getMaxConnectionPools()
      The maximum number of connection pools per cluster that Envoy will concurrently support at once.
      com.google.protobuf.UInt32ValueOrBuilder getMaxConnectionPoolsOrBuilder()
      The maximum number of connection pools per cluster that Envoy will concurrently support at once.
      com.google.protobuf.UInt32Value getMaxConnections()
      The maximum number of connections that Envoy will make to the upstream cluster.
      com.google.protobuf.UInt32ValueOrBuilder getMaxConnectionsOrBuilder()
      The maximum number of connections that Envoy will make to the upstream cluster.
      com.google.protobuf.UInt32Value getMaxPendingRequests()
      The maximum number of pending requests that Envoy will allow to the upstream cluster.
      com.google.protobuf.UInt32ValueOrBuilder getMaxPendingRequestsOrBuilder()
      The maximum number of pending requests that Envoy will allow to the upstream cluster.
      com.google.protobuf.UInt32Value getMaxRequests()
      The maximum number of parallel requests that Envoy will make to the upstream cluster.
      com.google.protobuf.UInt32ValueOrBuilder getMaxRequestsOrBuilder()
      The maximum number of parallel requests that Envoy will make to the upstream cluster.
      com.google.protobuf.UInt32Value getMaxRetries()
      The maximum number of parallel retries that Envoy will allow to the upstream cluster.
      com.google.protobuf.UInt32ValueOrBuilder getMaxRetriesOrBuilder()
      The maximum number of parallel retries that Envoy will allow to the upstream cluster.
      RoutingPriority getPriority()
      The :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>` the specified CircuitBreaker settings apply to.
      int getPriorityValue()
      The :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>` the specified CircuitBreaker settings apply to.
      CircuitBreakers.Thresholds.RetryBudget getRetryBudget()
      Specifies a limit on concurrent retries in relation to the number of active requests.
      CircuitBreakers.Thresholds.RetryBudgetOrBuilder getRetryBudgetOrBuilder()
      Specifies a limit on concurrent retries in relation to the number of active requests.
      boolean getTrackRemaining()
      If track_remaining is true, then stats will be published that expose the number of resources remaining until the circuit breakers open.
      boolean hasMaxConnectionPools()
      The maximum number of connection pools per cluster that Envoy will concurrently support at once.
      boolean hasMaxConnections()
      The maximum number of connections that Envoy will make to the upstream cluster.
      boolean hasMaxPendingRequests()
      The maximum number of pending requests that Envoy will allow to the upstream cluster.
      boolean hasMaxRequests()
      The maximum number of parallel requests that Envoy will make to the upstream cluster.
      boolean hasMaxRetries()
      The maximum number of parallel retries that Envoy will allow to the upstream cluster.
      boolean hasRetryBudget()
      Specifies a limit on concurrent retries in relation to the number of active requests.

      • 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

      • getPriorityValue

        int getPriorityValue()
         The :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`
 the specified CircuitBreaker settings apply to.
        .envoy.config.core.v3.RoutingPriority priority = 1 [(.validate.rules) = { ... }

      • getPriority

        RoutingPriority getPriority()
         The :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`
 the specified CircuitBreaker settings apply to.
        .envoy.config.core.v3.RoutingPriority priority = 1 [(.validate.rules) = { ... }

      • hasMaxConnections

        boolean hasMaxConnections()
         The maximum number of connections that Envoy will make to the upstream
 cluster. If not specified, the default is 1024.
        .google.protobuf.UInt32Value max_connections = 2;

      • getMaxConnections

        com.google.protobuf.UInt32Value getMaxConnections()
         The maximum number of connections that Envoy will make to the upstream
 cluster. If not specified, the default is 1024.
        .google.protobuf.UInt32Value max_connections = 2;

      • getMaxConnectionsOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMaxConnectionsOrBuilder()
         The maximum number of connections that Envoy will make to the upstream
 cluster. If not specified, the default is 1024.
        .google.protobuf.UInt32Value max_connections = 2;

      • hasMaxPendingRequests

        boolean hasMaxPendingRequests()
         The maximum number of pending requests that Envoy will allow to the
 upstream cluster. If not specified, the default is 1024.
 This limit is applied as a connection limit for non-HTTP traffic.
        .google.protobuf.UInt32Value max_pending_requests = 3;

      • getMaxPendingRequests

        com.google.protobuf.UInt32Value getMaxPendingRequests()
         The maximum number of pending requests that Envoy will allow to the
 upstream cluster. If not specified, the default is 1024.
 This limit is applied as a connection limit for non-HTTP traffic.
        .google.protobuf.UInt32Value max_pending_requests = 3;

      • getMaxPendingRequestsOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMaxPendingRequestsOrBuilder()
         The maximum number of pending requests that Envoy will allow to the
 upstream cluster. If not specified, the default is 1024.
 This limit is applied as a connection limit for non-HTTP traffic.
        .google.protobuf.UInt32Value max_pending_requests = 3;

      • hasMaxRequests

        boolean hasMaxRequests()
         The maximum number of parallel requests that Envoy will make to the
 upstream cluster. If not specified, the default is 1024.
 This limit does not apply to non-HTTP traffic.
        .google.protobuf.UInt32Value max_requests = 4;

      • getMaxRequests

        com.google.protobuf.UInt32Value getMaxRequests()
         The maximum number of parallel requests that Envoy will make to the
 upstream cluster. If not specified, the default is 1024.
 This limit does not apply to non-HTTP traffic.
        .google.protobuf.UInt32Value max_requests = 4;

      • getMaxRequestsOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMaxRequestsOrBuilder()
         The maximum number of parallel requests that Envoy will make to the
 upstream cluster. If not specified, the default is 1024.
 This limit does not apply to non-HTTP traffic.
        .google.protobuf.UInt32Value max_requests = 4;

      • hasMaxRetries

        boolean hasMaxRetries()
         The maximum number of parallel retries that Envoy will allow to the
 upstream cluster. If not specified, the default is 3.
        .google.protobuf.UInt32Value max_retries = 5;

      • getMaxRetries

        com.google.protobuf.UInt32Value getMaxRetries()
         The maximum number of parallel retries that Envoy will allow to the
 upstream cluster. If not specified, the default is 3.
        .google.protobuf.UInt32Value max_retries = 5;

      • getMaxRetriesOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMaxRetriesOrBuilder()
         The maximum number of parallel retries that Envoy will allow to the
 upstream cluster. If not specified, the default is 3.
        .google.protobuf.UInt32Value max_retries = 5;

      • hasRetryBudget

        boolean hasRetryBudget()
         Specifies a limit on concurrent retries in relation to the number of active requests. This
 parameter is optional.
 .. note::
    If this field is set, the retry budget will override any configured retry circuit
    breaker.
        .envoy.config.cluster.v3.CircuitBreakers.Thresholds.RetryBudget retry_budget = 8;

      • getRetryBudget

        CircuitBreakers.Thresholds.RetryBudget getRetryBudget()
         Specifies a limit on concurrent retries in relation to the number of active requests. This
 parameter is optional.
 .. note::
    If this field is set, the retry budget will override any configured retry circuit
    breaker.
        .envoy.config.cluster.v3.CircuitBreakers.Thresholds.RetryBudget retry_budget = 8;

      • getRetryBudgetOrBuilder

        CircuitBreakers.Thresholds.RetryBudgetOrBuilder getRetryBudgetOrBuilder()
         Specifies a limit on concurrent retries in relation to the number of active requests. This
 parameter is optional.
 .. note::
    If this field is set, the retry budget will override any configured retry circuit
    breaker.
        .envoy.config.cluster.v3.CircuitBreakers.Thresholds.RetryBudget retry_budget = 8;

      • getTrackRemaining

        boolean getTrackRemaining()
         If track_remaining is true, then stats will be published that expose
 the number of resources remaining until the circuit breakers open. If
 not specified, the default is false.
 .. note::
    If a retry budget is used in lieu of the max_retries circuit breaker,
    the remaining retry resources remaining will not be tracked.
        bool track_remaining = 6;

      • hasMaxConnectionPools

        boolean hasMaxConnectionPools()
         The maximum number of connection pools per cluster that Envoy will concurrently support at
 once. If not specified, the default is unlimited. Set this for clusters which create a
 large number of connection pools. See
 :ref:`Circuit Breaking <arch_overview_circuit_break_cluster_maximum_connection_pools>` for
 more details.
        .google.protobuf.UInt32Value max_connection_pools = 7;

      • getMaxConnectionPools

        com.google.protobuf.UInt32Value getMaxConnectionPools()
         The maximum number of connection pools per cluster that Envoy will concurrently support at
 once. If not specified, the default is unlimited. Set this for clusters which create a
 large number of connection pools. See
 :ref:`Circuit Breaking <arch_overview_circuit_break_cluster_maximum_connection_pools>` for
 more details.
        .google.protobuf.UInt32Value max_connection_pools = 7;

      • getMaxConnectionPoolsOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMaxConnectionPoolsOrBuilder()
         The maximum number of connection pools per cluster that Envoy will concurrently support at
 once. If not specified, the default is unlimited. Set this for clusters which create a
 large number of connection pools. See
 :ref:`Circuit Breaking <arch_overview_circuit_break_cluster_maximum_connection_pools>` for
 more details.
        .google.protobuf.UInt32Value max_connection_pools = 7;