Package io.envoyproxy.envoy.config.endpoint.v3

Class LocalityLbEndpoints

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityLbEndpointsOrBuilder, Serializable
    public final class LocalityLbEndpoints
extends com.google.protobuf.GeneratedMessageV3
implements LocalityLbEndpointsOrBuilder
     A group of endpoints belonging to a Locality.
 One can have multiple LocalityLbEndpoints for a locality, but only if
 they have different priorities.
 [#next-free-field: 9]
    Protobuf type envoy.config.endpoint.v3.LocalityLbEndpoints
    See Also:
    Serialized Form

    • Field Detail

      • LB_ENDPOINTS_FIELD_NUMBER

        public static final int LB_ENDPOINTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOAD_BALANCER_ENDPOINTS_FIELD_NUMBER

        public static final int LOAD_BALANCER_ENDPOINTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LEDS_CLUSTER_LOCALITY_CONFIG_FIELD_NUMBER

        public static final int LEDS_CLUSTER_LOCALITY_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOAD_BALANCING_WEIGHT_FIELD_NUMBER

        public static final int LOAD_BALANCING_WEIGHT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasLocality

        public boolean hasLocality()
         Identifies location of where the upstream hosts run.
        .envoy.config.core.v3.Locality locality = 1;
        Specified by:
        hasLocality in interface LocalityLbEndpointsOrBuilder
        Returns:
        Whether the locality field is set.

      • getLocality

        public Locality getLocality()
         Identifies location of where the upstream hosts run.
        .envoy.config.core.v3.Locality locality = 1;
        Specified by:
        getLocality in interface LocalityLbEndpointsOrBuilder
        Returns:
        The locality.

      • getLbEndpointsList

        public 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;
        Specified by:
        getLbEndpointsList in interface LocalityLbEndpointsOrBuilder

      • getLbEndpointsOrBuilderList

        public 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;
        Specified by:
        getLbEndpointsOrBuilderList in interface LocalityLbEndpointsOrBuilder

      • getLbEndpointsCount

        public 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;
        Specified by:
        getLbEndpointsCount in interface LocalityLbEndpointsOrBuilder

      • getLbEndpoints

        public 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;
        Specified by:
        getLbEndpoints in interface LocalityLbEndpointsOrBuilder

      • getLbEndpointsOrBuilder

        public 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;
        Specified by:
        getLbEndpointsOrBuilder in interface LocalityLbEndpointsOrBuilder

      • hasLoadBalancerEndpoints

        public 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;
        Specified by:
        hasLoadBalancerEndpoints in interface LocalityLbEndpointsOrBuilder
        Returns:
        Whether the loadBalancerEndpoints field is set.

      • getLoadBalancerEndpoints

        public 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;
        Specified by:
        getLoadBalancerEndpoints in interface LocalityLbEndpointsOrBuilder
        Returns:
        The loadBalancerEndpoints.

      • hasLedsClusterLocalityConfig

        public boolean hasLedsClusterLocalityConfig()
         LEDS Configuration for the current locality.
        .envoy.config.endpoint.v3.LedsClusterLocalityConfig leds_cluster_locality_config = 8;
        Specified by:
        hasLedsClusterLocalityConfig in interface LocalityLbEndpointsOrBuilder
        Returns:
        Whether the ledsClusterLocalityConfig field is set.

      • hasLoadBalancingWeight

        public 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) = { ... }
        Specified by:
        hasLoadBalancingWeight in interface LocalityLbEndpointsOrBuilder
        Returns:
        Whether the loadBalancingWeight field is set.

      • getLoadBalancingWeight

        public 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) = { ... }
        Specified by:
        getLoadBalancingWeight in interface LocalityLbEndpointsOrBuilder
        Returns:
        The loadBalancingWeight.

      • getLoadBalancingWeightOrBuilder

        public 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) = { ... }
        Specified by:
        getLoadBalancingWeightOrBuilder in interface LocalityLbEndpointsOrBuilder

      • getPriority

        public 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) = { ... }
        Specified by:
        getPriority in interface LocalityLbEndpointsOrBuilder
        Returns:
        The priority.

      • hasProximity

        public 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;
        Specified by:
        hasProximity in interface LocalityLbEndpointsOrBuilder
        Returns:
        Whether the proximity field is set.

      • getProximity

        public 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;
        Specified by:
        getProximity in interface LocalityLbEndpointsOrBuilder
        Returns:
        The proximity.

      • getProximityOrBuilder

        public 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;
        Specified by:
        getProximityOrBuilder in interface LocalityLbEndpointsOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static LocalityLbEndpoints parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalityLbEndpoints parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalityLbEndpoints parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalityLbEndpoints parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalityLbEndpoints parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalityLbEndpoints parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalityLbEndpoints parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public LocalityLbEndpoints.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public LocalityLbEndpoints.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected LocalityLbEndpoints.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<LocalityLbEndpoints> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public LocalityLbEndpoints getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder