Package io.envoyproxy.envoy.api.v2.route

Class WeightedCluster

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.route.WeightedCluster

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WeightedClusterOrBuilder, Serializable

public final class WeightedCluster
extends com.google.protobuf.GeneratedMessageV3
implements WeightedClusterOrBuilder

 Compared to the :ref:`cluster <envoy_api_field_route.RouteAction.cluster>` field that specifies a
 single upstream cluster as the target of a request, the :ref:`weighted_clusters
 <envoy_api_field_route.RouteAction.weighted_clusters>` option allows for specification of
 multiple upstream clusters along with weights that indicate the percentage of
 traffic to be forwarded to each cluster. The router selects an upstream cluster based on the
 weights.
 

Protobuf type envoy.api.v2.route.WeightedCluster

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WeightedCluster.Builder	Compared to the :ref:`cluster <envoy_api_field_route.RouteAction.cluster>` field that specifies a single upstream cluster as the target of a request, the :ref:`weighted_clusters <envoy_api_field_route.RouteAction.weighted_clusters>` option allows for specification of multiple upstream clusters along with weights that indicate the percentage of traffic to be forwarded to each cluster.
static final class	WeightedCluster.ClusterWeight	[#next-free-field: 11]
static interface	WeightedCluster.ClusterWeightOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CLUSTERS_FIELD_NUMBER
static final int	RUNTIME_KEY_PREFIX_FIELD_NUMBER
static final int	TOTAL_WEIGHT_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	Description
boolean	equals(Object obj)
WeightedCluster.ClusterWeight	getClusters(int index)	Specifies one or more upstream clusters associated with the route.
int	getClustersCount()	Specifies one or more upstream clusters associated with the route.
List<WeightedCluster.ClusterWeight>	getClustersList()	Specifies one or more upstream clusters associated with the route.
WeightedCluster.ClusterWeightOrBuilder	getClustersOrBuilder(int index)	Specifies one or more upstream clusters associated with the route.
List<? extends WeightedCluster.ClusterWeightOrBuilder>	getClustersOrBuilderList()	Specifies one or more upstream clusters associated with the route.
static WeightedCluster	getDefaultInstance()
WeightedCluster	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<WeightedCluster>	getParserForType()
String	getRuntimeKeyPrefix()	Specifies the runtime key prefix that should be used to construct the runtime keys associated with each cluster.
com.google.protobuf.ByteString	getRuntimeKeyPrefixBytes()	Specifies the runtime key prefix that should be used to construct the runtime keys associated with each cluster.
int	getSerializedSize()
com.google.protobuf.UInt32Value	getTotalWeight()	Specifies the total weight across all clusters.
com.google.protobuf.UInt32ValueOrBuilder	getTotalWeightOrBuilder()	Specifies the total weight across all clusters.
int	hashCode()
boolean	hasTotalWeight()	Specifies the total weight across all clusters.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static WeightedCluster.Builder	newBuilder()
static WeightedCluster.Builder	newBuilder(WeightedCluster prototype)
WeightedCluster.Builder	newBuilderForType()
protected WeightedCluster.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static WeightedCluster	parseDelimitedFrom(InputStream input)
static WeightedCluster	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedCluster	parseFrom(byte[] data)
static WeightedCluster	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedCluster	parseFrom(com.google.protobuf.ByteString data)
static WeightedCluster	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedCluster	parseFrom(com.google.protobuf.CodedInputStream input)
static WeightedCluster	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedCluster	parseFrom(InputStream input)
static WeightedCluster	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedCluster	parseFrom(ByteBuffer data)
static WeightedCluster	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<WeightedCluster>	parser()
WeightedCluster.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

CLUSTERS_FIELD_NUMBER

public static final int CLUSTERS_FIELD_NUMBER

See Also:

• Constant Field Values

TOTAL_WEIGHT_FIELD_NUMBER

public static final int TOTAL_WEIGHT_FIELD_NUMBER

See Also:

• Constant Field Values

RUNTIME_KEY_PREFIX_FIELD_NUMBER

public static final int RUNTIME_KEY_PREFIX_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

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

Overrides:

newInstance 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

getClustersList

public List<WeightedCluster.ClusterWeight> getClustersList()

 Specifies one or more upstream clusters associated with the route.
 

repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

Specified by:

getClustersList in interface WeightedClusterOrBuilder

getClustersOrBuilderList

public List<? extends WeightedCluster.ClusterWeightOrBuilder> getClustersOrBuilderList()

 Specifies one or more upstream clusters associated with the route.
 

repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

Specified by:

getClustersOrBuilderList in interface WeightedClusterOrBuilder

getClustersCount

public int getClustersCount()

 Specifies one or more upstream clusters associated with the route.
 

repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

Specified by:

getClustersCount in interface WeightedClusterOrBuilder

getClusters

public WeightedCluster.ClusterWeight getClusters(int index)

 Specifies one or more upstream clusters associated with the route.
 

repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

Specified by:

getClusters in interface WeightedClusterOrBuilder

getClustersOrBuilder

public WeightedCluster.ClusterWeightOrBuilder getClustersOrBuilder(int index)

 Specifies one or more upstream clusters associated with the route.
 

repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

Specified by:

getClustersOrBuilder in interface WeightedClusterOrBuilder

hasTotalWeight

public boolean hasTotalWeight()

 Specifies the total weight across all clusters. The sum of all cluster weights must equal this
 value, which must be greater than 0. Defaults to 100.
 

.google.protobuf.UInt32Value total_weight = 3 [(.validate.rules) = { ... }

Specified by:

hasTotalWeight in interface WeightedClusterOrBuilder

Returns:

Whether the totalWeight field is set.

getTotalWeight

public com.google.protobuf.UInt32Value getTotalWeight()

 Specifies the total weight across all clusters. The sum of all cluster weights must equal this
 value, which must be greater than 0. Defaults to 100.
 

.google.protobuf.UInt32Value total_weight = 3 [(.validate.rules) = { ... }

Specified by:

getTotalWeight in interface WeightedClusterOrBuilder

Returns:

The totalWeight.

getTotalWeightOrBuilder

public com.google.protobuf.UInt32ValueOrBuilder getTotalWeightOrBuilder()

 Specifies the total weight across all clusters. The sum of all cluster weights must equal this
 value, which must be greater than 0. Defaults to 100.
 

.google.protobuf.UInt32Value total_weight = 3 [(.validate.rules) = { ... }

Specified by:

getTotalWeightOrBuilder in interface WeightedClusterOrBuilder

getRuntimeKeyPrefix

public String getRuntimeKeyPrefix()

 Specifies the runtime key prefix that should be used to construct the
 runtime keys associated with each cluster. When the *runtime_key_prefix* is
 specified, the router will look for weights associated with each upstream
 cluster under the key *runtime_key_prefix* + "." + *cluster[i].name* where
 *cluster[i]* denotes an entry in the clusters array field. If the runtime
 key for the cluster does not exist, the value specified in the
 configuration file will be used as the default weight. See the :ref:`runtime documentation
 <operations_runtime>` for how key names map to the underlying implementation.
 

string runtime_key_prefix = 2;

Specified by:

getRuntimeKeyPrefix in interface WeightedClusterOrBuilder

Returns:

The runtimeKeyPrefix.

getRuntimeKeyPrefixBytes

public com.google.protobuf.ByteString getRuntimeKeyPrefixBytes()

 Specifies the runtime key prefix that should be used to construct the
 runtime keys associated with each cluster. When the *runtime_key_prefix* is
 specified, the router will look for weights associated with each upstream
 cluster under the key *runtime_key_prefix* + "." + *cluster[i].name* where
 *cluster[i]* denotes an entry in the clusters array field. If the runtime
 key for the cluster does not exist, the value specified in the
 configuration file will be used as the default weight. See the :ref:`runtime documentation
 <operations_runtime>` for how key names map to the underlying implementation.
 

string runtime_key_prefix = 2;

Specified by:

getRuntimeKeyPrefixBytes in interface WeightedClusterOrBuilder

Returns:

The bytes for runtimeKeyPrefix.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WeightedCluster parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static WeightedCluster parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public WeightedCluster.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static WeightedCluster.Builder newBuilder()

newBuilder

public static WeightedCluster.Builder newBuilder(WeightedCluster prototype)

toBuilder

public WeightedCluster.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static WeightedCluster getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder