Class Cluster.LbSubsetConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<Cluster.LbSubsetConfig.Builder>
com.google.protobuf.GeneratedMessage.Builder<Cluster.LbSubsetConfig.Builder>
io.envoyproxy.envoy.config.cluster.v3.Cluster.LbSubsetConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cluster.LbSubsetConfigOrBuilder, Cloneable
Enclosing class:
Cluster.LbSubsetConfig

public static final class Cluster.LbSubsetConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<Cluster.LbSubsetConfig.Builder> implements Cluster.LbSubsetConfigOrBuilder
 Optionally divide the endpoints in this cluster into subsets defined by
 endpoint metadata and selected by route and weighted cluster metadata.
 [#next-free-field: 9]
 
Protobuf type envoy.config.cluster.v3.Cluster.LbSubsetConfig
  • Field Details

    • bitField0_

      private int bitField0_
    • fallbackPolicy_

      private int fallbackPolicy_
    • defaultSubset_

      private com.google.protobuf.Struct defaultSubset_
    • defaultSubsetBuilder_

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Struct,com.google.protobuf.Struct.Builder,com.google.protobuf.StructOrBuilder> defaultSubsetBuilder_
    • subsetSelectors_

      private List<Cluster.LbSubsetConfig.LbSubsetSelector> subsetSelectors_
    • subsetSelectorsBuilder_

    • localityWeightAware_

      private boolean localityWeightAware_
    • scaleLocalityWeight_

      private boolean scaleLocalityWeight_
    • panicModeAny_

      private boolean panicModeAny_
    • listAsAny_

      private boolean listAsAny_
    • metadataFallbackPolicy_

      private int metadataFallbackPolicy_
  • Constructor Details

    • Builder

      private Builder()
    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
  • Method Details

    • 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.Builder<Cluster.LbSubsetConfig.Builder>
    • maybeForceBuilderInitialization

      private void maybeForceBuilderInitialization()
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Cluster.LbSubsetConfig.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Cluster.LbSubsetConfig.Builder>
    • getDefaultInstanceForType

      public Cluster.LbSubsetConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public Cluster.LbSubsetConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public Cluster.LbSubsetConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • buildPartialRepeatedFields

      private void buildPartialRepeatedFields(Cluster.LbSubsetConfig result)
    • buildPartial0

      private void buildPartial0(Cluster.LbSubsetConfig result)
    • mergeFrom

      public Cluster.LbSubsetConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Cluster.LbSubsetConfig.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Cluster.LbSubsetConfig.Builder>
    • mergeFrom

      public Cluster.LbSubsetConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Cluster.LbSubsetConfig.Builder>
      Throws:
      IOException
    • getFallbackPolicyValue

      public int getFallbackPolicyValue()
       The behavior used when no endpoint subset matches the selected route's
       metadata. The value defaults to
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy fallback_policy = 1 [(.validate.rules) = { ... }
      Specified by:
      getFallbackPolicyValue in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      The enum numeric value on the wire for fallbackPolicy.
    • setFallbackPolicyValue

      public Cluster.LbSubsetConfig.Builder setFallbackPolicyValue(int value)
       The behavior used when no endpoint subset matches the selected route's
       metadata. The value defaults to
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy fallback_policy = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The enum numeric value on the wire for fallbackPolicy to set.
      Returns:
      This builder for chaining.
    • getFallbackPolicy

       The behavior used when no endpoint subset matches the selected route's
       metadata. The value defaults to
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy fallback_policy = 1 [(.validate.rules) = { ... }
      Specified by:
      getFallbackPolicy in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      The fallbackPolicy.
    • setFallbackPolicy

       The behavior used when no endpoint subset matches the selected route's
       metadata. The value defaults to
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy fallback_policy = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The fallbackPolicy to set.
      Returns:
      This builder for chaining.
    • clearFallbackPolicy

      public Cluster.LbSubsetConfig.Builder clearFallbackPolicy()
       The behavior used when no endpoint subset matches the selected route's
       metadata. The value defaults to
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy fallback_policy = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.
    • hasDefaultSubset

      public boolean hasDefaultSubset()
       Specifies the default subset of endpoints used during fallback if
       fallback_policy is
       :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
       Each field in default_subset is
       compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
       namespace. It is valid for no hosts to match, in which case the behavior
       is the same as a fallback_policy of
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .google.protobuf.Struct default_subset = 2;
      Specified by:
      hasDefaultSubset in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      Whether the defaultSubset field is set.
    • getDefaultSubset

      public com.google.protobuf.Struct getDefaultSubset()
       Specifies the default subset of endpoints used during fallback if
       fallback_policy is
       :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
       Each field in default_subset is
       compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
       namespace. It is valid for no hosts to match, in which case the behavior
       is the same as a fallback_policy of
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .google.protobuf.Struct default_subset = 2;
      Specified by:
      getDefaultSubset in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      The defaultSubset.
    • setDefaultSubset

      public Cluster.LbSubsetConfig.Builder setDefaultSubset(com.google.protobuf.Struct value)
       Specifies the default subset of endpoints used during fallback if
       fallback_policy is
       :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
       Each field in default_subset is
       compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
       namespace. It is valid for no hosts to match, in which case the behavior
       is the same as a fallback_policy of
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .google.protobuf.Struct default_subset = 2;
    • setDefaultSubset

      public Cluster.LbSubsetConfig.Builder setDefaultSubset(com.google.protobuf.Struct.Builder builderForValue)
       Specifies the default subset of endpoints used during fallback if
       fallback_policy is
       :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
       Each field in default_subset is
       compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
       namespace. It is valid for no hosts to match, in which case the behavior
       is the same as a fallback_policy of
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .google.protobuf.Struct default_subset = 2;
    • mergeDefaultSubset

      public Cluster.LbSubsetConfig.Builder mergeDefaultSubset(com.google.protobuf.Struct value)
       Specifies the default subset of endpoints used during fallback if
       fallback_policy is
       :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
       Each field in default_subset is
       compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
       namespace. It is valid for no hosts to match, in which case the behavior
       is the same as a fallback_policy of
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .google.protobuf.Struct default_subset = 2;
    • clearDefaultSubset

      public Cluster.LbSubsetConfig.Builder clearDefaultSubset()
       Specifies the default subset of endpoints used during fallback if
       fallback_policy is
       :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
       Each field in default_subset is
       compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
       namespace. It is valid for no hosts to match, in which case the behavior
       is the same as a fallback_policy of
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .google.protobuf.Struct default_subset = 2;
    • getDefaultSubsetBuilder

      public com.google.protobuf.Struct.Builder getDefaultSubsetBuilder()
       Specifies the default subset of endpoints used during fallback if
       fallback_policy is
       :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
       Each field in default_subset is
       compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
       namespace. It is valid for no hosts to match, in which case the behavior
       is the same as a fallback_policy of
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .google.protobuf.Struct default_subset = 2;
    • getDefaultSubsetOrBuilder

      public com.google.protobuf.StructOrBuilder getDefaultSubsetOrBuilder()
       Specifies the default subset of endpoints used during fallback if
       fallback_policy is
       :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
       Each field in default_subset is
       compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
       namespace. It is valid for no hosts to match, in which case the behavior
       is the same as a fallback_policy of
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .google.protobuf.Struct default_subset = 2;
      Specified by:
      getDefaultSubsetOrBuilder in interface Cluster.LbSubsetConfigOrBuilder
    • internalGetDefaultSubsetFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Struct,com.google.protobuf.Struct.Builder,com.google.protobuf.StructOrBuilder> internalGetDefaultSubsetFieldBuilder()
       Specifies the default subset of endpoints used during fallback if
       fallback_policy is
       :ref:`DEFAULT_SUBSET<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
       Each field in default_subset is
       compared to the matching LbEndpoint.Metadata under the ``envoy.lb``
       namespace. It is valid for no hosts to match, in which case the behavior
       is the same as a fallback_policy of
       :ref:`NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
       
      .google.protobuf.Struct default_subset = 2;
    • ensureSubsetSelectorsIsMutable

      private void ensureSubsetSelectorsIsMutable()
    • getSubsetSelectorsList

      public List<Cluster.LbSubsetConfig.LbSubsetSelector> getSubsetSelectorsList()
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
      Specified by:
      getSubsetSelectorsList in interface Cluster.LbSubsetConfigOrBuilder
    • getSubsetSelectorsCount

      public int getSubsetSelectorsCount()
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
      Specified by:
      getSubsetSelectorsCount in interface Cluster.LbSubsetConfigOrBuilder
    • getSubsetSelectors

      public Cluster.LbSubsetConfig.LbSubsetSelector getSubsetSelectors(int index)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
      Specified by:
      getSubsetSelectors in interface Cluster.LbSubsetConfigOrBuilder
    • setSubsetSelectors

      public Cluster.LbSubsetConfig.Builder setSubsetSelectors(int index, Cluster.LbSubsetConfig.LbSubsetSelector value)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • setSubsetSelectors

      public Cluster.LbSubsetConfig.Builder setSubsetSelectors(int index, Cluster.LbSubsetConfig.LbSubsetSelector.Builder builderForValue)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • addSubsetSelectors

       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • addSubsetSelectors

      public Cluster.LbSubsetConfig.Builder addSubsetSelectors(int index, Cluster.LbSubsetConfig.LbSubsetSelector value)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • addSubsetSelectors

       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • addSubsetSelectors

      public Cluster.LbSubsetConfig.Builder addSubsetSelectors(int index, Cluster.LbSubsetConfig.LbSubsetSelector.Builder builderForValue)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • addAllSubsetSelectors

      public Cluster.LbSubsetConfig.Builder addAllSubsetSelectors(Iterable<? extends Cluster.LbSubsetConfig.LbSubsetSelector> values)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • clearSubsetSelectors

      public Cluster.LbSubsetConfig.Builder clearSubsetSelectors()
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • removeSubsetSelectors

      public Cluster.LbSubsetConfig.Builder removeSubsetSelectors(int index)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • getSubsetSelectorsBuilder

      public Cluster.LbSubsetConfig.LbSubsetSelector.Builder getSubsetSelectorsBuilder(int index)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • getSubsetSelectorsOrBuilder

      public Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder getSubsetSelectorsOrBuilder(int index)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
      Specified by:
      getSubsetSelectorsOrBuilder in interface Cluster.LbSubsetConfigOrBuilder
    • getSubsetSelectorsOrBuilderList

      public List<? extends Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder> getSubsetSelectorsOrBuilderList()
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
      Specified by:
      getSubsetSelectorsOrBuilderList in interface Cluster.LbSubsetConfigOrBuilder
    • addSubsetSelectorsBuilder

      public Cluster.LbSubsetConfig.LbSubsetSelector.Builder addSubsetSelectorsBuilder()
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • addSubsetSelectorsBuilder

      public Cluster.LbSubsetConfig.LbSubsetSelector.Builder addSubsetSelectorsBuilder(int index)
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • getSubsetSelectorsBuilderList

      public List<Cluster.LbSubsetConfig.LbSubsetSelector.Builder> getSubsetSelectorsBuilderList()
       For each entry, LbEndpoint.Metadata's
       ``envoy.lb`` namespace is traversed and a subset is created for each unique
       combination of key and value. For example:
      
       .. code-block:: json
      
       { "subset_selectors": [
       { "keys": [ "version" ] },
       { "keys": [ "stage", "hardware_type" ] }
       ]}
      
       A subset is matched when the metadata from the selected route and
       weighted cluster contains the same keys and values as the subset's
       metadata. The same host may appear in multiple subsets.
       
      repeated .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;
    • internalGetSubsetSelectorsFieldBuilder

      private com.google.protobuf.RepeatedFieldBuilder<Cluster.LbSubsetConfig.LbSubsetSelector,Cluster.LbSubsetConfig.LbSubsetSelector.Builder,Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder> internalGetSubsetSelectorsFieldBuilder()
    • getLocalityWeightAware

      public boolean getLocalityWeightAware()
       If true, routing to subsets will take into account the localities and locality weights of the
       endpoints when making the routing decision.
      
       There are some potential pitfalls associated with enabling this feature, as the resulting
       traffic split after applying both a subset match and locality weights might be undesirable.
      
       Consider for example a situation in which you have 50/50 split across two localities X/Y
       which have 100 hosts each without subsetting. If the subset LB results in X having only 1
       host selected but Y having 100, then a lot more load is being dumped on the single host in X
       than originally anticipated in the load balancing assignment delivered via EDS.
       
      bool locality_weight_aware = 4;
      Specified by:
      getLocalityWeightAware in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      The localityWeightAware.
    • setLocalityWeightAware

      public Cluster.LbSubsetConfig.Builder setLocalityWeightAware(boolean value)
       If true, routing to subsets will take into account the localities and locality weights of the
       endpoints when making the routing decision.
      
       There are some potential pitfalls associated with enabling this feature, as the resulting
       traffic split after applying both a subset match and locality weights might be undesirable.
      
       Consider for example a situation in which you have 50/50 split across two localities X/Y
       which have 100 hosts each without subsetting. If the subset LB results in X having only 1
       host selected but Y having 100, then a lot more load is being dumped on the single host in X
       than originally anticipated in the load balancing assignment delivered via EDS.
       
      bool locality_weight_aware = 4;
      Parameters:
      value - The localityWeightAware to set.
      Returns:
      This builder for chaining.
    • clearLocalityWeightAware

      public Cluster.LbSubsetConfig.Builder clearLocalityWeightAware()
       If true, routing to subsets will take into account the localities and locality weights of the
       endpoints when making the routing decision.
      
       There are some potential pitfalls associated with enabling this feature, as the resulting
       traffic split after applying both a subset match and locality weights might be undesirable.
      
       Consider for example a situation in which you have 50/50 split across two localities X/Y
       which have 100 hosts each without subsetting. If the subset LB results in X having only 1
       host selected but Y having 100, then a lot more load is being dumped on the single host in X
       than originally anticipated in the load balancing assignment delivered via EDS.
       
      bool locality_weight_aware = 4;
      Returns:
      This builder for chaining.
    • getScaleLocalityWeight

      public boolean getScaleLocalityWeight()
       When used with locality_weight_aware, scales the weight of each locality by the ratio
       of hosts in the subset vs hosts in the original subset. This aims to even out the load
       going to an individual locality if said locality is disproportionately affected by the
       subset predicate.
       
      bool scale_locality_weight = 5;
      Specified by:
      getScaleLocalityWeight in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      The scaleLocalityWeight.
    • setScaleLocalityWeight

      public Cluster.LbSubsetConfig.Builder setScaleLocalityWeight(boolean value)
       When used with locality_weight_aware, scales the weight of each locality by the ratio
       of hosts in the subset vs hosts in the original subset. This aims to even out the load
       going to an individual locality if said locality is disproportionately affected by the
       subset predicate.
       
      bool scale_locality_weight = 5;
      Parameters:
      value - The scaleLocalityWeight to set.
      Returns:
      This builder for chaining.
    • clearScaleLocalityWeight

      public Cluster.LbSubsetConfig.Builder clearScaleLocalityWeight()
       When used with locality_weight_aware, scales the weight of each locality by the ratio
       of hosts in the subset vs hosts in the original subset. This aims to even out the load
       going to an individual locality if said locality is disproportionately affected by the
       subset predicate.
       
      bool scale_locality_weight = 5;
      Returns:
      This builder for chaining.
    • getPanicModeAny

      public boolean getPanicModeAny()
       If true, when a fallback policy is configured and its corresponding subset fails to find
       a host this will cause any host to be selected instead.
      
       This is useful when using the default subset as the fallback policy, given the default
       subset might become empty. With this option enabled, if that happens the LB will attempt
       to select a host from the entire cluster.
       
      bool panic_mode_any = 6;
      Specified by:
      getPanicModeAny in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      The panicModeAny.
    • setPanicModeAny

      public Cluster.LbSubsetConfig.Builder setPanicModeAny(boolean value)
       If true, when a fallback policy is configured and its corresponding subset fails to find
       a host this will cause any host to be selected instead.
      
       This is useful when using the default subset as the fallback policy, given the default
       subset might become empty. With this option enabled, if that happens the LB will attempt
       to select a host from the entire cluster.
       
      bool panic_mode_any = 6;
      Parameters:
      value - The panicModeAny to set.
      Returns:
      This builder for chaining.
    • clearPanicModeAny

      public Cluster.LbSubsetConfig.Builder clearPanicModeAny()
       If true, when a fallback policy is configured and its corresponding subset fails to find
       a host this will cause any host to be selected instead.
      
       This is useful when using the default subset as the fallback policy, given the default
       subset might become empty. With this option enabled, if that happens the LB will attempt
       to select a host from the entire cluster.
       
      bool panic_mode_any = 6;
      Returns:
      This builder for chaining.
    • getListAsAny

      public boolean getListAsAny()
       If true, metadata specified for a metadata key will be matched against the corresponding
       endpoint metadata if the endpoint metadata matches the value exactly OR it is a list value
       and any of the elements in the list matches the criteria.
       
      bool list_as_any = 7;
      Specified by:
      getListAsAny in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      The listAsAny.
    • setListAsAny

      public Cluster.LbSubsetConfig.Builder setListAsAny(boolean value)
       If true, metadata specified for a metadata key will be matched against the corresponding
       endpoint metadata if the endpoint metadata matches the value exactly OR it is a list value
       and any of the elements in the list matches the criteria.
       
      bool list_as_any = 7;
      Parameters:
      value - The listAsAny to set.
      Returns:
      This builder for chaining.
    • clearListAsAny

      public Cluster.LbSubsetConfig.Builder clearListAsAny()
       If true, metadata specified for a metadata key will be matched against the corresponding
       endpoint metadata if the endpoint metadata matches the value exactly OR it is a list value
       and any of the elements in the list matches the criteria.
       
      bool list_as_any = 7;
      Returns:
      This builder for chaining.
    • getMetadataFallbackPolicyValue

      public int getMetadataFallbackPolicyValue()
       Fallback mechanism that allows to try different route metadata until a host is found.
       If load balancing process, including all its mechanisms (like
       :ref:`fallback_policy<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.fallback_policy>`)
       fails to select a host, this policy decides if and how the process is repeated using another metadata.
      
       The value defaults to
       :ref:`METADATA_NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy.METADATA_NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy metadata_fallback_policy = 8 [(.validate.rules) = { ... }
      Specified by:
      getMetadataFallbackPolicyValue in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      The enum numeric value on the wire for metadataFallbackPolicy.
    • setMetadataFallbackPolicyValue

      public Cluster.LbSubsetConfig.Builder setMetadataFallbackPolicyValue(int value)
       Fallback mechanism that allows to try different route metadata until a host is found.
       If load balancing process, including all its mechanisms (like
       :ref:`fallback_policy<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.fallback_policy>`)
       fails to select a host, this policy decides if and how the process is repeated using another metadata.
      
       The value defaults to
       :ref:`METADATA_NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy.METADATA_NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy metadata_fallback_policy = 8 [(.validate.rules) = { ... }
      Parameters:
      value - The enum numeric value on the wire for metadataFallbackPolicy to set.
      Returns:
      This builder for chaining.
    • getMetadataFallbackPolicy

      public Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy getMetadataFallbackPolicy()
       Fallback mechanism that allows to try different route metadata until a host is found.
       If load balancing process, including all its mechanisms (like
       :ref:`fallback_policy<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.fallback_policy>`)
       fails to select a host, this policy decides if and how the process is repeated using another metadata.
      
       The value defaults to
       :ref:`METADATA_NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy.METADATA_NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy metadata_fallback_policy = 8 [(.validate.rules) = { ... }
      Specified by:
      getMetadataFallbackPolicy in interface Cluster.LbSubsetConfigOrBuilder
      Returns:
      The metadataFallbackPolicy.
    • setMetadataFallbackPolicy

       Fallback mechanism that allows to try different route metadata until a host is found.
       If load balancing process, including all its mechanisms (like
       :ref:`fallback_policy<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.fallback_policy>`)
       fails to select a host, this policy decides if and how the process is repeated using another metadata.
      
       The value defaults to
       :ref:`METADATA_NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy.METADATA_NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy metadata_fallback_policy = 8 [(.validate.rules) = { ... }
      Parameters:
      value - The metadataFallbackPolicy to set.
      Returns:
      This builder for chaining.
    • clearMetadataFallbackPolicy

      public Cluster.LbSubsetConfig.Builder clearMetadataFallbackPolicy()
       Fallback mechanism that allows to try different route metadata until a host is found.
       If load balancing process, including all its mechanisms (like
       :ref:`fallback_policy<envoy_v3_api_field_config.cluster.v3.Cluster.LbSubsetConfig.fallback_policy>`)
       fails to select a host, this policy decides if and how the process is repeated using another metadata.
      
       The value defaults to
       :ref:`METADATA_NO_FALLBACK<envoy_v3_api_enum_value_config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy.METADATA_NO_FALLBACK>`.
       
      .envoy.config.cluster.v3.Cluster.LbSubsetConfig.LbSubsetMetadataFallbackPolicy metadata_fallback_policy = 8 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.