Interface LocalityLbEndpointsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
LocalityLbEndpoints, LocalityLbEndpoints.Builder

public interface LocalityLbEndpointsOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • hasLocality

      boolean hasLocality()
       Identifies location of where the upstream hosts run.
       
      .envoy.config.core.v3.Locality locality = 1;
      Returns:
      Whether the locality field is set.
    • getLocality

      Locality getLocality()
       Identifies location of where the upstream hosts run.
       
      .envoy.config.core.v3.Locality locality = 1;
      Returns:
      The locality.
    • getLocalityOrBuilder

      LocalityOrBuilder getLocalityOrBuilder()
       Identifies location of where the upstream hosts run.
       
      .envoy.config.core.v3.Locality locality = 1;
    • hasMetadata

      boolean hasMetadata()
       Metadata to provide additional information about the locality endpoints in aggregate.
       
      .envoy.config.core.v3.Metadata metadata = 9;
      Returns:
      Whether the metadata field is set.
    • getMetadata

      Metadata getMetadata()
       Metadata to provide additional information about the locality endpoints in aggregate.
       
      .envoy.config.core.v3.Metadata metadata = 9;
      Returns:
      The metadata.
    • getMetadataOrBuilder

      MetadataOrBuilder getMetadataOrBuilder()
       Metadata to provide additional information about the locality endpoints in aggregate.
       
      .envoy.config.core.v3.Metadata metadata = 9;
    • getLbEndpointsList

      List<LbEndpoint> getLbEndpointsList()
       The group of endpoints belonging to the locality specified.
       [#comment:TODO(adisuissa): Once LEDS is implemented this field needs to be
       deprecated and replaced by ``load_balancer_endpoints``.]
       
      repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
    • getLbEndpoints

      LbEndpoint getLbEndpoints(int index)
       The group of endpoints belonging to the locality specified.
       [#comment:TODO(adisuissa): Once LEDS is implemented this field needs to be
       deprecated and replaced by ``load_balancer_endpoints``.]
       
      repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
    • getLbEndpointsCount

      int getLbEndpointsCount()
       The group of endpoints belonging to the locality specified.
       [#comment:TODO(adisuissa): Once LEDS is implemented this field needs to be
       deprecated and replaced by ``load_balancer_endpoints``.]
       
      repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
    • getLbEndpointsOrBuilderList

      List<? extends LbEndpointOrBuilder> getLbEndpointsOrBuilderList()
       The group of endpoints belonging to the locality specified.
       [#comment:TODO(adisuissa): Once LEDS is implemented this field needs to be
       deprecated and replaced by ``load_balancer_endpoints``.]
       
      repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
    • getLbEndpointsOrBuilder

      LbEndpointOrBuilder getLbEndpointsOrBuilder(int index)
       The group of endpoints belonging to the locality specified.
       [#comment:TODO(adisuissa): Once LEDS is implemented this field needs to be
       deprecated and replaced by ``load_balancer_endpoints``.]
       
      repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
    • hasLoadBalancerEndpoints

      boolean hasLoadBalancerEndpoints()
       The group of endpoints belonging to the locality.
       [#comment:TODO(adisuissa): Once LEDS is implemented the ``lb_endpoints`` field
       needs to be deprecated.]
       
      .envoy.config.endpoint.v3.LocalityLbEndpoints.LbEndpointList load_balancer_endpoints = 7;
      Returns:
      Whether the loadBalancerEndpoints field is set.
    • getLoadBalancerEndpoints

      LocalityLbEndpoints.LbEndpointList getLoadBalancerEndpoints()
       The group of endpoints belonging to the locality.
       [#comment:TODO(adisuissa): Once LEDS is implemented the ``lb_endpoints`` field
       needs to be deprecated.]
       
      .envoy.config.endpoint.v3.LocalityLbEndpoints.LbEndpointList load_balancer_endpoints = 7;
      Returns:
      The loadBalancerEndpoints.
    • getLoadBalancerEndpointsOrBuilder

      LocalityLbEndpoints.LbEndpointListOrBuilder getLoadBalancerEndpointsOrBuilder()
       The group of endpoints belonging to the locality.
       [#comment:TODO(adisuissa): Once LEDS is implemented the ``lb_endpoints`` field
       needs to be deprecated.]
       
      .envoy.config.endpoint.v3.LocalityLbEndpoints.LbEndpointList load_balancer_endpoints = 7;
    • hasLedsClusterLocalityConfig

      boolean hasLedsClusterLocalityConfig()
       LEDS Configuration for the current locality.
       
      .envoy.config.endpoint.v3.LedsClusterLocalityConfig leds_cluster_locality_config = 8;
      Returns:
      Whether the ledsClusterLocalityConfig field is set.
    • getLedsClusterLocalityConfig

      LedsClusterLocalityConfig getLedsClusterLocalityConfig()
       LEDS Configuration for the current locality.
       
      .envoy.config.endpoint.v3.LedsClusterLocalityConfig leds_cluster_locality_config = 8;
      Returns:
      The ledsClusterLocalityConfig.
    • getLedsClusterLocalityConfigOrBuilder

      LedsClusterLocalityConfigOrBuilder getLedsClusterLocalityConfigOrBuilder()
       LEDS Configuration for the current locality.
       
      .envoy.config.endpoint.v3.LedsClusterLocalityConfig leds_cluster_locality_config = 8;
    • hasLoadBalancingWeight

      boolean hasLoadBalancingWeight()
       Optional: Per priority/region/zone/sub_zone weight; at least 1. 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. The sum of the weights of all localities at
       the same priority level must not exceed uint32_t maximal value (4294967295).
      
       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
       specified when locality weighted load balancing is enabled, the locality is
       assigned no load.
       
      .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }
      Returns:
      Whether the loadBalancingWeight field is set.
    • getLoadBalancingWeight

      com.google.protobuf.UInt32Value getLoadBalancingWeight()
       Optional: Per priority/region/zone/sub_zone weight; at least 1. 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. The sum of the weights of all localities at
       the same priority level must not exceed uint32_t maximal value (4294967295).
      
       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
       specified when locality weighted load balancing is enabled, the locality is
       assigned no load.
       
      .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }
      Returns:
      The loadBalancingWeight.
    • getLoadBalancingWeightOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getLoadBalancingWeightOrBuilder()
       Optional: Per priority/region/zone/sub_zone weight; at least 1. 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. The sum of the weights of all localities at
       the same priority level must not exceed uint32_t maximal value (4294967295).
      
       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
       specified when locality weighted load balancing is enabled, the locality is
       assigned no load.
       
      .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 that enough endpoints for a particular priority are
       unavailable/unhealthy, Envoy will fail over to selecting endpoints for the
       next highest priority group. Read more at :ref:`priority levels <arch_overview_load_balancing_priority_levels>`.
      
       Priorities should range from 0 (highest) to N (lowest) without skipping.
       
      uint32 priority = 5 [(.validate.rules) = { ... }
      Returns:
      The priority.
    • hasProximity

      boolean hasProximity()
       Optional: Per locality proximity value which indicates how close this
       locality is from the source locality. This value only provides ordering
       information (lower the value, closer it is to the source locality).
       This will be consumed by load balancing schemes that need proximity order
       to determine where to route the requests.
       [#not-implemented-hide:]
       
      .google.protobuf.UInt32Value proximity = 6;
      Returns:
      Whether the proximity field is set.
    • getProximity

      com.google.protobuf.UInt32Value getProximity()
       Optional: Per locality proximity value which indicates how close this
       locality is from the source locality. This value only provides ordering
       information (lower the value, closer it is to the source locality).
       This will be consumed by load balancing schemes that need proximity order
       to determine where to route the requests.
       [#not-implemented-hide:]
       
      .google.protobuf.UInt32Value proximity = 6;
      Returns:
      The proximity.
    • getProximityOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getProximityOrBuilder()
       Optional: Per locality proximity value which indicates how close this
       locality is from the source locality. This value only provides ordering
       information (lower the value, closer it is to the source locality).
       This will be consumed by load balancing schemes that need proximity order
       to determine where to route the requests.
       [#not-implemented-hide:]
       
      .google.protobuf.UInt32Value proximity = 6;
    • getLbConfigCase