Package io.envoyproxy.envoy.extensions.load_balancing_policies.common.v3

Class LocalityLbConfig.ZoneAwareLbConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityLbConfig.ZoneAwareLbConfigOrBuilder, Serializable
Enclosing class:
LocalityLbConfig
public static final class LocalityLbConfig.ZoneAwareLbConfig extends com.google.protobuf.GeneratedMessageV3 implements LocalityLbConfig.ZoneAwareLbConfigOrBuilder
 Configuration for :ref:`zone aware routing
 <arch_overview_load_balancing_zone_aware_routing>`.
 [#next-free-field: 7]
Protobuf type envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig
See Also:

  • Field Details

    • ROUTING_ENABLED_FIELD_NUMBER

      public static final int ROUTING_ENABLED_FIELD_NUMBER
      See Also:

    • MIN_CLUSTER_SIZE_FIELD_NUMBER

      public static final int MIN_CLUSTER_SIZE_FIELD_NUMBER
      See Also:

    • FAIL_TRAFFIC_ON_PANIC_FIELD_NUMBER

      public static final int FAIL_TRAFFIC_ON_PANIC_FIELD_NUMBER
      See Also:

    • FORCE_LOCALITY_DIRECT_ROUTING_FIELD_NUMBER

      public static final int FORCE_LOCALITY_DIRECT_ROUTING_FIELD_NUMBER
      See Also:

    • FORCE_LOCAL_ZONE_FIELD_NUMBER

      public static final int FORCE_LOCAL_ZONE_FIELD_NUMBER
      See Also:

    • LOCALITY_BASIS_FIELD_NUMBER

      public static final int LOCALITY_BASIS_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

    • hasRoutingEnabled

      public boolean hasRoutingEnabled()
       Configures percentage of requests that will be considered for zone aware routing
 if zone aware routing is configured. If not specified, the default is 100%.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .envoy.type.v3.Percent routing_enabled = 1;
      Specified by:
      hasRoutingEnabled in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      Whether the routingEnabled field is set.

    • getRoutingEnabled

      public Percent getRoutingEnabled()
       Configures percentage of requests that will be considered for zone aware routing
 if zone aware routing is configured. If not specified, the default is 100%.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .envoy.type.v3.Percent routing_enabled = 1;
      Specified by:
      getRoutingEnabled in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      The routingEnabled.

    • getRoutingEnabledOrBuilder

      public PercentOrBuilder getRoutingEnabledOrBuilder()
       Configures percentage of requests that will be considered for zone aware routing
 if zone aware routing is configured. If not specified, the default is 100%.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .envoy.type.v3.Percent routing_enabled = 1;
      Specified by:
      getRoutingEnabledOrBuilder in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder

    • hasMinClusterSize

      public boolean hasMinClusterSize()
       Configures minimum upstream cluster size required for zone aware routing
 If upstream cluster size is less than specified, zone aware routing is not performed
 even if zone aware routing is configured. If not specified, the default is 6.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt64Value min_cluster_size = 2;
      Specified by:
      hasMinClusterSize in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      Whether the minClusterSize field is set.

    • getMinClusterSize

      public com.google.protobuf.UInt64Value getMinClusterSize()
       Configures minimum upstream cluster size required for zone aware routing
 If upstream cluster size is less than specified, zone aware routing is not performed
 even if zone aware routing is configured. If not specified, the default is 6.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt64Value min_cluster_size = 2;
      Specified by:
      getMinClusterSize in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      The minClusterSize.

    • getMinClusterSizeOrBuilder

      public com.google.protobuf.UInt64ValueOrBuilder getMinClusterSizeOrBuilder()
       Configures minimum upstream cluster size required for zone aware routing
 If upstream cluster size is less than specified, zone aware routing is not performed
 even if zone aware routing is configured. If not specified, the default is 6.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt64Value min_cluster_size = 2;
      Specified by:
      getMinClusterSizeOrBuilder in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder

    • getFailTrafficOnPanic

      public boolean getFailTrafficOnPanic()
       If set to true, Envoy will not consider any hosts when the cluster is in :ref:`panic
 mode<arch_overview_load_balancing_panic_threshold>`. Instead, the cluster will fail all
 requests as if all hosts are unhealthy. This can help avoid potentially overwhelming a
 failing service.
      bool fail_traffic_on_panic = 3;
      Specified by:
      getFailTrafficOnPanic in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      The failTrafficOnPanic.

    • getForceLocalityDirectRouting

      @Deprecated public boolean getForceLocalityDirectRouting()
      Deprecated.
      envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.force_locality_direct_routing is deprecated. See envoy/extensions/load_balancing_policies/common/v3/common.proto;l=74
       If set to true, Envoy will force LocalityDirect routing if a local locality exists.
      bool force_locality_direct_routing = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getForceLocalityDirectRouting in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      The forceLocalityDirectRouting.

    • hasForceLocalZone

      public boolean hasForceLocalZone()
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone force_local_zone = 5;
      Specified by:
      hasForceLocalZone in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      Whether the forceLocalZone field is set.

    • getForceLocalZone

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone getForceLocalZone()
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone force_local_zone = 5;
      Specified by:
      getForceLocalZone in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      The forceLocalZone.

    • getForceLocalZoneOrBuilder

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZoneOrBuilder getForceLocalZoneOrBuilder()
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone force_local_zone = 5;
      Specified by:
      getForceLocalZoneOrBuilder in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder

    • getLocalityBasisValue

      public int getLocalityBasisValue()
       Determines how locality percentages are computed:
 - HEALTHY_HOSTS_NUM: proportional to the count of healthy hosts.
 - HEALTHY_HOSTS_WEIGHT: proportional to the weights of healthy hosts.
 Default value is HEALTHY_HOSTS_NUM if unset.
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.LocalityBasis locality_basis = 6;
      Specified by:
      getLocalityBasisValue in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      The enum numeric value on the wire for localityBasis.

    • getLocalityBasis

      public LocalityLbConfig.ZoneAwareLbConfig.LocalityBasis getLocalityBasis()
       Determines how locality percentages are computed:
 - HEALTHY_HOSTS_NUM: proportional to the count of healthy hosts.
 - HEALTHY_HOSTS_WEIGHT: proportional to the weights of healthy hosts.
 Default value is HEALTHY_HOSTS_NUM if unset.
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.LocalityBasis locality_basis = 6;
      Specified by:
      getLocalityBasis in interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder
      Returns:
      The localityBasis.

    • 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 LocalityLbConfig.ZoneAwareLbConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static LocalityLbConfig.ZoneAwareLbConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static LocalityLbConfig.ZoneAwareLbConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static LocalityLbConfig.ZoneAwareLbConfig.Builder newBuilder()

    • newBuilder

      public static LocalityLbConfig.ZoneAwareLbConfig.Builder newBuilder(LocalityLbConfig.ZoneAwareLbConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static LocalityLbConfig.ZoneAwareLbConfig getDefaultInstance()

    • parser

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

    • getParserForType

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