Class LocalityLbConfig.ZoneAwareLbConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<LocalityLbConfig.ZoneAwareLbConfig.Builder>
com.google.protobuf.GeneratedMessage.Builder<LocalityLbConfig.ZoneAwareLbConfig.Builder>
io.envoyproxy.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityLbConfig.ZoneAwareLbConfigOrBuilder, Cloneable
Enclosing class:
LocalityLbConfig.ZoneAwareLbConfig
public static final class LocalityLbConfig.ZoneAwareLbConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<LocalityLbConfig.ZoneAwareLbConfig.Builder> implements LocalityLbConfig.ZoneAwareLbConfigOrBuilder
Configuration for :ref:`zone aware routing
<arch_overview_load_balancing_zone_aware_routing>`.
Protobuf type envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    LocalityLbConfig.ZoneAwareLbConfig
    build()
     
    LocalityLbConfig.ZoneAwareLbConfig
    buildPartial()
     
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    clear()
     
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    clearFailTrafficOnPanic()
    If set to true, Envoy will not consider any hosts when the cluster is in :ref:`panic mode<arch_overview_load_balancing_panic_threshold>`.
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    clearMinClusterSize()
    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.
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    clearRoutingEnabled()
    Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
    LocalityLbConfig.ZoneAwareLbConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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>`.
    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.
    com.google.protobuf.UInt64Value.Builder
    getMinClusterSizeBuilder()
    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.
    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.
    Percent
    getRoutingEnabled()
    Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
    Percent.Builder
    getRoutingEnabledBuilder()
    Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
    PercentOrBuilder
    getRoutingEnabledOrBuilder()
    Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
    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.
    boolean
    hasRoutingEnabled()
    Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    mergeFrom(LocalityLbConfig.ZoneAwareLbConfig other)
     
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    mergeMinClusterSize(com.google.protobuf.UInt64Value value)
    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.
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    mergeRoutingEnabled(Percent value)
    Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    setFailTrafficOnPanic(boolean value)
    If set to true, Envoy will not consider any hosts when the cluster is in :ref:`panic mode<arch_overview_load_balancing_panic_threshold>`.
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    setMinClusterSize(com.google.protobuf.UInt64Value value)
    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.
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    setMinClusterSize(com.google.protobuf.UInt64Value.Builder builderForValue)
    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.
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    setRoutingEnabled(Percent value)
    Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
    LocalityLbConfig.ZoneAwareLbConfig.Builder
    setRoutingEnabled(Percent.Builder builderForValue)
    Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

    • clear

      public LocalityLbConfig.ZoneAwareLbConfig.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.GeneratedMessage.Builder<LocalityLbConfig.ZoneAwareLbConfig.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.GeneratedMessage.Builder<LocalityLbConfig.ZoneAwareLbConfig.Builder>

    • getDefaultInstanceForType

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

    • build

      public LocalityLbConfig.ZoneAwareLbConfig 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 buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

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

    • mergeFrom

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

    • isInitialized

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

    • mergeFrom

      public LocalityLbConfig.ZoneAwareLbConfig.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.Builder>
      Throws:
      IOException

    • 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.

    • setRoutingEnabled

      public LocalityLbConfig.ZoneAwareLbConfig.Builder setRoutingEnabled(Percent value)
      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;

    • setRoutingEnabled

      public LocalityLbConfig.ZoneAwareLbConfig.Builder setRoutingEnabled(Percent.Builder builderForValue)
      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;

    • mergeRoutingEnabled

      public LocalityLbConfig.ZoneAwareLbConfig.Builder mergeRoutingEnabled(Percent value)
      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;

    • clearRoutingEnabled

      public LocalityLbConfig.ZoneAwareLbConfig.Builder clearRoutingEnabled()
      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;

    • getRoutingEnabledBuilder

      public Percent.Builder getRoutingEnabledBuilder()
      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;

    • 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.

    • setMinClusterSize

      public LocalityLbConfig.ZoneAwareLbConfig.Builder setMinClusterSize(com.google.protobuf.UInt64Value value)
      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;

    • setMinClusterSize

      public LocalityLbConfig.ZoneAwareLbConfig.Builder setMinClusterSize(com.google.protobuf.UInt64Value.Builder builderForValue)
      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;

    • mergeMinClusterSize

      public LocalityLbConfig.ZoneAwareLbConfig.Builder mergeMinClusterSize(com.google.protobuf.UInt64Value value)
      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;

    • clearMinClusterSize

      public LocalityLbConfig.ZoneAwareLbConfig.Builder clearMinClusterSize()
      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;

    • getMinClusterSizeBuilder

      public com.google.protobuf.UInt64Value.Builder getMinClusterSizeBuilder()
      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;

    • 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.

    • setFailTrafficOnPanic

      public LocalityLbConfig.ZoneAwareLbConfig.Builder setFailTrafficOnPanic(boolean value)
      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;
      Parameters:
      value - The failTrafficOnPanic to set.
      Returns:
      This builder for chaining.

    • clearFailTrafficOnPanic

      public LocalityLbConfig.ZoneAwareLbConfig.Builder clearFailTrafficOnPanic()
      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;
      Returns:
      This builder for chaining.