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

Class CircuitBreakers

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CircuitBreakersOrBuilder, Serializable
    public final class CircuitBreakers
extends com.google.protobuf.GeneratedMessageV3
implements CircuitBreakersOrBuilder
     :ref:`Circuit breaking<arch_overview_circuit_break>` settings can be
 specified individually for each defined priority.
    Protobuf type envoy.config.cluster.v3.CircuitBreakers
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CircuitBreakers.Builder
      :ref:`Circuit breaking<arch_overview_circuit_break>` settings can be specified individually for each defined priority.
      static class  CircuitBreakers.Thresholds
      A Thresholds defines CircuitBreaker settings for a :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`.
      static interface  CircuitBreakers.ThresholdsOrBuilder  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int PER_HOST_THRESHOLDS_FIELD_NUMBER  
      static int THRESHOLDS_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static CircuitBreakers getDefaultInstance()  
      CircuitBreakers getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<CircuitBreakers> getParserForType()  
      CircuitBreakers.Thresholds getPerHostThresholds​(int index)
      Optional per-host limits which apply to each individual host in a cluster. .. note:: currently only the :ref:`max_connections <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
      int getPerHostThresholdsCount()
      Optional per-host limits which apply to each individual host in a cluster. .. note:: currently only the :ref:`max_connections <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
      List<CircuitBreakers.Thresholds> getPerHostThresholdsList()
      Optional per-host limits which apply to each individual host in a cluster. .. note:: currently only the :ref:`max_connections <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
      CircuitBreakers.ThresholdsOrBuilder getPerHostThresholdsOrBuilder​(int index)
      Optional per-host limits which apply to each individual host in a cluster. .. note:: currently only the :ref:`max_connections <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
      List<? extends CircuitBreakers.ThresholdsOrBuilder> getPerHostThresholdsOrBuilderList()
      Optional per-host limits which apply to each individual host in a cluster. .. note:: currently only the :ref:`max_connections <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
      int getSerializedSize()  
      CircuitBreakers.Thresholds getThresholds​(int index)
      If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>` are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the first one in the list is used.
      int getThresholdsCount()
      If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>` are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the first one in the list is used.
      List<CircuitBreakers.Thresholds> getThresholdsList()
      If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>` are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the first one in the list is used.
      CircuitBreakers.ThresholdsOrBuilder getThresholdsOrBuilder​(int index)
      If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>` are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the first one in the list is used.
      List<? extends CircuitBreakers.ThresholdsOrBuilder> getThresholdsOrBuilderList()
      If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>` are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the first one in the list is used.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static CircuitBreakers.Builder newBuilder()  
      static CircuitBreakers.Builder newBuilder​(CircuitBreakers prototype)  
      CircuitBreakers.Builder newBuilderForType()  
      protected CircuitBreakers.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static CircuitBreakers parseDelimitedFrom​(InputStream input)  
      static CircuitBreakers parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CircuitBreakers parseFrom​(byte[] data)  
      static CircuitBreakers parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CircuitBreakers parseFrom​(com.google.protobuf.ByteString data)  
      static CircuitBreakers parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CircuitBreakers parseFrom​(com.google.protobuf.CodedInputStream input)  
      static CircuitBreakers parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CircuitBreakers parseFrom​(InputStream input)  
      static CircuitBreakers parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CircuitBreakers parseFrom​(ByteBuffer data)  
      static CircuitBreakers parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<CircuitBreakers> parser()  
      CircuitBreakers.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

    • Field Detail

      • THRESHOLDS_FIELD_NUMBER

        public static final int THRESHOLDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PER_HOST_THRESHOLDS_FIELD_NUMBER

        public static final int PER_HOST_THRESHOLDS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getThresholdsList

        public List<CircuitBreakers.Thresholds> getThresholdsList()
         If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no Thresholds is defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the default values
 are used.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds thresholds = 1;
        Specified by:
        getThresholdsList in interface CircuitBreakersOrBuilder

      • getThresholdsOrBuilderList

        public List<? extends CircuitBreakers.ThresholdsOrBuilder> getThresholdsOrBuilderList()
         If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no Thresholds is defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the default values
 are used.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds thresholds = 1;
        Specified by:
        getThresholdsOrBuilderList in interface CircuitBreakersOrBuilder

      • getThresholdsCount

        public int getThresholdsCount()
         If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no Thresholds is defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the default values
 are used.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds thresholds = 1;
        Specified by:
        getThresholdsCount in interface CircuitBreakersOrBuilder

      • getThresholds

        public CircuitBreakers.Thresholds getThresholds​(int index)
         If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no Thresholds is defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the default values
 are used.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds thresholds = 1;
        Specified by:
        getThresholds in interface CircuitBreakersOrBuilder

      • getThresholdsOrBuilder

        public CircuitBreakers.ThresholdsOrBuilder getThresholdsOrBuilder​(int index)
         If multiple :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no Thresholds is defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`, the default values
 are used.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds thresholds = 1;
        Specified by:
        getThresholdsOrBuilder in interface CircuitBreakersOrBuilder

      • getPerHostThresholdsList

        public List<CircuitBreakers.Thresholds> getPerHostThresholdsList()
         Optional per-host limits which apply to each individual host in a cluster.
 .. note::
  currently only the :ref:`max_connections
  <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
 If multiple per-host :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no per-host Thresholds are defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the cluster will not have per-host limits.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds per_host_thresholds = 2;
        Specified by:
        getPerHostThresholdsList in interface CircuitBreakersOrBuilder

      • getPerHostThresholdsOrBuilderList

        public List<? extends CircuitBreakers.ThresholdsOrBuilder> getPerHostThresholdsOrBuilderList()
         Optional per-host limits which apply to each individual host in a cluster.
 .. note::
  currently only the :ref:`max_connections
  <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
 If multiple per-host :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no per-host Thresholds are defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the cluster will not have per-host limits.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds per_host_thresholds = 2;
        Specified by:
        getPerHostThresholdsOrBuilderList in interface CircuitBreakersOrBuilder

      • getPerHostThresholdsCount

        public int getPerHostThresholdsCount()
         Optional per-host limits which apply to each individual host in a cluster.
 .. note::
  currently only the :ref:`max_connections
  <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
 If multiple per-host :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no per-host Thresholds are defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the cluster will not have per-host limits.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds per_host_thresholds = 2;
        Specified by:
        getPerHostThresholdsCount in interface CircuitBreakersOrBuilder

      • getPerHostThresholds

        public CircuitBreakers.Thresholds getPerHostThresholds​(int index)
         Optional per-host limits which apply to each individual host in a cluster.
 .. note::
  currently only the :ref:`max_connections
  <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
 If multiple per-host :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no per-host Thresholds are defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the cluster will not have per-host limits.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds per_host_thresholds = 2;
        Specified by:
        getPerHostThresholds in interface CircuitBreakersOrBuilder

      • getPerHostThresholdsOrBuilder

        public CircuitBreakers.ThresholdsOrBuilder getPerHostThresholdsOrBuilder​(int index)
         Optional per-host limits which apply to each individual host in a cluster.
 .. note::
  currently only the :ref:`max_connections
  <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>` field is supported for per-host limits.
 If multiple per-host :ref:`Thresholds<envoy_v3_api_msg_config.cluster.v3.CircuitBreakers.Thresholds>`
 are defined with the same :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the first one in the list is used. If no per-host Thresholds are defined for a given
 :ref:`RoutingPriority<envoy_v3_api_enum_config.core.v3.RoutingPriority>`,
 the cluster will not have per-host limits.
        repeated .envoy.config.cluster.v3.CircuitBreakers.Thresholds per_host_thresholds = 2;
        Specified by:
        getPerHostThresholdsOrBuilder in interface CircuitBreakersOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static CircuitBreakers 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 parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected CircuitBreakers.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<CircuitBreakers> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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