envoy.api.v2

Class Cds.Cluster.LbSubsetConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.api.v2.Cds.Cluster.LbSubsetConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cds.Cluster.LbSubsetConfigOrBuilder, Serializable

Enclosing class:

Cds.Cluster

public static final class Cds.Cluster.LbSubsetConfig
extends com.google.protobuf.GeneratedMessageV3
implements Cds.Cluster.LbSubsetConfigOrBuilder

 Optionally divide the endpoints in this cluster into subsets defined by
 endpoint metadata and selected by route and weighted cluster metadata.
 

Protobuf type envoy.api.v2.Cluster.LbSubsetConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cds.Cluster.LbSubsetConfig.Builder Optionally divide the endpoints in this cluster into subsets defined by endpoint metadata and selected by route and weighted cluster metadata.
static class	Cds.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy If NO_FALLBACK is selected, a result equivalent to no healthy hosts is reported.
static class	Cds.Cluster.LbSubsetConfig.LbSubsetSelector Specifications for subsets.
static interface	Cds.Cluster.LbSubsetConfig.LbSubsetSelectorOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SUBSET_FIELD_NUMBER
static int	FALLBACK_POLICY_FIELD_NUMBER
static int	SUBSET_SELECTORS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Cds.Cluster.LbSubsetConfig	getDefaultInstance()
Cds.Cluster.LbSubsetConfig	getDefaultInstanceForType()
com.google.protobuf.Struct	getDefaultSubset() Specifies the default subset of endpoints used during fallback if fallback_policy is :ref:`DEFAULT_SUBSET<envoy_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
com.google.protobuf.StructOrBuilder	getDefaultSubsetOrBuilder() Specifies the default subset of endpoints used during fallback if fallback_policy is :ref:`DEFAULT_SUBSET<envoy_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Cds.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy	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.
com.google.protobuf.Parser<Cds.Cluster.LbSubsetConfig>	getParserForType()
int	getSerializedSize()
Cds.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.
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.
List<Cds.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.
Cds.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.
List<? extends Cds.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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasDefaultSubset() Specifies the default subset of endpoints used during fallback if fallback_policy is :ref:`DEFAULT_SUBSET<envoy_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.DEFAULT_SUBSET>`.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Cds.Cluster.LbSubsetConfig.Builder	newBuilder()
static Cds.Cluster.LbSubsetConfig.Builder	newBuilder(Cds.Cluster.LbSubsetConfig prototype)
Cds.Cluster.LbSubsetConfig.Builder	newBuilderForType()
protected Cds.Cluster.LbSubsetConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Cds.Cluster.LbSubsetConfig	parseDelimitedFrom(InputStream input)
static Cds.Cluster.LbSubsetConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cds.Cluster.LbSubsetConfig	parseFrom(byte[] data)
static Cds.Cluster.LbSubsetConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cds.Cluster.LbSubsetConfig	parseFrom(ByteBuffer data)
static Cds.Cluster.LbSubsetConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cds.Cluster.LbSubsetConfig	parseFrom(com.google.protobuf.ByteString data)
static Cds.Cluster.LbSubsetConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cds.Cluster.LbSubsetConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Cds.Cluster.LbSubsetConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cds.Cluster.LbSubsetConfig	parseFrom(InputStream input)
static Cds.Cluster.LbSubsetConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Cds.Cluster.LbSubsetConfig>	parser()
Cds.Cluster.LbSubsetConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FALLBACK_POLICY_FIELD_NUMBER

public static final int FALLBACK_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_SUBSET_FIELD_NUMBER

public static final int DEFAULT_SUBSET_FIELD_NUMBER

See Also:

Constant Field Values

SUBSET_SELECTORS_FIELD_NUMBER

public static final int SUBSET_SELECTORS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
 

.envoy.api.v2.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy fallback_policy = 1 [(.validate.rules) = { ... }

Specified by:

getFallbackPolicyValue in interface Cds.Cluster.LbSubsetConfigOrBuilder

getFallbackPolicy

public Cds.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy getFallbackPolicy()

 The behavior used when no endpoint subset matches the selected route's
 metadata. The value defaults to
 :ref:`NO_FALLBACK<envoy_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
 

.envoy.api.v2.Cluster.LbSubsetConfig.LbSubsetFallbackPolicy fallback_policy = 1 [(.validate.rules) = { ... }

Specified by:

getFallbackPolicy in interface Cds.Cluster.LbSubsetConfigOrBuilder

hasDefaultSubset

public boolean hasDefaultSubset()

 Specifies the default subset of endpoints used during fallback if
 fallback_policy is
 :ref:`DEFAULT_SUBSET<envoy_api_enum_value_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_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
 

.google.protobuf.Struct default_subset = 2;

Specified by:

hasDefaultSubset in interface Cds.Cluster.LbSubsetConfigOrBuilder

getDefaultSubset

public com.google.protobuf.Struct getDefaultSubset()

 Specifies the default subset of endpoints used during fallback if
 fallback_policy is
 :ref:`DEFAULT_SUBSET<envoy_api_enum_value_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_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
 

.google.protobuf.Struct default_subset = 2;

Specified by:

getDefaultSubset in interface Cds.Cluster.LbSubsetConfigOrBuilder

getDefaultSubsetOrBuilder

public com.google.protobuf.StructOrBuilder getDefaultSubsetOrBuilder()

 Specifies the default subset of endpoints used during fallback if
 fallback_policy is
 :ref:`DEFAULT_SUBSET<envoy_api_enum_value_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_api_enum_value_Cluster.LbSubsetConfig.LbSubsetFallbackPolicy.NO_FALLBACK>`.
 

.google.protobuf.Struct default_subset = 2;

Specified by:

getDefaultSubsetOrBuilder in interface Cds.Cluster.LbSubsetConfigOrBuilder

getSubsetSelectorsList

public List<Cds.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.api.v2.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;

Specified by:

getSubsetSelectorsList in interface Cds.Cluster.LbSubsetConfigOrBuilder

getSubsetSelectorsOrBuilderList

public List<? extends Cds.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.api.v2.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;

Specified by:

getSubsetSelectorsOrBuilderList in interface Cds.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.api.v2.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;

Specified by:

getSubsetSelectorsCount in interface Cds.Cluster.LbSubsetConfigOrBuilder

getSubsetSelectors

public Cds.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.api.v2.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;

Specified by:

getSubsetSelectors in interface Cds.Cluster.LbSubsetConfigOrBuilder

getSubsetSelectorsOrBuilder

public Cds.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.api.v2.Cluster.LbSubsetConfig.LbSubsetSelector subset_selectors = 3;

Specified by:

getSubsetSelectorsOrBuilder in interface Cds.Cluster.LbSubsetConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(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 Cds.Cluster.LbSubsetConfig parseFrom(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cds.Cluster.LbSubsetConfig parseFrom(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cds.Cluster.LbSubsetConfig parseFrom(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cds.Cluster.LbSubsetConfig parseFrom(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cds.Cluster.LbSubsetConfig parseFrom(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cds.Cluster.LbSubsetConfig parseFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static Cds.Cluster.LbSubsetConfig parseFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cds.Cluster.LbSubsetConfig parseDelimitedFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cds.Cluster.LbSubsetConfig parseDelimitedFrom(InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseFrom

public static Cds.Cluster.LbSubsetConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static Cds.Cluster.LbSubsetConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

newBuilderForType

public Cds.Cluster.LbSubsetConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Cds.Cluster.LbSubsetConfig.Builder newBuilder()

newBuilder

public static Cds.Cluster.LbSubsetConfig.Builder newBuilder(Cds.Cluster.LbSubsetConfig prototype)

toBuilder

public Cds.Cluster.LbSubsetConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Cds.Cluster.LbSubsetConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Cds.Cluster.LbSubsetConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<Cds.Cluster.LbSubsetConfig> parser()

getParserForType

public com.google.protobuf.Parser<Cds.Cluster.LbSubsetConfig> 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.GeneratedMessageV3

getDefaultInstanceForType

public Cds.Cluster.LbSubsetConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder