Package io.envoyproxy.envoy.config.endpoint.v3

Class ClusterLoadAssignment.Policy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClusterLoadAssignment.PolicyOrBuilder, java.io.Serializable
    Enclosing class:
    ClusterLoadAssignment
    public static final class ClusterLoadAssignment.Policy
extends com.google.protobuf.GeneratedMessage
implements ClusterLoadAssignment.PolicyOrBuilder
     Load balancing policy settings.
 [#next-free-field: 7]
    Protobuf type envoy.config.endpoint.v3.ClusterLoadAssignment.Policy
    See Also:
    Serialized Form

    • Field Detail

      • bitField0_

        private int bitField0_

      • DROP_OVERLOADS_FIELD_NUMBER

        public static final int DROP_OVERLOADS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OVERPROVISIONING_FACTOR_FIELD_NUMBER

        public static final int OVERPROVISIONING_FACTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • overprovisioningFactor_

        private com.google.protobuf.UInt32Value overprovisioningFactor_

      • ENDPOINT_STALE_AFTER_FIELD_NUMBER

        public static final int ENDPOINT_STALE_AFTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • endpointStaleAfter_

        private com.google.protobuf.Duration endpointStaleAfter_

      • WEIGHTED_PRIORITY_HEALTH_FIELD_NUMBER

        public static final int WEIGHTED_PRIORITY_HEALTH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • weightedPriorityHealth_

        private boolean weightedPriorityHealth_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

    • Constructor Detail

      • Policy

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

      • Policy

        private Policy()

    • Method Detail

      • 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

      • getDropOverloadsList

        public java.util.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.

 Envoy supports only one element and will NACK if more than one element is present.
 Other xDS-capable data planes will not necessarily have this limitation.

 In Envoy, this ``drop_overloads`` config can be overridden by a runtime key
 "load_balancing_policy.drop_overload_limit" setting. This runtime key can be set to
 any integer number between 0 and 100. 0 means drop 0%. 100 means drop 100%.
 When both ``drop_overloads`` config and "load_balancing_policy.drop_overload_limit"
 setting are in place, the min of these two wins.
        repeated .envoy.config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;
        Specified by:
        getDropOverloadsList in interface ClusterLoadAssignment.PolicyOrBuilder

      • getDropOverloadsOrBuilderList

        public java.util.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.

 Envoy supports only one element and will NACK if more than one element is present.
 Other xDS-capable data planes will not necessarily have this limitation.

 In Envoy, this ``drop_overloads`` config can be overridden by a runtime key
 "load_balancing_policy.drop_overload_limit" setting. This runtime key can be set to
 any integer number between 0 and 100. 0 means drop 0%. 100 means drop 100%.
 When both ``drop_overloads`` config and "load_balancing_policy.drop_overload_limit"
 setting are in place, the min of these two wins.
        repeated .envoy.config.endpoint.v3.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.

 Envoy supports only one element and will NACK if more than one element is present.
 Other xDS-capable data planes will not necessarily have this limitation.

 In Envoy, this ``drop_overloads`` config can be overridden by a runtime key
 "load_balancing_policy.drop_overload_limit" setting. This runtime key can be set to
 any integer number between 0 and 100. 0 means drop 0%. 100 means drop 100%.
 When both ``drop_overloads`` config and "load_balancing_policy.drop_overload_limit"
 setting are in place, the min of these two wins.
        repeated .envoy.config.endpoint.v3.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.

 Envoy supports only one element and will NACK if more than one element is present.
 Other xDS-capable data planes will not necessarily have this limitation.

 In Envoy, this ``drop_overloads`` config can be overridden by a runtime key
 "load_balancing_policy.drop_overload_limit" setting. This runtime key can be set to
 any integer number between 0 and 100. 0 means drop 0%. 100 means drop 100%.
 When both ``drop_overloads`` config and "load_balancing_policy.drop_overload_limit"
 setting are in place, the min of these two wins.
        repeated .envoy.config.endpoint.v3.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.

 Envoy supports only one element and will NACK if more than one element is present.
 Other xDS-capable data planes will not necessarily have this limitation.

 In Envoy, this ``drop_overloads`` config can be overridden by a runtime key
 "load_balancing_policy.drop_overload_limit" setting. This runtime key can be set to
 any integer number between 0 and 100. 0 means drop 0%. 100 means drop 100%.
 When both ``drop_overloads`` config and "load_balancing_policy.drop_overload_limit"
 setting are in place, the min of these two wins.
        repeated .envoy.config.endpoint.v3.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 fraction 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 fraction 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 fraction 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

      • getWeightedPriorityHealth

        public boolean getWeightedPriorityHealth()
         If true, use the :ref:`load balancing weight
 <envoy_v3_api_field_config.endpoint.v3.LbEndpoint.load_balancing_weight>` of healthy and unhealthy
 hosts to determine the health of the priority level. If false, use the number of healthy and unhealthy hosts
 to determine the health of the priority level, or in other words assume each host has a weight of 1 for
 this calculation.

 Note: this is not currently implemented for
 :ref:`locality weighted load balancing <arch_overview_load_balancing_locality_weighted_lb>`.
        bool weighted_priority_health = 6;
        Specified by:
        getWeightedPriorityHealth in interface ClusterLoadAssignment.PolicyOrBuilder
        Returns:
        The weightedPriorityHealth.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ClusterLoadAssignment.Policy parseFrom​(java.nio.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​(java.io.InputStream input)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

        public static ClusterLoadAssignment.Policy parseFrom​(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws java.io.IOException
        Throws:
        java.io.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

      • 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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • 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.GeneratedMessage

      • getDefaultInstanceForType

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