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

Interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
LocalityLbConfig.ZoneAwareLbConfig, LocalityLbConfig.ZoneAwareLbConfig.Builder
Enclosing class:
LocalityLbConfig
public static interface LocalityLbConfig.ZoneAwareLbConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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>`.
    boolean
    getForceLocalityDirectRouting()
    Deprecated.
    envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.force_locality_direct_routing is deprecated.
    LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone
    getForceLocalZone()
    .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone force_local_zone = 5;
    LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZoneOrBuilder
    getForceLocalZoneOrBuilder()
    .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone force_local_zone = 5;
    LocalityLbConfig.ZoneAwareLbConfig.LocalityBasis
    getLocalityBasis()
    Determines how locality percentages are computed: - HEALTHY_HOSTS_NUM: proportional to the count of healthy hosts
    int
    getLocalityBasisValue()
    Determines how locality percentages are computed: - HEALTHY_HOSTS_NUM: proportional to the count of healthy hosts
    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.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.
    PercentOrBuilder
    getRoutingEnabledOrBuilder()
    Configures percentage of requests that will be considered for zone aware routing if zone aware routing is configured.
    boolean
    hasForceLocalZone()
    .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone force_local_zone = 5;
    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.

    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

    • hasRoutingEnabled

      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;
      Returns:
      Whether the routingEnabled field is set.

    • getRoutingEnabled

      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;
      Returns:
      The routingEnabled.

    • getRoutingEnabledOrBuilder

      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;

    • hasMinClusterSize

      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;
      Returns:
      Whether the minClusterSize field is set.

    • getMinClusterSize

      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;
      Returns:
      The minClusterSize.

    • getMinClusterSizeOrBuilder

      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;

    • getFailTrafficOnPanic

      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;
      Returns:
      The failTrafficOnPanic.

    • getForceLocalityDirectRouting

      @Deprecated 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"];
      Returns:
      The forceLocalityDirectRouting.

    • hasForceLocalZone

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

    • getForceLocalZone

      LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone getForceLocalZone()
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone force_local_zone = 5;
      Returns:
      The forceLocalZone.

    • getForceLocalZoneOrBuilder

      LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZoneOrBuilder getForceLocalZoneOrBuilder()
      .envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.ZoneAwareLbConfig.ForceLocalZone force_local_zone = 5;

    • getLocalityBasisValue

      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;
      Returns:
      The enum numeric value on the wire for localityBasis.

    • getLocalityBasis

      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;
      Returns:
      The localityBasis.