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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Endpoint getEndpoint()
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;
      java.lang.String getEndpointName()
      [#not-implemented-hide:]
      com.google.protobuf.ByteString getEndpointNameBytes()
      [#not-implemented-hide:]
      EndpointOrBuilder getEndpointOrBuilder()
      .envoy.config.endpoint.v3.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.config.endpoint.v3.Endpoint endpoint = 1;
      boolean hasEndpointName()
      [#not-implemented-hide:]
      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.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

      • hasEndpoint

        boolean hasEndpoint()
        .envoy.config.endpoint.v3.Endpoint endpoint = 1;
        Returns:
        Whether the endpoint field is set.
      • getEndpoint

        Endpoint getEndpoint()
        .envoy.config.endpoint.v3.Endpoint endpoint = 1;
        Returns:
        The endpoint.
      • getEndpointOrBuilder

        EndpointOrBuilder getEndpointOrBuilder()
        .envoy.config.endpoint.v3.Endpoint endpoint = 1;
      • hasEndpointName

        boolean hasEndpointName()
         [#not-implemented-hide:]
         
        string endpoint_name = 5;
        Returns:
        Whether the endpointName field is set.
      • getEndpointName

        java.lang.String getEndpointName()
         [#not-implemented-hide:]
         
        string endpoint_name = 5;
        Returns:
        The endpointName.
      • getEndpointNameBytes

        com.google.protobuf.ByteString getEndpointNameBytes()
         [#not-implemented-hide:]
         
        string endpoint_name = 5;
        Returns:
        The bytes for endpointName.
      • getHealthStatusValue

        int getHealthStatusValue()
         Optional health status when known and supplied by EDS server.
         
        .envoy.config.core.v3.HealthStatus health_status = 2;
        Returns:
        The enum numeric value on the wire for healthStatus.
      • getHealthStatus

        HealthStatus getHealthStatus()
         Optional health status when known and supplied by EDS server.
         
        .envoy.config.core.v3.HealthStatus health_status = 2;
        Returns:
        The healthStatus.
      • 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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
         to subset the endpoints considered in cluster load balancing.
         
        .envoy.config.core.v3.Metadata metadata = 3;
        Returns:
        Whether the metadata field is set.
      • 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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
         to subset the endpoints considered in cluster load balancing.
         
        .envoy.config.core.v3.Metadata metadata = 3;
        Returns:
        The metadata.
      • 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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
         to subset the endpoints considered in cluster load balancing.
         
        .envoy.config.core.v3.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, will be treated as 1. 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) = { ... }
        Returns:
        Whether the loadBalancingWeight field is set.
      • 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, will be treated as 1. 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) = { ... }
        Returns:
        The loadBalancingWeight.
      • 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, will be treated as 1. 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) = { ... }