io.envoyproxy.envoy.api.v2

Class Cluster.CommonLbConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.Cluster.CommonLbConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cluster.CommonLbConfigOrBuilder, Serializable

Enclosing class:

Cluster

public static final class Cluster.CommonLbConfig
extends com.google.protobuf.GeneratedMessageV3
implements Cluster.CommonLbConfigOrBuilder

 Common configuration for all load balancer implementations.
 

Protobuf type envoy.api.v2.Cluster.CommonLbConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.CommonLbConfig.Builder Common configuration for all load balancer implementations.
static class	Cluster.CommonLbConfig.LocalityConfigSpecifierCase
static class	Cluster.CommonLbConfig.LocalityWeightedLbConfig Configuration for :ref:`locality weighted load balancing <arch_overview_load_balancing_locality_weighted_lb>` Protobuf type envoy.api.v2.Cluster.CommonLbConfig.LocalityWeightedLbConfig
static interface	Cluster.CommonLbConfig.LocalityWeightedLbConfigOrBuilder
static class	Cluster.CommonLbConfig.ZoneAwareLbConfig Configuration for :ref:`zone aware routing <arch_overview_load_balancing_zone_aware_routing>`.
static interface	Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEALTHY_PANIC_THRESHOLD_FIELD_NUMBER
static int	LOCALITY_WEIGHTED_LB_CONFIG_FIELD_NUMBER
static int	UPDATE_MERGE_WINDOW_FIELD_NUMBER
static int	ZONE_AWARE_LB_CONFIG_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

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Cluster.CommonLbConfig	getDefaultInstance()
Cluster.CommonLbConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Percent	getHealthyPanicThreshold() Configures the :ref:`healthy panic threshold <arch_overview_load_balancing_panic_threshold>`.
PercentOrBuilder	getHealthyPanicThresholdOrBuilder() Configures the :ref:`healthy panic threshold <arch_overview_load_balancing_panic_threshold>`.
Cluster.CommonLbConfig.LocalityConfigSpecifierCase	getLocalityConfigSpecifierCase()
Cluster.CommonLbConfig.LocalityWeightedLbConfig	getLocalityWeightedLbConfig() .envoy.api.v2.Cluster.CommonLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 3;
Cluster.CommonLbConfig.LocalityWeightedLbConfigOrBuilder	getLocalityWeightedLbConfigOrBuilder() .envoy.api.v2.Cluster.CommonLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 3;
com.google.protobuf.Parser<Cluster.CommonLbConfig>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
com.google.protobuf.Duration	getUpdateMergeWindow() If set, all health check/weight/metadata updates that happen within this duration will be merged and delivered in one shot when the duration expires.
com.google.protobuf.DurationOrBuilder	getUpdateMergeWindowOrBuilder() If set, all health check/weight/metadata updates that happen within this duration will be merged and delivered in one shot when the duration expires.
Cluster.CommonLbConfig.ZoneAwareLbConfig	getZoneAwareLbConfig() .envoy.api.v2.Cluster.CommonLbConfig.ZoneAwareLbConfig zone_aware_lb_config = 2;
Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder	getZoneAwareLbConfigOrBuilder() .envoy.api.v2.Cluster.CommonLbConfig.ZoneAwareLbConfig zone_aware_lb_config = 2;
int	hashCode()
boolean	hasHealthyPanicThreshold() Configures the :ref:`healthy panic threshold <arch_overview_load_balancing_panic_threshold>`.
boolean	hasLocalityWeightedLbConfig() .envoy.api.v2.Cluster.CommonLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 3;
boolean	hasUpdateMergeWindow() If set, all health check/weight/metadata updates that happen within this duration will be merged and delivered in one shot when the duration expires.
boolean	hasZoneAwareLbConfig() .envoy.api.v2.Cluster.CommonLbConfig.ZoneAwareLbConfig zone_aware_lb_config = 2;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Cluster.CommonLbConfig.Builder	newBuilder()
static Cluster.CommonLbConfig.Builder	newBuilder(Cluster.CommonLbConfig prototype)
Cluster.CommonLbConfig.Builder	newBuilderForType()
protected Cluster.CommonLbConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Cluster.CommonLbConfig	parseDelimitedFrom(InputStream input)
static Cluster.CommonLbConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig	parseFrom(byte[] data)
static Cluster.CommonLbConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig	parseFrom(ByteBuffer data)
static Cluster.CommonLbConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig	parseFrom(com.google.protobuf.ByteString data)
static Cluster.CommonLbConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Cluster.CommonLbConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig	parseFrom(InputStream input)
static Cluster.CommonLbConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Cluster.CommonLbConfig>	parser()
Cluster.CommonLbConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

HEALTHY_PANIC_THRESHOLD_FIELD_NUMBER

public static final int HEALTHY_PANIC_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

ZONE_AWARE_LB_CONFIG_FIELD_NUMBER

public static final int ZONE_AWARE_LB_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

LOCALITY_WEIGHTED_LB_CONFIG_FIELD_NUMBER

public static final int LOCALITY_WEIGHTED_LB_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_MERGE_WINDOW_FIELD_NUMBER

public static final int UPDATE_MERGE_WINDOW_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

getLocalityConfigSpecifierCase

public Cluster.CommonLbConfig.LocalityConfigSpecifierCase getLocalityConfigSpecifierCase()

Specified by:

getLocalityConfigSpecifierCase in interface Cluster.CommonLbConfigOrBuilder

hasHealthyPanicThreshold

public boolean hasHealthyPanicThreshold()

 Configures the :ref:`healthy panic threshold <arch_overview_load_balancing_panic_threshold>`.
 If not specified, the default is 50%.
 .. note::
   The specified percent will be truncated to the nearest 1%.
 

.envoy.type.Percent healthy_panic_threshold = 1;

Specified by:

hasHealthyPanicThreshold in interface Cluster.CommonLbConfigOrBuilder

getHealthyPanicThreshold

public Percent getHealthyPanicThreshold()

 Configures the :ref:`healthy panic threshold <arch_overview_load_balancing_panic_threshold>`.
 If not specified, the default is 50%.
 .. note::
   The specified percent will be truncated to the nearest 1%.
 

.envoy.type.Percent healthy_panic_threshold = 1;

Specified by:

getHealthyPanicThreshold in interface Cluster.CommonLbConfigOrBuilder

getHealthyPanicThresholdOrBuilder

public PercentOrBuilder getHealthyPanicThresholdOrBuilder()

 Configures the :ref:`healthy panic threshold <arch_overview_load_balancing_panic_threshold>`.
 If not specified, the default is 50%.
 .. note::
   The specified percent will be truncated to the nearest 1%.
 

.envoy.type.Percent healthy_panic_threshold = 1;

Specified by:

getHealthyPanicThresholdOrBuilder in interface Cluster.CommonLbConfigOrBuilder

hasZoneAwareLbConfig

public boolean hasZoneAwareLbConfig()

.envoy.api.v2.Cluster.CommonLbConfig.ZoneAwareLbConfig zone_aware_lb_config = 2;

Specified by:

hasZoneAwareLbConfig in interface Cluster.CommonLbConfigOrBuilder

getZoneAwareLbConfig

public Cluster.CommonLbConfig.ZoneAwareLbConfig getZoneAwareLbConfig()

.envoy.api.v2.Cluster.CommonLbConfig.ZoneAwareLbConfig zone_aware_lb_config = 2;

Specified by:

getZoneAwareLbConfig in interface Cluster.CommonLbConfigOrBuilder

getZoneAwareLbConfigOrBuilder

public Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder getZoneAwareLbConfigOrBuilder()

.envoy.api.v2.Cluster.CommonLbConfig.ZoneAwareLbConfig zone_aware_lb_config = 2;

Specified by:

getZoneAwareLbConfigOrBuilder in interface Cluster.CommonLbConfigOrBuilder

hasLocalityWeightedLbConfig

public boolean hasLocalityWeightedLbConfig()

.envoy.api.v2.Cluster.CommonLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 3;

Specified by:

hasLocalityWeightedLbConfig in interface Cluster.CommonLbConfigOrBuilder

getLocalityWeightedLbConfig

public Cluster.CommonLbConfig.LocalityWeightedLbConfig getLocalityWeightedLbConfig()

.envoy.api.v2.Cluster.CommonLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 3;

Specified by:

getLocalityWeightedLbConfig in interface Cluster.CommonLbConfigOrBuilder

getLocalityWeightedLbConfigOrBuilder

public Cluster.CommonLbConfig.LocalityWeightedLbConfigOrBuilder getLocalityWeightedLbConfigOrBuilder()

.envoy.api.v2.Cluster.CommonLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 3;

Specified by:

getLocalityWeightedLbConfigOrBuilder in interface Cluster.CommonLbConfigOrBuilder

hasUpdateMergeWindow

public boolean hasUpdateMergeWindow()

 If set, all health check/weight/metadata updates that happen within this duration will be
 merged and delivered in one shot when the duration expires. The start of the duration is when
 the first update happens. This is useful for big clusters, with potentially noisy deploys
 that might trigger excessive CPU usage due to a constant stream of healthcheck state changes
 or metadata updates. The first set of updates to be seen apply immediately (e.g.: a new
 cluster).
 If this is not set, we default to a merge window of 1000ms. To disable it, set the merge
 window to 0.
 Note: merging does not apply to cluster membership changes (e.g.: adds/removes); this is
 because merging those updates isn't currently safe. See
 https://github.com/envoyproxy/envoy/pull/3941.
 

.google.protobuf.Duration update_merge_window = 4;

Specified by:

hasUpdateMergeWindow in interface Cluster.CommonLbConfigOrBuilder

getUpdateMergeWindow

public com.google.protobuf.Duration getUpdateMergeWindow()

 If set, all health check/weight/metadata updates that happen within this duration will be
 merged and delivered in one shot when the duration expires. The start of the duration is when
 the first update happens. This is useful for big clusters, with potentially noisy deploys
 that might trigger excessive CPU usage due to a constant stream of healthcheck state changes
 or metadata updates. The first set of updates to be seen apply immediately (e.g.: a new
 cluster).
 If this is not set, we default to a merge window of 1000ms. To disable it, set the merge
 window to 0.
 Note: merging does not apply to cluster membership changes (e.g.: adds/removes); this is
 because merging those updates isn't currently safe. See
 https://github.com/envoyproxy/envoy/pull/3941.
 

.google.protobuf.Duration update_merge_window = 4;

Specified by:

getUpdateMergeWindow in interface Cluster.CommonLbConfigOrBuilder

getUpdateMergeWindowOrBuilder

public com.google.protobuf.DurationOrBuilder getUpdateMergeWindowOrBuilder()

 If set, all health check/weight/metadata updates that happen within this duration will be
 merged and delivered in one shot when the duration expires. The start of the duration is when
 the first update happens. This is useful for big clusters, with potentially noisy deploys
 that might trigger excessive CPU usage due to a constant stream of healthcheck state changes
 or metadata updates. The first set of updates to be seen apply immediately (e.g.: a new
 cluster).
 If this is not set, we default to a merge window of 1000ms. To disable it, set the merge
 window to 0.
 Note: merging does not apply to cluster membership changes (e.g.: adds/removes); this is
 because merging those updates isn't currently safe. See
 https://github.com/envoyproxy/envoy/pull/3941.
 

.google.protobuf.Duration update_merge_window = 4;

Specified by:

getUpdateMergeWindowOrBuilder in interface Cluster.CommonLbConfigOrBuilder

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 Cluster.CommonLbConfig parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig parseFrom(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig parseFrom(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static Cluster.CommonLbConfig parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cluster.CommonLbConfig parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cluster.CommonLbConfig parseDelimitedFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseFrom

public static Cluster.CommonLbConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static Cluster.CommonLbConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

newBuilderForType

public Cluster.CommonLbConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Cluster.CommonLbConfig.Builder newBuilder()

newBuilder

public static Cluster.CommonLbConfig.Builder newBuilder(Cluster.CommonLbConfig prototype)

toBuilder

public Cluster.CommonLbConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Cluster.CommonLbConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Cluster.CommonLbConfig getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Cluster.CommonLbConfig> 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 Cluster.CommonLbConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder