envoy.api.v2.endpoint

Interface EndpointOuterClass.LocalityLbEndpointsOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

EndpointOuterClass.LocalityLbEndpoints, EndpointOuterClass.LocalityLbEndpoints.Builder

Enclosing class:

EndpointOuterClass

public static interface EndpointOuterClass.LocalityLbEndpointsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
EndpointOuterClass.LbEndpoint	getLbEndpoints(int index) The group of endpoints belonging to the locality specified.
int	getLbEndpointsCount() The group of endpoints belonging to the locality specified.
List<EndpointOuterClass.LbEndpoint>	getLbEndpointsList() The group of endpoints belonging to the locality specified.
EndpointOuterClass.LbEndpointOrBuilder	getLbEndpointsOrBuilder(int index) The group of endpoints belonging to the locality specified.
List<? extends EndpointOuterClass.LbEndpointOrBuilder>	getLbEndpointsOrBuilderList() The group of endpoints belonging to the locality specified.
com.google.protobuf.UInt32Value	getLoadBalancingWeight() Optional: Per priority/region/zone/sub_zone weight - range 1-128.
com.google.protobuf.UInt32ValueOrBuilder	getLoadBalancingWeightOrBuilder() Optional: Per priority/region/zone/sub_zone weight - range 1-128.
Base.Locality	getLocality() Identifies location of where the upstream hosts run.
Base.LocalityOrBuilder	getLocalityOrBuilder() Identifies location of where the upstream hosts run.
int	getPriority() Optional: the priority for this LocalityLbEndpoints.
boolean	hasLoadBalancingWeight() Optional: Per priority/region/zone/sub_zone weight - range 1-128.
boolean	hasLocality() Identifies location of where the upstream hosts run.

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

hasLocality

boolean hasLocality()

 Identifies location of where the upstream hosts run.
 

.envoy.api.v2.core.Locality locality = 1;

getLocality

Base.Locality getLocality()

 Identifies location of where the upstream hosts run.
 

.envoy.api.v2.core.Locality locality = 1;

getLocalityOrBuilder

Base.LocalityOrBuilder getLocalityOrBuilder()

 Identifies location of where the upstream hosts run.
 

.envoy.api.v2.core.Locality locality = 1;

getLbEndpointsList

List<EndpointOuterClass.LbEndpoint> getLbEndpointsList()

 The group of endpoints belonging to the locality specified.
 

repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2 [(.gogoproto.nullable) = false];

getLbEndpoints

EndpointOuterClass.LbEndpoint getLbEndpoints(int index)

 The group of endpoints belonging to the locality specified.
 

repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2 [(.gogoproto.nullable) = false];

getLbEndpointsCount

int getLbEndpointsCount()

 The group of endpoints belonging to the locality specified.
 

repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2 [(.gogoproto.nullable) = false];

getLbEndpointsOrBuilderList

List<? extends EndpointOuterClass.LbEndpointOrBuilder> getLbEndpointsOrBuilderList()

 The group of endpoints belonging to the locality specified.
 

repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2 [(.gogoproto.nullable) = false];

getLbEndpointsOrBuilder

EndpointOuterClass.LbEndpointOrBuilder getLbEndpointsOrBuilder(int index)

 The group of endpoints belonging to the locality specified.
 

repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2 [(.gogoproto.nullable) = false];

hasLoadBalancingWeight

boolean hasLoadBalancingWeight()

 Optional: Per priority/region/zone/sub_zone weight - range 1-128. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality.
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specificed when locality weighted load balancing is enabled, the cluster is
 assumed to have a weight of 1.
 .. attention::
   The limit of 128 is somewhat arbitrary, but is applied due to performance
   concerns with the current implementation and can be removed when
   `this issue <https://github.com/envoyproxy/envoy/issues/1285>`_ is fixed.
 

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

getLoadBalancingWeight

com.google.protobuf.UInt32Value getLoadBalancingWeight()

 Optional: Per priority/region/zone/sub_zone weight - range 1-128. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality.
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specificed when locality weighted load balancing is enabled, the cluster is
 assumed to have a weight of 1.
 .. attention::
   The limit of 128 is somewhat arbitrary, but is applied due to performance
   concerns with the current implementation and can be removed when
   `this issue <https://github.com/envoyproxy/envoy/issues/1285>`_ is fixed.
 

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

getLoadBalancingWeightOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getLoadBalancingWeightOrBuilder()

 Optional: Per priority/region/zone/sub_zone weight - range 1-128. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality.
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specificed when locality weighted load balancing is enabled, the cluster is
 assumed to have a weight of 1.
 .. attention::
   The limit of 128 is somewhat arbitrary, but is applied due to performance
   concerns with the current implementation and can be removed when
   `this issue <https://github.com/envoyproxy/envoy/issues/1285>`_ is fixed.
 

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

getPriority

int getPriority()

 Optional: the priority for this LocalityLbEndpoints. If unspecified this will
 default to the highest priority (0).
 Under usual circumstances, Envoy will only select endpoints for the highest
 priority (0). In the event all endpoints for a particular priority are
 unavailable/unhealthy, Envoy will fail over to selecting endpoints for the
 next highest priority group.
 Priorities should range from 0 (highest) to N (lowest) without skipping.
 

uint32 priority = 5 [(.validate.rules) = { ... }