Class LocalityLbConfig.ZoneAwareLbConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityLbConfig.ZoneAwareLbConfigOrBuilder, java.io.Serializable
    Enclosing class:
    LocalityLbConfig

    public static final class LocalityLbConfig.ZoneAwareLbConfig
    extends com.google.protobuf.GeneratedMessage
    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
    See Also:
    Serialized Form
    • Field Detail

      • bitField0_

        private int bitField0_
      • ROUTING_ENABLED_FIELD_NUMBER

        public static final int ROUTING_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values
      • routingEnabled_

        private Percent routingEnabled_
      • MIN_CLUSTER_SIZE_FIELD_NUMBER

        public static final int MIN_CLUSTER_SIZE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • minClusterSize_

        private com.google.protobuf.UInt64Value minClusterSize_
      • FAIL_TRAFFIC_ON_PANIC_FIELD_NUMBER

        public static final int FAIL_TRAFFIC_ON_PANIC_FIELD_NUMBER
        See Also:
        Constant Field Values
      • failTrafficOnPanic_

        private boolean failTrafficOnPanic_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
    • Constructor Detail

      • ZoneAwareLbConfig

        private ZoneAwareLbConfig​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • ZoneAwareLbConfig

        private ZoneAwareLbConfig()
    • Method Detail

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

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static LocalityLbConfig.ZoneAwareLbConfig parseFrom​(java.nio.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​(java.io.InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static LocalityLbConfig.ZoneAwareLbConfig parseDelimitedFrom​(java.io.InputStream input)
                                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

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

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

        public static LocalityLbConfig.ZoneAwareLbConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws java.io.IOException
        Throws:
        java.io.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
      • 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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • 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.GeneratedMessage
      • getDefaultInstanceForType

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