Package io.envoyproxy.envoy.config.core.v3

Class Locality

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.core.v3.Locality
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityOrBuilder, Serializable
public final class Locality extends com.google.protobuf.GeneratedMessage implements LocalityOrBuilder
 Identifies location of where either Envoy runs or where upstream hosts run.
Protobuf type envoy.config.core.v3.Locality
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Locality.Builder
    Identifies location of where either Envoy runs or where upstream hosts run.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final Locality
    DEFAULT_INSTANCE
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<Locality>
    PARSER
     
    private Object
    region_
     
    static final int
    REGION_FIELD_NUMBER
     
    private static final long
    serialVersionUID
     
    static final int
    SUB_ZONE_FIELD_NUMBER
     
    private Object
    subZone_
     
    private Object
    zone_
     
    static final int
    ZONE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Locality()
     
    private
    Locality(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Locality
    getDefaultInstance()
     
    Locality
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Locality>
    getParserForType()
     
    String
    getRegion()
    Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
    com.google.protobuf.ByteString
    getRegionBytes()
    Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
    int
    getSerializedSize()
     
    String
    getSubZone()
    When used for locality of upstream hosts, this field further splits zone into smaller chunks of sub-zones so they can be load balanced independently.
    com.google.protobuf.ByteString
    getSubZoneBytes()
    When used for locality of upstream hosts, this field further splits zone into smaller chunks of sub-zones so they can be load balanced independently.
    String
    getZone()
    Defines the local service zone where Envoy is running.
    com.google.protobuf.ByteString
    getZoneBytes()
    Defines the local service zone where Envoy is running.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Locality.Builder
    newBuilder()
     
    static Locality.Builder
    newBuilder(Locality prototype)
     
    Locality.Builder
    newBuilderForType()
     
    protected Locality.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Locality
    parseDelimitedFrom(InputStream input)
     
    static Locality
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Locality
    parseFrom(byte[] data)
     
    static Locality
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Locality
    parseFrom(com.google.protobuf.ByteString data)
     
    static Locality
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Locality
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Locality
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Locality
    parseFrom(InputStream input)
     
    static Locality
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Locality
    parseFrom(ByteBuffer data)
     
    static Locality
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Locality>
    parser()
     
    Locality.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • REGION_FIELD_NUMBER

      public static final int REGION_FIELD_NUMBER
      See Also:

    • region_

      private volatile Object region_

    • ZONE_FIELD_NUMBER

      public static final int ZONE_FIELD_NUMBER
      See Also:

    • zone_

      private volatile Object zone_

    • SUB_ZONE_FIELD_NUMBER

      public static final int SUB_ZONE_FIELD_NUMBER
      See Also:

    • subZone_

      private volatile Object subZone_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final Locality DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<Locality> PARSER

  • Constructor Details

    • Locality

      private Locality(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • Locality

      private Locality()

  • Method Details

    • 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

    • getRegion

      public String getRegion()
       Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
      string region = 1;
      Specified by:
      getRegion in interface LocalityOrBuilder
      Returns:
      The region.

    • getRegionBytes

      public com.google.protobuf.ByteString getRegionBytes()
       Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
      string region = 1;
      Specified by:
      getRegionBytes in interface LocalityOrBuilder
      Returns:
      The bytes for region.

    • getZone

      public String getZone()
       Defines the local service zone where Envoy is running. Though optional, it
 should be set if discovery service routing is used and the discovery
 service exposes :ref:`zone data <envoy_v3_api_field_config.endpoint.v3.LocalityLbEndpoints.locality>`,
 either in this message or via :option:`--service-zone`. The meaning of zone
 is context dependent, e.g. `Availability Zone (AZ)
 <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html>`_
 on AWS, `Zone <https://cloud.google.com/compute/docs/regions-zones/>`_ on
 GCP, etc.
      string zone = 2;
      Specified by:
      getZone in interface LocalityOrBuilder
      Returns:
      The zone.

    • getZoneBytes

      public com.google.protobuf.ByteString getZoneBytes()
       Defines the local service zone where Envoy is running. Though optional, it
 should be set if discovery service routing is used and the discovery
 service exposes :ref:`zone data <envoy_v3_api_field_config.endpoint.v3.LocalityLbEndpoints.locality>`,
 either in this message or via :option:`--service-zone`. The meaning of zone
 is context dependent, e.g. `Availability Zone (AZ)
 <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html>`_
 on AWS, `Zone <https://cloud.google.com/compute/docs/regions-zones/>`_ on
 GCP, etc.
      string zone = 2;
      Specified by:
      getZoneBytes in interface LocalityOrBuilder
      Returns:
      The bytes for zone.

    • getSubZone

      public String getSubZone()
       When used for locality of upstream hosts, this field further splits zone
 into smaller chunks of sub-zones so they can be load balanced
 independently.
      string sub_zone = 3;
      Specified by:
      getSubZone in interface LocalityOrBuilder
      Returns:
      The subZone.

    • getSubZoneBytes

      public com.google.protobuf.ByteString getSubZoneBytes()
       When used for locality of upstream hosts, this field further splits zone
 into smaller chunks of sub-zones so they can be load balanced
 independently.
      string sub_zone = 3;
      Specified by:
      getSubZoneBytes in interface LocalityOrBuilder
      Returns:
      The bytes for subZone.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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 Locality parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Locality parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Locality.Builder newBuilder()

    • newBuilder

      public static Locality.Builder newBuilder(Locality prototype)

    • toBuilder

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

    • newBuilderForType

      protected Locality.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Locality getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Locality> 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 Locality getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder