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

Class LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>
io.envoyproxy.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZoneOrBuilder, Cloneable
Enclosing class:
LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone
public static final class LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder> implements LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZoneOrBuilder
 Configures Envoy to always route requests to the local zone regardless of the
 upstream zone structure. In Envoy's default configuration, traffic is distributed proportionally
 across all upstream hosts while trying to maximize local routing when possible. The approach
 with force_local_zone aims to be more predictable and if there are upstream hosts in the local
 zone, they will receive all traffic.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
Protobuf type envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone

  • Method Details

    • 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.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • clear

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • getDefaultInstanceForType

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • setField

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • clearField

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • clearOneof

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • setRepeatedField

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • addRepeatedField

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • mergeFrom

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • mergeFrom

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder mergeFrom(LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • mergeFrom

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>
      Throws:
      IOException

    • hasMinSize

      public boolean hasMinSize()
       Configures the minimum number of upstream hosts in the local zone required when force_local_zone
 is enabled. If the number of upstream hosts in the local zone is less than the specified value,
 Envoy will fall back to the default proportional-based distribution across localities.
 If not specified, the default is 1.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt32Value min_size = 1;
      Specified by:
      hasMinSize in interface LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZoneOrBuilder
      Returns:
      Whether the minSize field is set.

    • getMinSize

      public com.google.protobuf.UInt32Value getMinSize()
       Configures the minimum number of upstream hosts in the local zone required when force_local_zone
 is enabled. If the number of upstream hosts in the local zone is less than the specified value,
 Envoy will fall back to the default proportional-based distribution across localities.
 If not specified, the default is 1.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt32Value min_size = 1;
      Specified by:
      getMinSize in interface LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZoneOrBuilder
      Returns:
      The minSize.

    • setMinSize

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder setMinSize(com.google.protobuf.UInt32Value value)
       Configures the minimum number of upstream hosts in the local zone required when force_local_zone
 is enabled. If the number of upstream hosts in the local zone is less than the specified value,
 Envoy will fall back to the default proportional-based distribution across localities.
 If not specified, the default is 1.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt32Value min_size = 1;

    • setMinSize

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder setMinSize(com.google.protobuf.UInt32Value.Builder builderForValue)
       Configures the minimum number of upstream hosts in the local zone required when force_local_zone
 is enabled. If the number of upstream hosts in the local zone is less than the specified value,
 Envoy will fall back to the default proportional-based distribution across localities.
 If not specified, the default is 1.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt32Value min_size = 1;

    • mergeMinSize

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder mergeMinSize(com.google.protobuf.UInt32Value value)
       Configures the minimum number of upstream hosts in the local zone required when force_local_zone
 is enabled. If the number of upstream hosts in the local zone is less than the specified value,
 Envoy will fall back to the default proportional-based distribution across localities.
 If not specified, the default is 1.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt32Value min_size = 1;

    • clearMinSize

      public LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder clearMinSize()
       Configures the minimum number of upstream hosts in the local zone required when force_local_zone
 is enabled. If the number of upstream hosts in the local zone is less than the specified value,
 Envoy will fall back to the default proportional-based distribution across localities.
 If not specified, the default is 1.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt32Value min_size = 1;

    • getMinSizeBuilder

      public com.google.protobuf.UInt32Value.Builder getMinSizeBuilder()
       Configures the minimum number of upstream hosts in the local zone required when force_local_zone
 is enabled. If the number of upstream hosts in the local zone is less than the specified value,
 Envoy will fall back to the default proportional-based distribution across localities.
 If not specified, the default is 1.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt32Value min_size = 1;

    • getMinSizeOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getMinSizeOrBuilder()
       Configures the minimum number of upstream hosts in the local zone required when force_local_zone
 is enabled. If the number of upstream hosts in the local zone is less than the specified value,
 Envoy will fall back to the default proportional-based distribution across localities.
 If not specified, the default is 1.
 * :ref:`runtime values <config_cluster_manager_cluster_runtime_zone_routing>`.
 * :ref:`Zone aware routing support <arch_overview_load_balancing_zone_aware_routing>`.
      .google.protobuf.UInt32Value min_size = 1;
      Specified by:
      getMinSizeOrBuilder in interface LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZoneOrBuilder

    • setUnknownFields

      public final LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>

    • mergeUnknownFields

      public final LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone.Builder>