io.envoyproxy.envoy.api.v2.endpoint

Interface LbEndpointOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LbEndpoint, LbEndpoint.Builder

public interface LbEndpointOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Endpoint	getEndpoint() .envoy.api.v2.endpoint.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.api.v2.endpoint.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.
boolean	hasEndpoint() .envoy.api.v2.endpoint.Endpoint endpoint = 1;
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasEndpoint

boolean hasEndpoint()

.envoy.api.v2.endpoint.Endpoint endpoint = 1;

getEndpoint

Endpoint getEndpoint()

.envoy.api.v2.endpoint.Endpoint endpoint = 1;

getEndpointOrBuilder

EndpointOrBuilder getEndpointOrBuilder()

.envoy.api.v2.endpoint.Endpoint endpoint = 1;

getEndpointName

String getEndpointName()

 [#not-implemented-hide:]
 

string endpoint_name = 5;

getEndpointNameBytes

com.google.protobuf.ByteString getEndpointNameBytes()

 [#not-implemented-hide:]
 

string endpoint_name = 5;

getHealthStatusValue

int getHealthStatusValue()

 Optional health status when known and supplied by EDS server.
 

.envoy.api.v2.core.HealthStatus health_status = 2;

getHealthStatus

HealthStatus getHealthStatus()

 Optional health status when known and supplied by EDS server.
 

.envoy.api.v2.core.HealthStatus health_status = 2;

hasMetadata

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_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
 

.envoy.api.v2.core.Metadata metadata = 3;

getMetadata

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_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
 

.envoy.api.v2.core.Metadata metadata = 3;

getMetadataOrBuilder

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_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
 

.envoy.api.v2.core.Metadata metadata = 3;

hasLoadBalancingWeight

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) = { ... }

getLoadBalancingWeight

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) = { ... }

getLoadBalancingWeightOrBuilder

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) = { ... }

getHostIdentifierCase

LbEndpoint.HostIdentifierCase getHostIdentifierCase()