io.envoyproxy.envoy.config.endpoint.v3

Class LbEndpoint

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.endpoint.v3.LbEndpoint

All Implemented Interfaces:

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

public final class LbEndpoint
extends com.google.protobuf.GeneratedMessageV3
implements LbEndpointOrBuilder

 An Endpoint that Envoy can route traffic to.
 [#next-free-field: 6]
 

Protobuf type envoy.config.endpoint.v3.LbEndpoint

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LbEndpoint.Builder An Endpoint that Envoy can route traffic to.
static class	LbEndpoint.HostIdentifierCase

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	ENDPOINT_FIELD_NUMBER
static int	ENDPOINT_NAME_FIELD_NUMBER
static int	HEALTH_STATUS_FIELD_NUMBER
static int	LOAD_BALANCING_WEIGHT_FIELD_NUMBER
static int	METADATA_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 LbEndpoint	getDefaultInstance()
LbEndpoint	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Endpoint	getEndpoint() .envoy.config.endpoint.v3.Endpoint endpoint = 1;
String	getEndpointName() [#not-implemented-hide:] string endpoint_name = 5;
com.google.protobuf.ByteString	getEndpointNameBytes() [#not-implemented-hide:] string endpoint_name = 5;
EndpointOrBuilder	getEndpointOrBuilder() .envoy.config.endpoint.v3.Endpoint endpoint = 1;
HealthStatus	getHealthStatus() Optional health status when known and supplied by EDS server.
int	getHealthStatusValue() Optional health status when known and supplied by EDS server.
LbEndpoint.HostIdentifierCase	getHostIdentifierCase()
com.google.protobuf.UInt32Value	getLoadBalancingWeight() The optional load balancing weight of the upstream host; at least 1.
com.google.protobuf.UInt32ValueOrBuilder	getLoadBalancingWeightOrBuilder() The optional load balancing weight of the upstream host; at least 1.
Metadata	getMetadata() The endpoint metadata specifies values that may be used by the load balancer to select endpoints in a cluster for a given request.
MetadataOrBuilder	getMetadataOrBuilder() The endpoint metadata specifies values that may be used by the load balancer to select endpoints in a cluster for a given request.
com.google.protobuf.Parser<LbEndpoint>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasEndpoint() .envoy.config.endpoint.v3.Endpoint endpoint = 1;
int	hashCode()
boolean	hasLoadBalancingWeight() The optional load balancing weight of the upstream host; at least 1.
boolean	hasMetadata() The endpoint metadata specifies values that may be used by the load balancer to select endpoints in a cluster for a given request.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LbEndpoint.Builder	newBuilder()
static LbEndpoint.Builder	newBuilder(LbEndpoint prototype)
LbEndpoint.Builder	newBuilderForType()
protected LbEndpoint.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LbEndpoint	parseDelimitedFrom(InputStream input)
static LbEndpoint	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LbEndpoint	parseFrom(byte[] data)
static LbEndpoint	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LbEndpoint	parseFrom(ByteBuffer data)
static LbEndpoint	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LbEndpoint	parseFrom(com.google.protobuf.ByteString data)
static LbEndpoint	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LbEndpoint	parseFrom(com.google.protobuf.CodedInputStream input)
static LbEndpoint	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LbEndpoint	parseFrom(InputStream input)
static LbEndpoint	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LbEndpoint>	parser()
LbEndpoint.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

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

ENDPOINT_NAME_FIELD_NUMBER

public static final int ENDPOINT_NAME_FIELD_NUMBER

See Also:

Constant Field Values

HEALTH_STATUS_FIELD_NUMBER

public static final int HEALTH_STATUS_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

LOAD_BALANCING_WEIGHT_FIELD_NUMBER

public static final int LOAD_BALANCING_WEIGHT_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

getHostIdentifierCase

public LbEndpoint.HostIdentifierCase getHostIdentifierCase()

Specified by:

getHostIdentifierCase in interface LbEndpointOrBuilder

hasEndpoint

public boolean hasEndpoint()

.envoy.config.endpoint.v3.Endpoint endpoint = 1;

Specified by:

hasEndpoint in interface LbEndpointOrBuilder

getEndpoint

public Endpoint getEndpoint()

.envoy.config.endpoint.v3.Endpoint endpoint = 1;

Specified by:

getEndpoint in interface LbEndpointOrBuilder

getEndpointOrBuilder

public EndpointOrBuilder getEndpointOrBuilder()

.envoy.config.endpoint.v3.Endpoint endpoint = 1;

Specified by:

getEndpointOrBuilder in interface LbEndpointOrBuilder

getEndpointName

public String getEndpointName()

 [#not-implemented-hide:]
 

string endpoint_name = 5;

Specified by:

getEndpointName in interface LbEndpointOrBuilder

getEndpointNameBytes

public com.google.protobuf.ByteString getEndpointNameBytes()

 [#not-implemented-hide:]
 

string endpoint_name = 5;

Specified by:

getEndpointNameBytes in interface LbEndpointOrBuilder

getHealthStatusValue

public int getHealthStatusValue()

 Optional health status when known and supplied by EDS server.
 

.envoy.config.core.v3.HealthStatus health_status = 2;

Specified by:

getHealthStatusValue in interface LbEndpointOrBuilder

getHealthStatus

public HealthStatus getHealthStatus()

 Optional health status when known and supplied by EDS server.
 

.envoy.config.core.v3.HealthStatus health_status = 2;

Specified by:

getHealthStatus in interface LbEndpointOrBuilder

hasMetadata

public boolean hasMetadata()

 The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
 

.envoy.config.core.v3.Metadata metadata = 3;

Specified by:

hasMetadata in interface LbEndpointOrBuilder

getMetadata

public Metadata getMetadata()

 The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
 

.envoy.config.core.v3.Metadata metadata = 3;

Specified by:

getMetadata in interface LbEndpointOrBuilder

getMetadataOrBuilder

public MetadataOrBuilder getMetadataOrBuilder()

 The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
 

.envoy.config.core.v3.Metadata metadata = 3;

Specified by:

getMetadataOrBuilder in interface LbEndpointOrBuilder

hasLoadBalancingWeight

public boolean hasLoadBalancingWeight()

 The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
 

.google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }

Specified by:

hasLoadBalancingWeight in interface LbEndpointOrBuilder

getLoadBalancingWeight

public com.google.protobuf.UInt32Value getLoadBalancingWeight()

 The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
 

.google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }

Specified by:

getLoadBalancingWeight in interface LbEndpointOrBuilder

getLoadBalancingWeightOrBuilder

public com.google.protobuf.UInt32ValueOrBuilder getLoadBalancingWeightOrBuilder()

 The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
 

.google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }

Specified by:

getLoadBalancingWeightOrBuilder in interface LbEndpointOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LbEndpoint parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static LbEndpoint parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public LbEndpoint.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LbEndpoint.Builder newBuilder()

newBuilder

public static LbEndpoint.Builder newBuilder(LbEndpoint prototype)

toBuilder

public LbEndpoint.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LbEndpoint getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder