io.envoyproxy.envoy.api.v2

Class ClusterLoadAssignment

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.ClusterLoadAssignment

All Implemented Interfaces:

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

public final class ClusterLoadAssignment
extends com.google.protobuf.GeneratedMessageV3
implements ClusterLoadAssignmentOrBuilder

 Each route from RDS will map to a single cluster or traffic split across
 clusters using weights expressed in the RDS WeightedCluster.
 With EDS, each cluster is treated independently from a LB perspective, with
 LB taking place between the Localities within a cluster and at a finer
 granularity between the hosts within a locality. The percentage of traffic
 for each endpoint is determined by both its load_balancing_weight, and the
 load_balancing_weight of its locality. First, a locality will be selected,
 then an endpoint within that locality will be chose based on its weight.
 [#next-free-field: 6]
 

Protobuf type envoy.api.v2.ClusterLoadAssignment

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterLoadAssignment.Builder Each route from RDS will map to a single cluster or traffic split across clusters using weights expressed in the RDS WeightedCluster.
static class	ClusterLoadAssignment.Policy Load balancing policy settings.
static interface	ClusterLoadAssignment.PolicyOrBuilder

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	CLUSTER_NAME_FIELD_NUMBER
static int	ENDPOINTS_FIELD_NUMBER
static int	NAMED_ENDPOINTS_FIELD_NUMBER
static int	POLICY_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	containsNamedEndpoints(String key) Map of named endpoints that can be referenced in LocalityLbEndpoints.
boolean	equals(Object obj)
String	getClusterName() Name of the cluster.
com.google.protobuf.ByteString	getClusterNameBytes() Name of the cluster.
static ClusterLoadAssignment	getDefaultInstance()
ClusterLoadAssignment	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
LocalityLbEndpoints	getEndpoints(int index) List of endpoints to load balance to.
int	getEndpointsCount() List of endpoints to load balance to.
List<LocalityLbEndpoints>	getEndpointsList() List of endpoints to load balance to.
LocalityLbEndpointsOrBuilder	getEndpointsOrBuilder(int index) List of endpoints to load balance to.
List<? extends LocalityLbEndpointsOrBuilder>	getEndpointsOrBuilderList() List of endpoints to load balance to.
Map<String,Endpoint>	getNamedEndpoints() Deprecated.
int	getNamedEndpointsCount() Map of named endpoints that can be referenced in LocalityLbEndpoints.
Map<String,Endpoint>	getNamedEndpointsMap() Map of named endpoints that can be referenced in LocalityLbEndpoints.
Endpoint	getNamedEndpointsOrDefault(String key, Endpoint defaultValue) Map of named endpoints that can be referenced in LocalityLbEndpoints.
Endpoint	getNamedEndpointsOrThrow(String key) Map of named endpoints that can be referenced in LocalityLbEndpoints.
com.google.protobuf.Parser<ClusterLoadAssignment>	getParserForType()
ClusterLoadAssignment.Policy	getPolicy() Load balancing policy settings.
ClusterLoadAssignment.PolicyOrBuilder	getPolicyOrBuilder() Load balancing policy settings.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasPolicy() Load balancing policy settings.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static ClusterLoadAssignment.Builder	newBuilder()
static ClusterLoadAssignment.Builder	newBuilder(ClusterLoadAssignment prototype)
ClusterLoadAssignment.Builder	newBuilderForType()
protected ClusterLoadAssignment.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ClusterLoadAssignment	parseDelimitedFrom(InputStream input)
static ClusterLoadAssignment	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterLoadAssignment	parseFrom(byte[] data)
static ClusterLoadAssignment	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterLoadAssignment	parseFrom(ByteBuffer data)
static ClusterLoadAssignment	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterLoadAssignment	parseFrom(com.google.protobuf.ByteString data)
static ClusterLoadAssignment	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterLoadAssignment	parseFrom(com.google.protobuf.CodedInputStream input)
static ClusterLoadAssignment	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterLoadAssignment	parseFrom(InputStream input)
static ClusterLoadAssignment	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ClusterLoadAssignment>	parser()
ClusterLoadAssignment.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, 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

CLUSTER_NAME_FIELD_NUMBER

public static final int CLUSTER_NAME_FIELD_NUMBER

See Also:

Constant Field Values

ENDPOINTS_FIELD_NUMBER

public static final int ENDPOINTS_FIELD_NUMBER

See Also:

Constant Field Values

NAMED_ENDPOINTS_FIELD_NUMBER

public static final int NAMED_ENDPOINTS_FIELD_NUMBER

See Also:

Constant Field Values

POLICY_FIELD_NUMBER

public static final int POLICY_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()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getClusterName

public String getClusterName()

 Name of the cluster. This will be the :ref:`service_name
 <envoy_api_field_Cluster.EdsClusterConfig.service_name>` value if specified
 in the cluster :ref:`EdsClusterConfig
 <envoy_api_msg_Cluster.EdsClusterConfig>`.
 

string cluster_name = 1 [(.validate.rules) = { ... }

Specified by:

getClusterName in interface ClusterLoadAssignmentOrBuilder

getClusterNameBytes

public com.google.protobuf.ByteString getClusterNameBytes()

 Name of the cluster. This will be the :ref:`service_name
 <envoy_api_field_Cluster.EdsClusterConfig.service_name>` value if specified
 in the cluster :ref:`EdsClusterConfig
 <envoy_api_msg_Cluster.EdsClusterConfig>`.
 

string cluster_name = 1 [(.validate.rules) = { ... }

Specified by:

getClusterNameBytes in interface ClusterLoadAssignmentOrBuilder

getEndpointsList

public List<LocalityLbEndpoints> getEndpointsList()

 List of endpoints to load balance to.
 

repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

Specified by:

getEndpointsList in interface ClusterLoadAssignmentOrBuilder

getEndpointsOrBuilderList

public List<? extends LocalityLbEndpointsOrBuilder> getEndpointsOrBuilderList()

 List of endpoints to load balance to.
 

repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

Specified by:

getEndpointsOrBuilderList in interface ClusterLoadAssignmentOrBuilder

getEndpointsCount

public int getEndpointsCount()

 List of endpoints to load balance to.
 

repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

Specified by:

getEndpointsCount in interface ClusterLoadAssignmentOrBuilder

getEndpoints

public LocalityLbEndpoints getEndpoints(int index)

 List of endpoints to load balance to.
 

repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

Specified by:

getEndpoints in interface ClusterLoadAssignmentOrBuilder

getEndpointsOrBuilder

public LocalityLbEndpointsOrBuilder getEndpointsOrBuilder(int index)

 List of endpoints to load balance to.
 

repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

Specified by:

getEndpointsOrBuilder in interface ClusterLoadAssignmentOrBuilder

getNamedEndpointsCount

public int getNamedEndpointsCount()

Description copied from interface: ClusterLoadAssignmentOrBuilder

 Map of named endpoints that can be referenced in LocalityLbEndpoints.
 [#not-implemented-hide:]
 

map<string, .envoy.api.v2.endpoint.Endpoint> named_endpoints = 5;

Specified by:

getNamedEndpointsCount in interface ClusterLoadAssignmentOrBuilder

containsNamedEndpoints

public boolean containsNamedEndpoints(String key)

 Map of named endpoints that can be referenced in LocalityLbEndpoints.
 [#not-implemented-hide:]
 

map<string, .envoy.api.v2.endpoint.Endpoint> named_endpoints = 5;

Specified by:

containsNamedEndpoints in interface ClusterLoadAssignmentOrBuilder

getNamedEndpoints

@Deprecated
public Map<String,Endpoint> getNamedEndpoints()

Deprecated.

Use getNamedEndpointsMap() instead.

Specified by:

getNamedEndpoints in interface ClusterLoadAssignmentOrBuilder

getNamedEndpointsMap

public Map<String,Endpoint> getNamedEndpointsMap()

 Map of named endpoints that can be referenced in LocalityLbEndpoints.
 [#not-implemented-hide:]
 

map<string, .envoy.api.v2.endpoint.Endpoint> named_endpoints = 5;

Specified by:

getNamedEndpointsMap in interface ClusterLoadAssignmentOrBuilder

getNamedEndpointsOrDefault

public Endpoint getNamedEndpointsOrDefault(String key,
                                           Endpoint defaultValue)

 Map of named endpoints that can be referenced in LocalityLbEndpoints.
 [#not-implemented-hide:]
 

map<string, .envoy.api.v2.endpoint.Endpoint> named_endpoints = 5;

Specified by:

getNamedEndpointsOrDefault in interface ClusterLoadAssignmentOrBuilder

getNamedEndpointsOrThrow

public Endpoint getNamedEndpointsOrThrow(String key)

 Map of named endpoints that can be referenced in LocalityLbEndpoints.
 [#not-implemented-hide:]
 

map<string, .envoy.api.v2.endpoint.Endpoint> named_endpoints = 5;

Specified by:

getNamedEndpointsOrThrow in interface ClusterLoadAssignmentOrBuilder

hasPolicy

public boolean hasPolicy()

 Load balancing policy settings.
 

.envoy.api.v2.ClusterLoadAssignment.Policy policy = 4;

Specified by:

hasPolicy in interface ClusterLoadAssignmentOrBuilder

getPolicy

public ClusterLoadAssignment.Policy getPolicy()

 Load balancing policy settings.
 

.envoy.api.v2.ClusterLoadAssignment.Policy policy = 4;

Specified by:

getPolicy in interface ClusterLoadAssignmentOrBuilder

getPolicyOrBuilder

public ClusterLoadAssignment.PolicyOrBuilder getPolicyOrBuilder()

 Load balancing policy settings.
 

.envoy.api.v2.ClusterLoadAssignment.Policy policy = 4;

Specified by:

getPolicyOrBuilder in interface ClusterLoadAssignmentOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClusterLoadAssignment parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ClusterLoadAssignment parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ClusterLoadAssignment.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ClusterLoadAssignment.Builder newBuilder()

newBuilder

public static ClusterLoadAssignment.Builder newBuilder(ClusterLoadAssignment prototype)

toBuilder

public ClusterLoadAssignment.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ClusterLoadAssignment getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder