Interface LocalityOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Locality, Locality.Builder

public interface LocalityOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
    com.google.protobuf.ByteString
    Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
    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
    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.
    Defines the local service zone where Envoy is running.
    com.google.protobuf.ByteString
    Defines the local service zone where Envoy is running.

    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 Details

    • getRegion

      String getRegion()
       Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
       
      string region = 1;
      Returns:
      The region.
    • getRegionBytes

      com.google.protobuf.ByteString getRegionBytes()
       Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
       
      string region = 1;
      Returns:
      The bytes for region.
    • getZone

      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;
      Returns:
      The zone.
    • getZoneBytes

      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;
      Returns:
      The bytes for zone.
    • getSubZone

      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;
      Returns:
      The subZone.
    • getSubZoneBytes

      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;
      Returns:
      The bytes for subZone.