Package io.envoyproxy.envoy.api.v2.endpoint

Class LocalityLbEndpoints

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.endpoint.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 this is
 generally only done if the different groups need to have different load
 balancing weights or different priorities.
 [#next-free-field: 7]
Protobuf type envoy.api.v2.endpoint.LocalityLbEndpoints
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    LocalityLbEndpoints.Builder
    A group of endpoints belonging to a Locality.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LB_ENDPOINTS_FIELD_NUMBER
     
    static final int
    LOAD_BALANCING_WEIGHT_FIELD_NUMBER
     
    static final int
    LOCALITY_FIELD_NUMBER
     
    static final int
    PRIORITY_FIELD_NUMBER
     
    static final int
    PROXIMITY_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static LocalityLbEndpoints
    getDefaultInstance()
     
    LocalityLbEndpoints
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    LbEndpoint
    getLbEndpoints(int index)
    The group of endpoints belonging to the locality specified.
    int
    getLbEndpointsCount()
    The group of endpoints belonging to the locality specified.
    List<LbEndpoint>
    getLbEndpointsList()
    The group of endpoints belonging to the locality specified.
    LbEndpointOrBuilder
    getLbEndpointsOrBuilder(int index)
    The group of endpoints belonging to the locality specified.
    List<? extends LbEndpointOrBuilder>
    getLbEndpointsOrBuilderList()
    The group of endpoints belonging to the locality specified.
    com.google.protobuf.UInt32Value
    getLoadBalancingWeight()
    Optional: Per priority/region/zone/sub_zone weight; at least 1.
    com.google.protobuf.UInt32ValueOrBuilder
    getLoadBalancingWeightOrBuilder()
    Optional: Per priority/region/zone/sub_zone weight; at least 1.
    Locality
    getLocality()
    Identifies location of where the upstream hosts run.
    LocalityOrBuilder
    getLocalityOrBuilder()
    Identifies location of where the upstream hosts run.
    com.google.protobuf.Parser<LocalityLbEndpoints>
    getParserForType()
     
    int
    getPriority()
    Optional: the priority for this LocalityLbEndpoints.
    com.google.protobuf.UInt32Value
    getProximity()
    Optional: Per locality proximity value which indicates how close this locality is from the source locality.
    com.google.protobuf.UInt32ValueOrBuilder
    getProximityOrBuilder()
    Optional: Per locality proximity value which indicates how close this locality is from the source locality.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasLoadBalancingWeight()
    Optional: Per priority/region/zone/sub_zone weight; at least 1.
    boolean
    hasLocality()
    Identifies location of where the upstream hosts run.
    boolean
    hasProximity()
    Optional: Per locality proximity value which indicates how close this locality is from the source locality.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static LocalityLbEndpoints.Builder
    newBuilder()
     
    static LocalityLbEndpoints.Builder
    newBuilder(LocalityLbEndpoints prototype)
     
    LocalityLbEndpoints.Builder
    newBuilderForType()
     
    protected LocalityLbEndpoints.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static LocalityLbEndpoints
    parseDelimitedFrom(InputStream input)
     
    static LocalityLbEndpoints
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalityLbEndpoints
    parseFrom(byte[] data)
     
    static LocalityLbEndpoints
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalityLbEndpoints
    parseFrom(com.google.protobuf.ByteString data)
     
    static LocalityLbEndpoints
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalityLbEndpoints
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static LocalityLbEndpoints
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalityLbEndpoints
    parseFrom(InputStream input)
     
    static LocalityLbEndpoints
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalityLbEndpoints
    parseFrom(ByteBuffer data)
     
    static LocalityLbEndpoints
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<LocalityLbEndpoints>
    parser()
     
    LocalityLbEndpoints.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • LOCALITY_FIELD_NUMBER

      public static final int LOCALITY_FIELD_NUMBER
      See Also:

    • LB_ENDPOINTS_FIELD_NUMBER

      public static final int LB_ENDPOINTS_FIELD_NUMBER
      See Also:

    • LOAD_BALANCING_WEIGHT_FIELD_NUMBER

      public static final int LOAD_BALANCING_WEIGHT_FIELD_NUMBER
      See Also:

    • PRIORITY_FIELD_NUMBER

      public static final int PRIORITY_FIELD_NUMBER
      See Also:

    • PROXIMITY_FIELD_NUMBER

      public static final int PROXIMITY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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.api.v2.core.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.api.v2.core.Locality locality = 1;
      Specified by:
      getLocality in interface LocalityLbEndpointsOrBuilder
      Returns:
      The locality.

    • getLocalityOrBuilder

      public LocalityOrBuilder getLocalityOrBuilder()
       Identifies location of where the upstream hosts run.
      .envoy.api.v2.core.Locality locality = 1;
      Specified by:
      getLocalityOrBuilder in interface LocalityLbEndpointsOrBuilder

    • getLbEndpointsList

      public List<LbEndpoint> getLbEndpointsList()
       The group of endpoints belonging to the locality specified.
      repeated .envoy.api.v2.endpoint.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.
      repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;
      Specified by:
      getLbEndpointsOrBuilderList in interface LocalityLbEndpointsOrBuilder

    • getLbEndpointsCount

      public int getLbEndpointsCount()
       The group of endpoints belonging to the locality specified.
      repeated .envoy.api.v2.endpoint.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.
      repeated .envoy.api.v2.endpoint.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.
      repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;
      Specified by:
      getLbEndpointsOrBuilder in interface LocalityLbEndpointsOrBuilder

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static LocalityLbEndpoints parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static LocalityLbEndpoints parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static LocalityLbEndpoints.Builder newBuilder()

    • newBuilder

      public static LocalityLbEndpoints.Builder newBuilder(LocalityLbEndpoints prototype)

    • 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

    • getDefaultInstance

      public static LocalityLbEndpoints getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<LocalityLbEndpoints> parser()

    • 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