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.config.endpoint.v3.ClusterLoadAssignment.Policy| Modifier and Type | Class and Description |
|---|---|
static class |
ClusterLoadAssignment.Policy.Builder
Load balancing policy settings.
|
static class |
ClusterLoadAssignment.Policy.DropOverload
[#not-implemented-hide:]
Protobuf type
envoy.config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload |
static interface |
ClusterLoadAssignment.Policy.DropOverloadOrBuilder |
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| Modifier and Type | Field and Description |
|---|---|
static int |
DROP_OVERLOADS_FIELD_NUMBER |
static int |
ENDPOINT_STALE_AFTER_FIELD_NUMBER |
static int |
OVERPROVISIONING_FACTOR_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static ClusterLoadAssignment.Policy |
getDefaultInstance() |
ClusterLoadAssignment.Policy |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
ClusterLoadAssignment.Policy.DropOverload |
getDropOverloads(int index)
Action to trim the overall incoming traffic to protect the upstream
hosts.
|
int |
getDropOverloadsCount()
Action to trim the overall incoming traffic to protect the upstream
hosts.
|
List<ClusterLoadAssignment.Policy.DropOverload> |
getDropOverloadsList()
Action to trim the overall incoming traffic to protect the upstream
hosts.
|
ClusterLoadAssignment.Policy.DropOverloadOrBuilder |
getDropOverloadsOrBuilder(int index)
Action to trim the overall incoming traffic to protect the upstream
hosts.
|
List<? extends ClusterLoadAssignment.Policy.DropOverloadOrBuilder> |
getDropOverloadsOrBuilderList()
Action to trim the overall incoming traffic to protect the upstream
hosts.
|
com.google.protobuf.Duration |
getEndpointStaleAfter()
The max time until which the endpoints from this assignment can be used.
|
com.google.protobuf.DurationOrBuilder |
getEndpointStaleAfterOrBuilder()
The max time until which the endpoints from this assignment can be used.
|
com.google.protobuf.UInt32Value |
getOverprovisioningFactor()
Priority levels and localities are considered overprovisioned with this
factor (in percentage).
|
com.google.protobuf.UInt32ValueOrBuilder |
getOverprovisioningFactorOrBuilder()
Priority levels and localities are considered overprovisioned with this
factor (in percentage).
|
com.google.protobuf.Parser<ClusterLoadAssignment.Policy> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasEndpointStaleAfter()
The max time until which the endpoints from this assignment can be used.
|
int |
hashCode() |
boolean |
hasOverprovisioningFactor()
Priority levels and localities are considered overprovisioned with this
factor (in percentage).
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ClusterLoadAssignment.Policy.Builder |
newBuilder() |
static ClusterLoadAssignment.Policy.Builder |
newBuilder(ClusterLoadAssignment.Policy prototype) |
ClusterLoadAssignment.Policy.Builder |
newBuilderForType() |
protected ClusterLoadAssignment.Policy.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ClusterLoadAssignment.Policy |
parseDelimitedFrom(InputStream input) |
static ClusterLoadAssignment.Policy |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterLoadAssignment.Policy |
parseFrom(byte[] data) |
static ClusterLoadAssignment.Policy |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterLoadAssignment.Policy |
parseFrom(ByteBuffer data) |
static ClusterLoadAssignment.Policy |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterLoadAssignment.Policy |
parseFrom(com.google.protobuf.ByteString data) |
static ClusterLoadAssignment.Policy |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterLoadAssignment.Policy |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ClusterLoadAssignment.Policy |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterLoadAssignment.Policy |
parseFrom(InputStream input) |
static ClusterLoadAssignment.Policy |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ClusterLoadAssignment.Policy> |
parser() |
ClusterLoadAssignment.Policy.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int DROP_OVERLOADS_FIELD_NUMBER
public static final int OVERPROVISIONING_FACTOR_FIELD_NUMBER
public static final int ENDPOINT_STALE_AFTER_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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.config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;getDropOverloadsList in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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.config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;getDropOverloadsOrBuilderList in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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.config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;getDropOverloadsCount in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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.config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;getDropOverloads in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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.config.endpoint.v3.ClusterLoadAssignment.Policy.DropOverload drop_overloads = 2;getDropOverloadsOrBuilder in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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) = { ... }hasOverprovisioningFactor in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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) = { ... }getOverprovisioningFactor in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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) = { ... }getOverprovisioningFactorOrBuilder in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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) = { ... }hasEndpointStaleAfter in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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) = { ... }getEndpointStaleAfter in interface ClusterLoadAssignment.PolicyOrBuilderpublic 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) = { ... }getEndpointStaleAfterOrBuilder in interface ClusterLoadAssignment.PolicyOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ClusterLoadAssignment.Policy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterLoadAssignment.Policy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterLoadAssignment.Policy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterLoadAssignment.Policy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterLoadAssignment.Policy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterLoadAssignment.Policy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterLoadAssignment.Policy parseFrom(InputStream input) throws IOException
IOExceptionpublic static ClusterLoadAssignment.Policy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ClusterLoadAssignment.Policy parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ClusterLoadAssignment.Policy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ClusterLoadAssignment.Policy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ClusterLoadAssignment.Policy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ClusterLoadAssignment.Policy.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ClusterLoadAssignment.Policy.Builder newBuilder()
public static ClusterLoadAssignment.Policy.Builder newBuilder(ClusterLoadAssignment.Policy prototype)
public ClusterLoadAssignment.Policy.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ClusterLoadAssignment.Policy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ClusterLoadAssignment.Policy getDefaultInstance()
public static com.google.protobuf.Parser<ClusterLoadAssignment.Policy> parser()
public com.google.protobuf.Parser<ClusterLoadAssignment.Policy> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ClusterLoadAssignment.Policy getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.