Package io.envoyproxy.envoy.api.v2

Class ClusterLoadAssignment.Policy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.ClusterLoadAssignment.Policy
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClusterLoadAssignment.PolicyOrBuilder, Serializable
Enclosing class:
ClusterLoadAssignment
public static final class ClusterLoadAssignment.Policy extends com.google.protobuf.GeneratedMessageV3 implements ClusterLoadAssignment.PolicyOrBuilder
 Load balancing policy settings.
 [#next-free-field: 6]
Protobuf type envoy.api.v2.ClusterLoadAssignment.Policy
See Also:

  • Field Details

    • DROP_OVERLOADS_FIELD_NUMBER

      public static final int DROP_OVERLOADS_FIELD_NUMBER
      See Also:

    • OVERPROVISIONING_FACTOR_FIELD_NUMBER

      public static final int OVERPROVISIONING_FACTOR_FIELD_NUMBER
      See Also:

    • ENDPOINT_STALE_AFTER_FIELD_NUMBER

      public static final int ENDPOINT_STALE_AFTER_FIELD_NUMBER
      See Also:

    • DISABLE_OVERPROVISIONING_FIELD_NUMBER

      public static final int DISABLE_OVERPROVISIONING_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getDropOverloadsList

      public List<ClusterLoadAssignment.Policy.DropOverload> getDropOverloadsList()
       Action to trim the overall incoming traffic to protect the upstream
 hosts. This action allows protection in case the hosts are unable to
 recover from an outage, or unable to autoscale or unable to handle
 incoming traffic volume for any reason.

 At the client each category is applied one after the other to generate
 the 'actual' drop percentage on all outgoing traffic. For example:

 .. code-block:: json

  { "drop_overloads": [
      { "category": "throttle", "drop_percentage": 60 }
      { "category": "lb", "drop_percentage": 50 }
  ]}

 The actual drop percentages applied to the traffic at the clients will be
    "throttle"_drop = 60%
    "lb"_drop = 20%  // 50% of the remaining 'actual' load, which is 40%.
    actual_outgoing_load = 20% // remaining after applying all categories.
 [#not-implemented-hide:]
      repeated .envoy.api.v2.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;
      Specified by:
      getDropOverloadsList in interface ClusterLoadAssignment.PolicyOrBuilder

    • getDropOverloadsOrBuilderList

      public List<? extends ClusterLoadAssignment.Policy.DropOverloadOrBuilder> getDropOverloadsOrBuilderList()
       Action to trim the overall incoming traffic to protect the upstream
 hosts. This action allows protection in case the hosts are unable to
 recover from an outage, or unable to autoscale or unable to handle
 incoming traffic volume for any reason.

 At the client each category is applied one after the other to generate
 the 'actual' drop percentage on all outgoing traffic. For example:

 .. code-block:: json

  { "drop_overloads": [
      { "category": "throttle", "drop_percentage": 60 }
      { "category": "lb", "drop_percentage": 50 }
  ]}

 The actual drop percentages applied to the traffic at the clients will be
    "throttle"_drop = 60%
    "lb"_drop = 20%  // 50% of the remaining 'actual' load, which is 40%.
    actual_outgoing_load = 20% // remaining after applying all categories.
 [#not-implemented-hide:]
      repeated .envoy.api.v2.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;
      Specified by:
      getDropOverloadsOrBuilderList in interface ClusterLoadAssignment.PolicyOrBuilder

    • getDropOverloadsCount

      public int getDropOverloadsCount()
       Action to trim the overall incoming traffic to protect the upstream
 hosts. This action allows protection in case the hosts are unable to
 recover from an outage, or unable to autoscale or unable to handle
 incoming traffic volume for any reason.

 At the client each category is applied one after the other to generate
 the 'actual' drop percentage on all outgoing traffic. For example:

 .. code-block:: json

  { "drop_overloads": [
      { "category": "throttle", "drop_percentage": 60 }
      { "category": "lb", "drop_percentage": 50 }
  ]}

 The actual drop percentages applied to the traffic at the clients will be
    "throttle"_drop = 60%
    "lb"_drop = 20%  // 50% of the remaining 'actual' load, which is 40%.
    actual_outgoing_load = 20% // remaining after applying all categories.
 [#not-implemented-hide:]
      repeated .envoy.api.v2.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;
      Specified by:
      getDropOverloadsCount in interface ClusterLoadAssignment.PolicyOrBuilder

    • getDropOverloads

      public ClusterLoadAssignment.Policy.DropOverload getDropOverloads(int index)
       Action to trim the overall incoming traffic to protect the upstream
 hosts. This action allows protection in case the hosts are unable to
 recover from an outage, or unable to autoscale or unable to handle
 incoming traffic volume for any reason.

 At the client each category is applied one after the other to generate
 the 'actual' drop percentage on all outgoing traffic. For example:

 .. code-block:: json

  { "drop_overloads": [
      { "category": "throttle", "drop_percentage": 60 }
      { "category": "lb", "drop_percentage": 50 }
  ]}

 The actual drop percentages applied to the traffic at the clients will be
    "throttle"_drop = 60%
    "lb"_drop = 20%  // 50% of the remaining 'actual' load, which is 40%.
    actual_outgoing_load = 20% // remaining after applying all categories.
 [#not-implemented-hide:]
      repeated .envoy.api.v2.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;
      Specified by:
      getDropOverloads in interface ClusterLoadAssignment.PolicyOrBuilder

    • getDropOverloadsOrBuilder

      public ClusterLoadAssignment.Policy.DropOverloadOrBuilder getDropOverloadsOrBuilder(int index)
       Action to trim the overall incoming traffic to protect the upstream
 hosts. This action allows protection in case the hosts are unable to
 recover from an outage, or unable to autoscale or unable to handle
 incoming traffic volume for any reason.

 At the client each category is applied one after the other to generate
 the 'actual' drop percentage on all outgoing traffic. For example:

 .. code-block:: json

  { "drop_overloads": [
      { "category": "throttle", "drop_percentage": 60 }
      { "category": "lb", "drop_percentage": 50 }
  ]}

 The actual drop percentages applied to the traffic at the clients will be
    "throttle"_drop = 60%
    "lb"_drop = 20%  // 50% of the remaining 'actual' load, which is 40%.
    actual_outgoing_load = 20% // remaining after applying all categories.
 [#not-implemented-hide:]
      repeated .envoy.api.v2.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;
      Specified by:
      getDropOverloadsOrBuilder in interface ClusterLoadAssignment.PolicyOrBuilder

    • hasOverprovisioningFactor

      public boolean hasOverprovisioningFactor()
       Priority levels and localities are considered overprovisioned with this
 factor (in percentage). This means that we don't consider a priority
 level or locality unhealthy until the percentage of healthy hosts
 multiplied by the overprovisioning factor drops below 100.
 With the default value 140(1.4), Envoy doesn't consider a priority level
 or a locality unhealthy until their percentage of healthy hosts drops
 below 72%. For example:

 .. code-block:: json

  { "overprovisioning_factor": 100 }

 Read more at :ref:`priority levels <arch_overview_load_balancing_priority_levels>` and
 :ref:`localities <arch_overview_load_balancing_locality_weighted_lb>`.
      .google.protobuf.UInt32Value overprovisioning_factor = 3 [(.validate.rules) = { ... }
      Specified by:
      hasOverprovisioningFactor in interface ClusterLoadAssignment.PolicyOrBuilder
      Returns:
      Whether the overprovisioningFactor field is set.

    • getOverprovisioningFactor

      public com.google.protobuf.UInt32Value getOverprovisioningFactor()
       Priority levels and localities are considered overprovisioned with this
 factor (in percentage). This means that we don't consider a priority
 level or locality unhealthy until the percentage of healthy hosts
 multiplied by the overprovisioning factor drops below 100.
 With the default value 140(1.4), Envoy doesn't consider a priority level
 or a locality unhealthy until their percentage of healthy hosts drops
 below 72%. For example:

 .. code-block:: json

  { "overprovisioning_factor": 100 }

 Read more at :ref:`priority levels <arch_overview_load_balancing_priority_levels>` and
 :ref:`localities <arch_overview_load_balancing_locality_weighted_lb>`.
      .google.protobuf.UInt32Value overprovisioning_factor = 3 [(.validate.rules) = { ... }
      Specified by:
      getOverprovisioningFactor in interface ClusterLoadAssignment.PolicyOrBuilder
      Returns:
      The overprovisioningFactor.

    • getOverprovisioningFactorOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getOverprovisioningFactorOrBuilder()
       Priority levels and localities are considered overprovisioned with this
 factor (in percentage). This means that we don't consider a priority
 level or locality unhealthy until the percentage of healthy hosts
 multiplied by the overprovisioning factor drops below 100.
 With the default value 140(1.4), Envoy doesn't consider a priority level
 or a locality unhealthy until their percentage of healthy hosts drops
 below 72%. For example:

 .. code-block:: json

  { "overprovisioning_factor": 100 }

 Read more at :ref:`priority levels <arch_overview_load_balancing_priority_levels>` and
 :ref:`localities <arch_overview_load_balancing_locality_weighted_lb>`.
      .google.protobuf.UInt32Value overprovisioning_factor = 3 [(.validate.rules) = { ... }
      Specified by:
      getOverprovisioningFactorOrBuilder in interface ClusterLoadAssignment.PolicyOrBuilder

    • hasEndpointStaleAfter

      public boolean hasEndpointStaleAfter()
       The max time until which the endpoints from this assignment can be used.
 If no new assignments are received before this time expires the endpoints
 are considered stale and should be marked unhealthy.
 Defaults to 0 which means endpoints never go stale.
      .google.protobuf.Duration endpoint_stale_after = 4 [(.validate.rules) = { ... }
      Specified by:
      hasEndpointStaleAfter in interface ClusterLoadAssignment.PolicyOrBuilder
      Returns:
      Whether the endpointStaleAfter field is set.

    • getEndpointStaleAfter

      public com.google.protobuf.Duration getEndpointStaleAfter()
       The max time until which the endpoints from this assignment can be used.
 If no new assignments are received before this time expires the endpoints
 are considered stale and should be marked unhealthy.
 Defaults to 0 which means endpoints never go stale.
      .google.protobuf.Duration endpoint_stale_after = 4 [(.validate.rules) = { ... }
      Specified by:
      getEndpointStaleAfter in interface ClusterLoadAssignment.PolicyOrBuilder
      Returns:
      The endpointStaleAfter.

    • getEndpointStaleAfterOrBuilder

      public com.google.protobuf.DurationOrBuilder getEndpointStaleAfterOrBuilder()
       The max time until which the endpoints from this assignment can be used.
 If no new assignments are received before this time expires the endpoints
 are considered stale and should be marked unhealthy.
 Defaults to 0 which means endpoints never go stale.
      .google.protobuf.Duration endpoint_stale_after = 4 [(.validate.rules) = { ... }
      Specified by:
      getEndpointStaleAfterOrBuilder in interface ClusterLoadAssignment.PolicyOrBuilder

    • getDisableOverprovisioning

      @Deprecated public boolean getDisableOverprovisioning()
      Deprecated.
      envoy.api.v2.ClusterLoadAssignment.Policy.disable_overprovisioning is deprecated. See envoy/api/v2/endpoint.proto;l=101
       The flag to disable overprovisioning. If it is set to true,
 :ref:`overprovisioning factor
 <arch_overview_load_balancing_overprovisioning_factor>` will be ignored
 and Envoy will not perform graceful failover between priority levels or
 localities as endpoints become unhealthy. Otherwise Envoy will perform
 graceful failover as :ref:`overprovisioning factor
 <arch_overview_load_balancing_overprovisioning_factor>` suggests.
 [#not-implemented-hide:]
      bool disable_overprovisioning = 5 [deprecated = true];
      Specified by:
      getDisableOverprovisioning in interface ClusterLoadAssignment.PolicyOrBuilder
      Returns:
      The disableOverprovisioning.

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

    • parseFrom

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

    • parseFrom

      public static ClusterLoadAssignment.Policy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ClusterLoadAssignment.Policy parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ClusterLoadAssignment.Policy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static ClusterLoadAssignment.Policy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ClusterLoadAssignment.Policy.Builder newBuilder()

    • newBuilder

      public static ClusterLoadAssignment.Policy.Builder newBuilder(ClusterLoadAssignment.Policy prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ClusterLoadAssignment.Policy getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ClusterLoadAssignment.Policy> 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 ClusterLoadAssignment.Policy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder