Interface Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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 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.
      java.util.List<java.lang.String> 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.
      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.
      java.lang.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.
      java.util.List<java.lang.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.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

      • getKeysList

        java.util.List<java.lang.String> getKeysList()
         List of keys to match with the weighted cluster metadata.
         
        repeated string keys = 1;
        Returns:
        A list containing the keys.
      • getKeysCount

        int getKeysCount()
         List of keys to match with the weighted cluster metadata.
         
        repeated string keys = 1;
        Returns:
        The count of keys.
      • getKeys

        java.lang.String getKeys​(int index)
         List of keys to match with the weighted cluster metadata.
         
        repeated string keys = 1;
        Parameters:
        index - The index of the element to return.
        Returns:
        The keys at the given index.
      • getKeysBytes

        com.google.protobuf.ByteString getKeysBytes​(int index)
         List of keys to match with the weighted cluster metadata.
         
        repeated string keys = 1;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the keys at the given index.
      • 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.
        
         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;
        Returns:
        The singleHostPerSubset.
      • 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) = { ... }
        Returns:
        The enum numeric value on the wire for fallbackPolicy.
      • 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) = { ... }
        Returns:
        The fallbackPolicy.
      • getFallbackKeysSubsetList

        java.util.List<java.lang.String> 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;
        Returns:
        A list containing the fallbackKeysSubset.
      • getFallbackKeysSubsetCount

        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;
        Returns:
        The count of fallbackKeysSubset.
      • getFallbackKeysSubset

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The fallbackKeysSubset at the given index.
      • getFallbackKeysSubsetBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the fallbackKeysSubset at the given index.