io.envoyproxy.envoy.config.endpoint.v3.LocalityLbEndpointsOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
There is a newer version: 1.0.47
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/config/endpoint/v3/endpoint_components.proto

package io.envoyproxy.envoy.config.endpoint.v3;

public interface LocalityLbEndpointsOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.config.endpoint.v3.LocalityLbEndpoints)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Identifies location of where the upstream hosts run.
   * 
   *
   * .envoy.config.core.v3.Locality locality = 1;
   */
  boolean hasLocality();
  /**
   *    * Identifies location of where the upstream hosts run.
   * 
   *
   * .envoy.config.core.v3.Locality locality = 1;
   */
  io.envoyproxy.envoy.config.core.v3.Locality getLocality();
  /**
   *    * Identifies location of where the upstream hosts run.
   * 
   *
   * .envoy.config.core.v3.Locality locality = 1;
   */
  io.envoyproxy.envoy.config.core.v3.LocalityOrBuilder getLocalityOrBuilder();

  /**
   *    * The group of endpoints belonging to the locality specified.
   * 
   *
   * repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
   */
  java.util.List 
      getLbEndpointsList();
  /**
   *    * The group of endpoints belonging to the locality specified.
   * 
   *
   * repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
   */
  io.envoyproxy.envoy.config.endpoint.v3.LbEndpoint getLbEndpoints(int index);
  /**
   *    * The group of endpoints belonging to the locality specified.
   * 
   *
   * repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
   */
  int getLbEndpointsCount();
  /**
   *    * The group of endpoints belonging to the locality specified.
   * 
   *
   * repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
   */
  java.util.List 
      getLbEndpointsOrBuilderList();
  /**
   *    * The group of endpoints belonging to the locality specified.
   * 
   *
   * repeated .envoy.config.endpoint.v3.LbEndpoint lb_endpoints = 2;
   */
  io.envoyproxy.envoy.config.endpoint.v3.LbEndpointOrBuilder getLbEndpointsOrBuilder(
      int index);

  /**
   *    * 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.
   * 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) = { ... }
   */
  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.
   * 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) = { ... }
   */
  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.
   * 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) = { ... }
   */
  com.google.protobuf.UInt32ValueOrBuilder getLoadBalancingWeightOrBuilder();

  /**
   *    * 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) = { ... }
   */
  int getPriority();

  /**
   *    * 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;
   */
  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;
   */
  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;
   */
  com.google.protobuf.UInt32ValueOrBuilder getProximityOrBuilder();
}