Package io.envoyproxy.envoy.config.cluster.v3

Class Cluster.CommonLbConfig.ZoneAwareLbConfig.Builder

    • Method Detail

      • 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<Cluster.CommonLbConfig.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.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ZoneAwareLbConfig.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • 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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder
        Returns:
        The routingEnabled.

      • setRoutingEnabled

        public Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder
        Returns:
        The minClusterSize.

      • setMinClusterSize

        public Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.ZoneAwareLbConfigOrBuilder
        Returns:
        The failTrafficOnPanic.

      • setFailTrafficOnPanic

        public Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.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.