Class Cluster.LbSubsetConfig.LbSubsetSelector
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
,Serializable
- Enclosing class:
Cluster.LbSubsetConfig
public static final class Cluster.LbSubsetConfig.LbSubsetSelector
extends com.google.protobuf.GeneratedMessage
implements Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
Specifications for subsets.Protobuf type
envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Specifications for subsets.static enum
Allows to override top level fallback policy per selector.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Cluster.LbSubsetConfig.LbSubsetSelector
static final int
static final int
private com.google.protobuf.LazyStringArrayList
private int
private com.google.protobuf.LazyStringArrayList
static final int
private byte
private static final com.google.protobuf.Parser
<Cluster.LbSubsetConfig.LbSubsetSelector> private static final long
static final int
private boolean
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
LbSubsetSelector
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static final com.google.protobuf.Descriptors.Descriptor
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.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.int
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.com.google.protobuf.ProtocolStringList
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.The behavior used when no endpoint subset matches the selected route's metadata.int
The behavior used when no endpoint subset matches the selected route's metadata.getKeys
(int index) List of keys to match with the weighted cluster metadata.com.google.protobuf.ByteString
getKeysBytes
(int index) List of keys to match with the weighted cluster metadata.int
List of keys to match with the weighted cluster metadata.com.google.protobuf.ProtocolStringList
List of keys to match with the weighted cluster metadata.com.google.protobuf.Parser
<Cluster.LbSubsetConfig.LbSubsetSelector> int
boolean
Selects a mode of operation in which each subset has only one host.int
hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom
(InputStream input) parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(byte[] data) parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(com.google.protobuf.ByteString data) parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(com.google.protobuf.CodedInputStream input) parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(InputStream input) parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(ByteBuffer data) parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<Cluster.LbSubsetConfig.LbSubsetSelector> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
KEYS_FIELD_NUMBER
public static final int KEYS_FIELD_NUMBER- See Also:
-
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:
-
singleHostPerSubset_
private boolean singleHostPerSubset_ -
FALLBACK_POLICY_FIELD_NUMBER
public static final int FALLBACK_POLICY_FIELD_NUMBER- See Also:
-
fallbackPolicy_
private int fallbackPolicy_ -
FALLBACK_KEYS_SUBSET_FIELD_NUMBER
public static final int FALLBACK_KEYS_SUBSET_FIELD_NUMBER- See Also:
-
fallbackKeysSubset_
private com.google.protobuf.LazyStringArrayList fallbackKeysSubset_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
LbSubsetSelector
private LbSubsetSelector(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
LbSubsetSelector
private LbSubsetSelector()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getKeysList
public com.google.protobuf.ProtocolStringList getKeysList()List of keys to match with the weighted cluster metadata.
repeated string keys = 1;
- Specified by:
getKeysList
in interfaceCluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
- Returns:
- A list containing the keys.
-
getKeysCount
public int getKeysCount()List of keys to match with the weighted cluster metadata.
repeated string keys = 1;
- Specified by:
getKeysCount
in interfaceCluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
- Returns:
- The count of keys.
-
getKeys
List of keys to match with the weighted cluster metadata.
repeated string keys = 1;
- Specified by:
getKeys
in interfaceCluster.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 interfaceCluster.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 interfaceCluster.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 interfaceCluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
- Returns:
- The enum numeric value on the wire for fallbackPolicy.
-
getFallbackPolicy
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:
getFallbackPolicy
in interfaceCluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
- Returns:
- The 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 interfaceCluster.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 interfaceCluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
- Returns:
- The count of fallbackKeysSubset.
-
getFallbackKeysSubset
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 interfaceCluster.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 interfaceCluster.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 interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom(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(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static Cluster.LbSubsetConfig.LbSubsetSelector parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static Cluster.LbSubsetConfig.LbSubsetSelector parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static Cluster.LbSubsetConfig.LbSubsetSelector parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static Cluster.LbSubsetConfig.LbSubsetSelector.Builder newBuilder(Cluster.LbSubsetConfig.LbSubsetSelector prototype) -
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Cluster.LbSubsetConfig.LbSubsetSelector.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-