io.envoyproxy.envoy.api.v2.endpoint.LbEndpointOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of envoy-api Show documentation
envoy-api
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/api/v2/endpoint/endpoint_components.proto

package io.envoyproxy.envoy.api.v2.endpoint;

public interface LbEndpointOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.api.v2.endpoint.LbEndpoint)
    com.google.protobuf.MessageOrBuilder {

  /**
   * .envoy.api.v2.endpoint.Endpoint endpoint = 1;
   * @return Whether the endpoint field is set.
   */
  boolean hasEndpoint();
  /**
   * .envoy.api.v2.endpoint.Endpoint endpoint = 1;
   * @return The endpoint.
   */
  io.envoyproxy.envoy.api.v2.endpoint.Endpoint getEndpoint();
  /**
   * .envoy.api.v2.endpoint.Endpoint endpoint = 1;
   */
  io.envoyproxy.envoy.api.v2.endpoint.EndpointOrBuilder getEndpointOrBuilder();

  /**
   *    * [#not-implemented-hide:]
   * 
   *
   * string endpoint_name = 5;
   * @return Whether the endpointName field is set.
   */
  boolean hasEndpointName();
  /**
   *    * [#not-implemented-hide:]
   * 
   *
   * string endpoint_name = 5;
   * @return The endpointName.
   */
  java.lang.String getEndpointName();
  /**
   *    * [#not-implemented-hide:]
   * 
   *
   * string endpoint_name = 5;
   * @return The bytes for endpointName.
   */
  com.google.protobuf.ByteString
      getEndpointNameBytes();

  /**
   *    * Optional health status when known and supplied by EDS server.
   * 
   *
   * .envoy.api.v2.core.HealthStatus health_status = 2;
   * @return The enum numeric value on the wire for healthStatus.
   */
  int getHealthStatusValue();
  /**
   *    * Optional health status when known and supplied by EDS server.
   * 
   *
   * .envoy.api.v2.core.HealthStatus health_status = 2;
   * @return The healthStatus.
   */
  io.envoyproxy.envoy.api.v2.core.HealthStatus getHealthStatus();

  /**
   *    * 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;
   * @return Whether the metadata field is set.
   */
  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;
   * @return The metadata.
   */
  io.envoyproxy.envoy.api.v2.core.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;
   */
  io.envoyproxy.envoy.api.v2.core.MetadataOrBuilder getMetadataOrBuilder();

  /**
   *    * 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) = { ... }
   * @return Whether the loadBalancingWeight field is set.
   */
  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) = { ... }
   * @return The loadBalancingWeight.
   */
  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) = { ... }
   */
  com.google.protobuf.UInt32ValueOrBuilder getLoadBalancingWeightOrBuilder();

  public io.envoyproxy.envoy.api.v2.endpoint.LbEndpoint.HostIdentifierCase getHostIdentifierCase();
}