Class LocalityLbEndpoints

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityLbEndpointsOrBuilder, java.io.Serializable

    public final class LocalityLbEndpoints
    extends com.google.protobuf.GeneratedMessage
    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: 10]
     
    Protobuf type envoy.config.endpoint.v3.LocalityLbEndpoints
    See Also:
    Serialized Form
    • Field Detail

      • bitField0_

        private int bitField0_
      • lbConfigCase_

        private int lbConfigCase_
      • lbConfig_

        private java.lang.Object lbConfig_
      • LB_ENDPOINTS_FIELD_NUMBER

        public static final int LB_ENDPOINTS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • lbEndpoints_

        private java.util.List<LbEndpoint> lbEndpoints_
      • 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
      • loadBalancingWeight_

        private com.google.protobuf.UInt32Value loadBalancingWeight_
      • priority_

        private int priority_
      • proximity_

        private com.google.protobuf.UInt32Value proximity_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
    • Constructor Detail

      • LocalityLbEndpoints

        private LocalityLbEndpoints​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • LocalityLbEndpoints

        private LocalityLbEndpoints()
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • 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.
      • hasMetadata

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

        public Metadata getMetadata()
         Metadata to provide additional information about the locality endpoints in aggregate.
         
        .envoy.config.core.v3.Metadata metadata = 9;
        Specified by:
        getMetadata in interface LocalityLbEndpointsOrBuilder
        Returns:
        The metadata.
      • getLbEndpointsList

        public java.util.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 java.util.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 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) = { ... }
        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.GeneratedMessage
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

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

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static LocalityLbEndpoints parseFrom​(java.nio.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​(java.io.InputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static LocalityLbEndpoints parseFrom​(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static LocalityLbEndpoints parseDelimitedFrom​(java.io.InputStream input)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static LocalityLbEndpoints parseDelimitedFrom​(java.io.InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static LocalityLbEndpoints parseFrom​(com.google.protobuf.CodedInputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static LocalityLbEndpoints parseFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Throws:
        java.io.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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • 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.GeneratedMessage
      • getDefaultInstanceForType

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