io.envoyproxy.envoy.config.cluster.v3

Class Cluster.CommonLbConfig.ZoneAwareLbConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.cluster.v3.Cluster.CommonLbConfig.ZoneAwareLbConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder, Serializable

Enclosing class:

Cluster.CommonLbConfig

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

 Configuration for :ref:`zone aware routing
 <arch_overview_load_balancing_zone_aware_routing>`.
 

Protobuf type envoy.config.cluster.v3.Cluster.CommonLbConfig.ZoneAwareLbConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.CommonLbConfig.ZoneAwareLbConfig.Builder Configuration for :ref:`zone aware routing <arch_overview_load_balancing_zone_aware_routing>`.

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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAIL_TRAFFIC_ON_PANIC_FIELD_NUMBER
static int	MIN_CLUSTER_SIZE_FIELD_NUMBER
static int	ROUTING_ENABLED_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.ZoneAwareLbConfig	getDefaultInstance()
Cluster.CommonLbConfig.ZoneAwareLbConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getFailTrafficOnPanic() If set to true, Envoy will not consider any hosts when the cluster is in :ref:`panic mode<arch_overview_load_balancing_panic_threshold>`.
com.google.protobuf.UInt64Value	getMinClusterSize() Configures minimum upstream cluster size required for zone aware routing If upstream cluster size is less than specified, zone aware routing is not performed even if zone aware routing is configured.
com.google.protobuf.UInt64ValueOrBuilder	getMinClusterSizeOrBuilder() Configures minimum upstream cluster size required for zone aware routing If upstream cluster size is less than specified, zone aware routing is not performed even if zone aware routing is configured.
com.google.protobuf.Parser<Cluster.CommonLbConfig.ZoneAwareLbConfig>	getParserForType()
Percent	getRoutingEnabled() Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
PercentOrBuilder	getRoutingEnabledOrBuilder() Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasMinClusterSize() Configures minimum upstream cluster size required for zone aware routing If upstream cluster size is less than specified, zone aware routing is not performed even if zone aware routing is configured.
boolean	hasRoutingEnabled() Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Cluster.CommonLbConfig.ZoneAwareLbConfig.Builder	newBuilder()
static Cluster.CommonLbConfig.ZoneAwareLbConfig.Builder	newBuilder(Cluster.CommonLbConfig.ZoneAwareLbConfig prototype)
Cluster.CommonLbConfig.ZoneAwareLbConfig.Builder	newBuilderForType()
protected Cluster.CommonLbConfig.ZoneAwareLbConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseDelimitedFrom(InputStream input)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(byte[] data)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(ByteBuffer data)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(com.google.protobuf.ByteString data)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(InputStream input)
static Cluster.CommonLbConfig.ZoneAwareLbConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Cluster.CommonLbConfig.ZoneAwareLbConfig>	parser()
Cluster.CommonLbConfig.ZoneAwareLbConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, 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

ROUTING_ENABLED_FIELD_NUMBER

public static final int ROUTING_ENABLED_FIELD_NUMBER

See Also:

Constant Field Values

MIN_CLUSTER_SIZE_FIELD_NUMBER

public static final int MIN_CLUSTER_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

FAIL_TRAFFIC_ON_PANIC_FIELD_NUMBER

public static final int FAIL_TRAFFIC_ON_PANIC_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

hasRoutingEnabled

public boolean hasRoutingEnabled()

 Configures percentage of requests that will be considered for zone aware routing
 if zone aware routing is configured. If not specified, the default is 100%.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
 

.envoy.type.v3.Percent routing_enabled = 1;

Specified by:

hasRoutingEnabled in interface Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder

getRoutingEnabled

public Percent getRoutingEnabled()

 Configures percentage of requests that will be considered for zone aware routing
 if zone aware routing is configured. If not specified, the default is 100%.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
 

.envoy.type.v3.Percent routing_enabled = 1;

Specified by:

getRoutingEnabled in interface Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder

getRoutingEnabledOrBuilder

public PercentOrBuilder getRoutingEnabledOrBuilder()

 Configures percentage of requests that will be considered for zone aware routing
 if zone aware routing is configured. If not specified, the default is 100%.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
 

.envoy.type.v3.Percent routing_enabled = 1;

Specified by:

getRoutingEnabledOrBuilder in interface Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder

hasMinClusterSize

public boolean hasMinClusterSize()

 Configures minimum upstream cluster size required for zone aware routing
 If upstream cluster size is less than specified, zone aware routing is not performed
 even if zone aware routing is configured. If not specified, the default is 6.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
 

.google.protobuf.UInt64Value min_cluster_size = 2;

Specified by:

hasMinClusterSize in interface Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder

getMinClusterSize

public com.google.protobuf.UInt64Value getMinClusterSize()

 Configures minimum upstream cluster size required for zone aware routing
 If upstream cluster size is less than specified, zone aware routing is not performed
 even if zone aware routing is configured. If not specified, the default is 6.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
 

.google.protobuf.UInt64Value min_cluster_size = 2;

Specified by:

getMinClusterSize in interface Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder

getMinClusterSizeOrBuilder

public com.google.protobuf.UInt64ValueOrBuilder getMinClusterSizeOrBuilder()

 Configures minimum upstream cluster size required for zone aware routing
 If upstream cluster size is less than specified, zone aware routing is not performed
 even if zone aware routing is configured. If not specified, the default is 6.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
 

.google.protobuf.UInt64Value min_cluster_size = 2;

Specified by:

getMinClusterSizeOrBuilder in interface Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder

getFailTrafficOnPanic

public boolean getFailTrafficOnPanic()

 If set to true, Envoy will not consider any hosts when the cluster is in :ref:`panic
 mode<arch_overview_load_balancing_panic_threshold>`. Instead, the cluster will fail all
 requests as if all hosts are unhealthy. This can help avoid potentially overwhelming a
 failing service.
 

bool fail_traffic_on_panic = 3;

Specified by:

getFailTrafficOnPanic in interface Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig.ZoneAwareLbConfig 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.ZoneAwareLbConfig parseFrom(byte[] data)
                                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Cluster.CommonLbConfig.ZoneAwareLbConfig.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.ZoneAwareLbConfig.Builder newBuilder()

newBuilder

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

toBuilder

public Cluster.CommonLbConfig.ZoneAwareLbConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Cluster.CommonLbConfig.ZoneAwareLbConfig getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder