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

Class Cluster.LbSubsetConfig.LbSubsetSelector

    • Field Detail

      • keys_

        private com.google.protobuf.LazyStringArrayList keys_

      • SINGLE_HOST_PER_SUBSET_FIELD_NUMBER

        public static final int SINGLE_HOST_PER_SUBSET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • singleHostPerSubset_

        private boolean singleHostPerSubset_

      • FALLBACK_POLICY_FIELD_NUMBER

        public static final int FALLBACK_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • fallbackPolicy_

        private int fallbackPolicy_

      • FALLBACK_KEYS_SUBSET_FIELD_NUMBER

        public static final int FALLBACK_KEYS_SUBSET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • fallbackKeysSubset_

        private com.google.protobuf.LazyStringArrayList fallbackKeysSubset_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

    • Constructor Detail

      • LbSubsetSelector

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

      • LbSubsetSelector

        private LbSubsetSelector()

    • 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

      • getKeys

        public java.lang.String getKeys​(int index)
         List of keys to match with the weighted cluster metadata.
        repeated string keys = 1;
        Specified by:
        getKeys in interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The keys at the given index.

      • getKeysBytes

        public com.google.protobuf.ByteString getKeysBytes​(int index)
         List of keys to match with the weighted cluster metadata.
        repeated string keys = 1;
        Specified by:
        getKeysBytes in interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the keys at the given index.

      • getSingleHostPerSubset

        public boolean getSingleHostPerSubset()
         Selects a mode of operation in which each subset has only one host. This mode uses the same rules for
 choosing a host, but updating hosts is faster, especially for large numbers of hosts.

 If a match is found to a host, that host will be used regardless of priority levels.

 When this mode is enabled, configurations that contain more than one host with the same metadata value for the single key in ``keys``
 will use only one of the hosts with the given key; no requests will be routed to the others. The cluster gauge
 :ref:`lb_subsets_single_host_per_subset_duplicate<config_cluster_manager_cluster_stats_subset_lb>` indicates how many duplicates are
 present in the current configuration.
        bool single_host_per_subset = 4;
        Specified by:
        getSingleHostPerSubset in interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
        Returns:
        The singleHostPerSubset.

      • getFallbackPolicyValue

        public int getFallbackPolicyValue()
         The behavior used when no endpoint subset matches the selected route's
 metadata.
        .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy fallback_policy = 2 [(.validate.rules) = { ... }
        Specified by:
        getFallbackPolicyValue in interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
        Returns:
        The enum numeric value on the wire for fallbackPolicy.

      • getFallbackKeysSubsetList

        public com.google.protobuf.ProtocolStringList getFallbackKeysSubsetList()
         Subset of
 :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by
 :ref:`KEYS_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy.KEYS_SUBSET>`
 fallback policy.
 It has to be a non empty list if KEYS_SUBSET fallback policy is selected.
 For any other fallback policy the parameter is not used and should not be set.
 Only values also present in
 :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` are allowed, but
 ``fallback_keys_subset`` cannot be equal to ``keys``.
        repeated string fallback_keys_subset = 3;
        Specified by:
        getFallbackKeysSubsetList in interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
        Returns:
        A list containing the fallbackKeysSubset.

      • getFallbackKeysSubsetCount

        public int getFallbackKeysSubsetCount()
         Subset of
 :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by
 :ref:`KEYS_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy.KEYS_SUBSET>`
 fallback policy.
 It has to be a non empty list if KEYS_SUBSET fallback policy is selected.
 For any other fallback policy the parameter is not used and should not be set.
 Only values also present in
 :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` are allowed, but
 ``fallback_keys_subset`` cannot be equal to ``keys``.
        repeated string fallback_keys_subset = 3;
        Specified by:
        getFallbackKeysSubsetCount in interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
        Returns:
        The count of fallbackKeysSubset.

      • getFallbackKeysSubset

        public java.lang.String getFallbackKeysSubset​(int index)
         Subset of
 :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by
 :ref:`KEYS_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy.KEYS_SUBSET>`
 fallback policy.
 It has to be a non empty list if KEYS_SUBSET fallback policy is selected.
 For any other fallback policy the parameter is not used and should not be set.
 Only values also present in
 :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` are allowed, but
 ``fallback_keys_subset`` cannot be equal to ``keys``.
        repeated string fallback_keys_subset = 3;
        Specified by:
        getFallbackKeysSubset in interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The fallbackKeysSubset at the given index.

      • getFallbackKeysSubsetBytes

        public com.google.protobuf.ByteString getFallbackKeysSubsetBytes​(int index)
         Subset of
 :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by
 :ref:`KEYS_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy.KEYS_SUBSET>`
 fallback policy.
 It has to be a non empty list if KEYS_SUBSET fallback policy is selected.
 For any other fallback policy the parameter is not used and should not be set.
 Only values also present in
 :ref:`keys<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` are allowed, but
 ``fallback_keys_subset`` cannot be equal to ``keys``.
        repeated string fallback_keys_subset = 3;
        Specified by:
        getFallbackKeysSubsetBytes in interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the fallbackKeysSubset at the given index.

      • 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 Cluster.LbSubsetConfig.LbSubsetSelector parseFrom​(java.nio.ByteBuffer data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom​(java.nio.ByteBuffer data,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom​(com.google.protobuf.ByteString data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom​(com.google.protobuf.ByteString data,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom​(byte[] data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom​(byte[] data,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom​(java.io.InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Cluster.LbSubsetConfig.LbSubsetSelector parseDelimitedFrom​(java.io.InputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom​(com.google.protobuf.CodedInputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public Cluster.LbSubsetConfig.LbSubsetSelector.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Cluster.LbSubsetConfig.LbSubsetSelector.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getParserForType

        public com.google.protobuf.Parser<Cluster.LbSubsetConfig.LbSubsetSelector> 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 Cluster.LbSubsetConfig.LbSubsetSelector getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder