io.envoyproxy.envoy.config.cluster.v3

Interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Cluster.LbSubsetConfig.LbSubsetSelector, Cluster.LbSubsetConfig.LbSubsetSelector.Builder

Enclosing class:

Cluster.LbSubsetConfig

public static interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFallbackKeysSubset(int index) Subset of :ref:`keys<envoy_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by :ref:`KEYS_SUBSET<envoy_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_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by :ref:`KEYS_SUBSET<envoy_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy.KEYS_SUBSET>` fallback policy.
int	getFallbackKeysSubsetCount() Subset of :ref:`keys<envoy_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by :ref:`KEYS_SUBSET<envoy_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy.KEYS_SUBSET>` fallback policy.
List<String>	getFallbackKeysSubsetList() Subset of :ref:`keys<envoy_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by :ref:`KEYS_SUBSET<envoy_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy.KEYS_SUBSET>` fallback policy.
Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy	getFallbackPolicy() The behavior used when no endpoint subset matches the selected route's metadata.
int	getFallbackPolicyValue() The behavior used when no endpoint subset matches the selected route's metadata.
String	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	getKeysCount() List of keys to match with the weighted cluster metadata.
List<String>	getKeysList() List of keys to match with the weighted cluster metadata.
boolean	getSingleHostPerSubset() Selects a mode of operation in which each subset has only one host.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getKeysList

List<String> getKeysList()

 List of keys to match with the weighted cluster metadata.
 

repeated string keys = 1;

getKeysCount

int getKeysCount()

 List of keys to match with the weighted cluster metadata.
 

repeated string keys = 1;

getKeys

String getKeys(int index)

 List of keys to match with the weighted cluster metadata.
 

repeated string keys = 1;

getKeysBytes

com.google.protobuf.ByteString getKeysBytes(int index)

 List of keys to match with the weighted cluster metadata.
 

repeated string keys = 1;

getSingleHostPerSubset

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, unless the host is unhealthy.
 Currently, this mode is only supported if `subset_selectors` has only one entry, and `keys` contains
 only one entry.
 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;

getFallbackPolicyValue

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) = { ... }

getFallbackPolicy

Cluster.LbSubsetConfig.LbSubsetSelector.LbSubsetSelectorFallbackPolicy 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) = { ... }

getFallbackKeysSubsetList

List<String> getFallbackKeysSubsetList()

 Subset of
 :ref:`keys<envoy_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by
 :ref:`KEYS_SUBSET<envoy_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_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;

getFallbackKeysSubsetCount

int getFallbackKeysSubsetCount()

 Subset of
 :ref:`keys<envoy_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by
 :ref:`KEYS_SUBSET<envoy_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_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;

getFallbackKeysSubset

String getFallbackKeysSubset(int index)

 Subset of
 :ref:`keys<envoy_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by
 :ref:`KEYS_SUBSET<envoy_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_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;

getFallbackKeysSubsetBytes

com.google.protobuf.ByteString getFallbackKeysSubsetBytes(int index)

 Subset of
 :ref:`keys<envoy_api_field_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector.keys>` used by
 :ref:`KEYS_SUBSET<envoy_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_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;