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

Class CircuitBreakers.Thresholds

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers.Thresholds
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CircuitBreakers.ThresholdsOrBuilder, Serializable
Enclosing class:
CircuitBreakers
public static final class CircuitBreakers.Thresholds extends com.google.protobuf.GeneratedMessage implements CircuitBreakers.ThresholdsOrBuilder
 A Thresholds defines CircuitBreaker settings for a
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`.
 [#next-free-field: 9]
Protobuf type envoy.config.cluster.v3.CircuitBreakers.Thresholds
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • PRIORITY_FIELD_NUMBER

      public static final int PRIORITY_FIELD_NUMBER
      See Also:

    • priority_

      private int priority_

    • MAX_CONNECTIONS_FIELD_NUMBER

      public static final int MAX_CONNECTIONS_FIELD_NUMBER
      See Also:

    • maxConnections_

      private com.google.protobuf.UInt32Value maxConnections_

    • MAX_PENDING_REQUESTS_FIELD_NUMBER

      public static final int MAX_PENDING_REQUESTS_FIELD_NUMBER
      See Also:

    • maxPendingRequests_

      private com.google.protobuf.UInt32Value maxPendingRequests_

    • MAX_REQUESTS_FIELD_NUMBER

      public static final int MAX_REQUESTS_FIELD_NUMBER
      See Also:

    • maxRequests_

      private com.google.protobuf.UInt32Value maxRequests_

    • MAX_RETRIES_FIELD_NUMBER

      public static final int MAX_RETRIES_FIELD_NUMBER
      See Also:

    • maxRetries_

      private com.google.protobuf.UInt32Value maxRetries_

    • RETRY_BUDGET_FIELD_NUMBER

      public static final int RETRY_BUDGET_FIELD_NUMBER
      See Also:

    • retryBudget_

      private CircuitBreakers.Thresholds.RetryBudget retryBudget_

    • TRACK_REMAINING_FIELD_NUMBER

      public static final int TRACK_REMAINING_FIELD_NUMBER
      See Also:

    • trackRemaining_

      private boolean trackRemaining_

    • MAX_CONNECTION_POOLS_FIELD_NUMBER

      public static final int MAX_CONNECTION_POOLS_FIELD_NUMBER
      See Also:

    • maxConnectionPools_

      private com.google.protobuf.UInt32Value maxConnectionPools_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final CircuitBreakers.Thresholds DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<CircuitBreakers.Thresholds> PARSER

  • Constructor Details

    • Thresholds

      private Thresholds(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • Thresholds

      private Thresholds()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPriorityValue

      public 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) = { ... }
      Specified by:
      getPriorityValue in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      The enum numeric value on the wire for priority.

    • getPriority

      public 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) = { ... }
      Specified by:
      getPriority in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      The priority.

    • hasMaxConnections

      public 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;
      Specified by:
      hasMaxConnections in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      Whether the maxConnections field is set.

    • getMaxConnections

      public 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;
      Specified by:
      getMaxConnections in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      The maxConnections.

    • getMaxConnectionsOrBuilder

      public 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;
      Specified by:
      getMaxConnectionsOrBuilder in interface CircuitBreakers.ThresholdsOrBuilder

    • hasMaxPendingRequests

      public 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;
      Specified by:
      hasMaxPendingRequests in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      Whether the maxPendingRequests field is set.

    • getMaxPendingRequests

      public 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;
      Specified by:
      getMaxPendingRequests in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      The maxPendingRequests.

    • getMaxPendingRequestsOrBuilder

      public 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;
      Specified by:
      getMaxPendingRequestsOrBuilder in interface CircuitBreakers.ThresholdsOrBuilder

    • hasMaxRequests

      public 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;
      Specified by:
      hasMaxRequests in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      Whether the maxRequests field is set.

    • getMaxRequests

      public 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;
      Specified by:
      getMaxRequests in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      The maxRequests.

    • getMaxRequestsOrBuilder

      public 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;
      Specified by:
      getMaxRequestsOrBuilder in interface CircuitBreakers.ThresholdsOrBuilder

    • hasMaxRetries

      public 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;
      Specified by:
      hasMaxRetries in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      Whether the maxRetries field is set.

    • getMaxRetries

      public 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;
      Specified by:
      getMaxRetries in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      The maxRetries.

    • getMaxRetriesOrBuilder

      public 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;
      Specified by:
      getMaxRetriesOrBuilder in interface CircuitBreakers.ThresholdsOrBuilder

    • hasRetryBudget

      public 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;
      Specified by:
      hasRetryBudget in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      Whether the retryBudget field is set.

    • getRetryBudget

      public 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;
      Specified by:
      getRetryBudget in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      The retryBudget.

    • getRetryBudgetOrBuilder

      public 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;
      Specified by:
      getRetryBudgetOrBuilder in interface CircuitBreakers.ThresholdsOrBuilder

    • getTrackRemaining

      public 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;
      Specified by:
      getTrackRemaining in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      The trackRemaining.

    • hasMaxConnectionPools

      public 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;
      Specified by:
      hasMaxConnectionPools in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      Whether the maxConnectionPools field is set.

    • getMaxConnectionPools

      public 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;
      Specified by:
      getMaxConnectionPools in interface CircuitBreakers.ThresholdsOrBuilder
      Returns:
      The maxConnectionPools.

    • getMaxConnectionPoolsOrBuilder

      public 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;
      Specified by:
      getMaxConnectionPoolsOrBuilder in interface CircuitBreakers.ThresholdsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CircuitBreakers.Thresholds parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CircuitBreakers.Thresholds parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CircuitBreakers.Thresholds parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CircuitBreakers.Thresholds.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CircuitBreakers.Thresholds.Builder newBuilder()

    • newBuilder

      public static CircuitBreakers.Thresholds.Builder newBuilder(CircuitBreakers.Thresholds prototype)

    • toBuilder

      public CircuitBreakers.Thresholds.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CircuitBreakers.Thresholds.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CircuitBreakers.Thresholds getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CircuitBreakers.Thresholds> parser()

    • getParserForType

      public com.google.protobuf.Parser<CircuitBreakers.Thresholds> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public CircuitBreakers.Thresholds getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder