Package io.envoyproxy.envoy.api.v2

Interface ClusterLoadAssignment.PolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ClusterLoadAssignment.Policy, ClusterLoadAssignment.Policy.Builder
Enclosing class:
ClusterLoadAssignment
public static interface ClusterLoadAssignment.PolicyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getDropOverloadsList

      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;

    • getDropOverloads

      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;

    • getDropOverloadsCount

      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;

    • getDropOverloadsOrBuilderList

      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;

    • getDropOverloadsOrBuilder

      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;

    • hasOverprovisioningFactor

      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) = { ... }
      Returns:
      Whether the overprovisioningFactor field is set.

    • getOverprovisioningFactor

      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) = { ... }
      Returns:
      The overprovisioningFactor.

    • getOverprovisioningFactorOrBuilder

      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) = { ... }

    • hasEndpointStaleAfter

      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) = { ... }
      Returns:
      Whether the endpointStaleAfter field is set.

    • getEndpointStaleAfter

      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) = { ... }
      Returns:
      The endpointStaleAfter.

    • getEndpointStaleAfterOrBuilder

      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) = { ... }

    • getDisableOverprovisioning

      @Deprecated 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];
      Returns:
      The disableOverprovisioning.