io.envoyproxy.envoy.admin.v2alpha

Class ClustersConfigDump

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.admin.v2alpha.ClustersConfigDump

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClustersConfigDumpOrBuilder, Serializable

public final class ClustersConfigDump
extends com.google.protobuf.GeneratedMessageV3
implements ClustersConfigDumpOrBuilder

 Envoy's cluster manager fills this message with all currently known clusters. Cluster
 configuration information can be used to recreate an Envoy configuration by populating all
 clusters as static clusters or by returning them in a CDS response.
 

Protobuf type envoy.admin.v2alpha.ClustersConfigDump

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClustersConfigDump.Builder Envoy's cluster manager fills this message with all currently known clusters.
static class	ClustersConfigDump.DynamicCluster Describes a dynamically loaded cluster via the CDS API.
static interface	ClustersConfigDump.DynamicClusterOrBuilder
static class	ClustersConfigDump.StaticCluster Describes a statically loaded cluster.
static interface	ClustersConfigDump.StaticClusterOrBuilder

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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	DYNAMIC_ACTIVE_CLUSTERS_FIELD_NUMBER
static int	DYNAMIC_WARMING_CLUSTERS_FIELD_NUMBER
static int	STATIC_CLUSTERS_FIELD_NUMBER
static int	VERSION_INFO_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 ClustersConfigDump	getDefaultInstance()
ClustersConfigDump	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ClustersConfigDump.DynamicCluster	getDynamicActiveClusters(int index) The dynamically loaded active clusters.
int	getDynamicActiveClustersCount() The dynamically loaded active clusters.
List<ClustersConfigDump.DynamicCluster>	getDynamicActiveClustersList() The dynamically loaded active clusters.
ClustersConfigDump.DynamicClusterOrBuilder	getDynamicActiveClustersOrBuilder(int index) The dynamically loaded active clusters.
List<? extends ClustersConfigDump.DynamicClusterOrBuilder>	getDynamicActiveClustersOrBuilderList() The dynamically loaded active clusters.
ClustersConfigDump.DynamicCluster	getDynamicWarmingClusters(int index) The dynamically loaded warming clusters.
int	getDynamicWarmingClustersCount() The dynamically loaded warming clusters.
List<ClustersConfigDump.DynamicCluster>	getDynamicWarmingClustersList() The dynamically loaded warming clusters.
ClustersConfigDump.DynamicClusterOrBuilder	getDynamicWarmingClustersOrBuilder(int index) The dynamically loaded warming clusters.
List<? extends ClustersConfigDump.DynamicClusterOrBuilder>	getDynamicWarmingClustersOrBuilderList() The dynamically loaded warming clusters.
com.google.protobuf.Parser<ClustersConfigDump>	getParserForType()
int	getSerializedSize()
ClustersConfigDump.StaticCluster	getStaticClusters(int index) The statically loaded cluster configs.
int	getStaticClustersCount() The statically loaded cluster configs.
List<ClustersConfigDump.StaticCluster>	getStaticClustersList() The statically loaded cluster configs.
ClustersConfigDump.StaticClusterOrBuilder	getStaticClustersOrBuilder(int index) The statically loaded cluster configs.
List<? extends ClustersConfigDump.StaticClusterOrBuilder>	getStaticClustersOrBuilderList() The statically loaded cluster configs.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getVersionInfo() This is the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` in the last processed CDS discovery response.
com.google.protobuf.ByteString	getVersionInfoBytes() This is the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` in the last processed CDS discovery response.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ClustersConfigDump.Builder	newBuilder()
static ClustersConfigDump.Builder	newBuilder(ClustersConfigDump prototype)
ClustersConfigDump.Builder	newBuilderForType()
protected ClustersConfigDump.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ClustersConfigDump	parseDelimitedFrom(InputStream input)
static ClustersConfigDump	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClustersConfigDump	parseFrom(byte[] data)
static ClustersConfigDump	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClustersConfigDump	parseFrom(ByteBuffer data)
static ClustersConfigDump	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClustersConfigDump	parseFrom(com.google.protobuf.ByteString data)
static ClustersConfigDump	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClustersConfigDump	parseFrom(com.google.protobuf.CodedInputStream input)
static ClustersConfigDump	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClustersConfigDump	parseFrom(InputStream input)
static ClustersConfigDump	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ClustersConfigDump>	parser()
ClustersConfigDump.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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

VERSION_INFO_FIELD_NUMBER

public static final int VERSION_INFO_FIELD_NUMBER

See Also:

Constant Field Values

STATIC_CLUSTERS_FIELD_NUMBER

public static final int STATIC_CLUSTERS_FIELD_NUMBER

See Also:

Constant Field Values

DYNAMIC_ACTIVE_CLUSTERS_FIELD_NUMBER

public static final int DYNAMIC_ACTIVE_CLUSTERS_FIELD_NUMBER

See Also:

Constant Field Values

DYNAMIC_WARMING_CLUSTERS_FIELD_NUMBER

public static final int DYNAMIC_WARMING_CLUSTERS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getVersionInfo

public String getVersionInfo()

 This is the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` in the
 last processed CDS discovery response. If there are only static bootstrap clusters, this field
 will be "".
 

string version_info = 1;

Specified by:

getVersionInfo in interface ClustersConfigDumpOrBuilder

getVersionInfoBytes

public com.google.protobuf.ByteString getVersionInfoBytes()

 This is the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` in the
 last processed CDS discovery response. If there are only static bootstrap clusters, this field
 will be "".
 

string version_info = 1;

Specified by:

getVersionInfoBytes in interface ClustersConfigDumpOrBuilder

getStaticClustersList

public List<ClustersConfigDump.StaticCluster> getStaticClustersList()

 The statically loaded cluster configs.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.StaticCluster static_clusters = 2;

Specified by:

getStaticClustersList in interface ClustersConfigDumpOrBuilder

getStaticClustersOrBuilderList

public List<? extends ClustersConfigDump.StaticClusterOrBuilder> getStaticClustersOrBuilderList()

 The statically loaded cluster configs.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.StaticCluster static_clusters = 2;

Specified by:

getStaticClustersOrBuilderList in interface ClustersConfigDumpOrBuilder

getStaticClustersCount

public int getStaticClustersCount()

 The statically loaded cluster configs.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.StaticCluster static_clusters = 2;

Specified by:

getStaticClustersCount in interface ClustersConfigDumpOrBuilder

getStaticClusters

public ClustersConfigDump.StaticCluster getStaticClusters(int index)

 The statically loaded cluster configs.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.StaticCluster static_clusters = 2;

Specified by:

getStaticClusters in interface ClustersConfigDumpOrBuilder

getStaticClustersOrBuilder

public ClustersConfigDump.StaticClusterOrBuilder getStaticClustersOrBuilder(int index)

 The statically loaded cluster configs.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.StaticCluster static_clusters = 2;

Specified by:

getStaticClustersOrBuilder in interface ClustersConfigDumpOrBuilder

getDynamicActiveClustersList

public List<ClustersConfigDump.DynamicCluster> getDynamicActiveClustersList()

 The dynamically loaded active clusters. These are clusters that are available to service
 data plane traffic.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;

Specified by:

getDynamicActiveClustersList in interface ClustersConfigDumpOrBuilder

getDynamicActiveClustersOrBuilderList

public List<? extends ClustersConfigDump.DynamicClusterOrBuilder> getDynamicActiveClustersOrBuilderList()

 The dynamically loaded active clusters. These are clusters that are available to service
 data plane traffic.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;

Specified by:

getDynamicActiveClustersOrBuilderList in interface ClustersConfigDumpOrBuilder

getDynamicActiveClustersCount

public int getDynamicActiveClustersCount()

 The dynamically loaded active clusters. These are clusters that are available to service
 data plane traffic.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;

Specified by:

getDynamicActiveClustersCount in interface ClustersConfigDumpOrBuilder

getDynamicActiveClusters

public ClustersConfigDump.DynamicCluster getDynamicActiveClusters(int index)

 The dynamically loaded active clusters. These are clusters that are available to service
 data plane traffic.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;

Specified by:

getDynamicActiveClusters in interface ClustersConfigDumpOrBuilder

getDynamicActiveClustersOrBuilder

public ClustersConfigDump.DynamicClusterOrBuilder getDynamicActiveClustersOrBuilder(int index)

 The dynamically loaded active clusters. These are clusters that are available to service
 data plane traffic.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;

Specified by:

getDynamicActiveClustersOrBuilder in interface ClustersConfigDumpOrBuilder

getDynamicWarmingClustersList

public List<ClustersConfigDump.DynamicCluster> getDynamicWarmingClustersList()

 The dynamically loaded warming clusters. These are clusters that are currently undergoing
 warming in preparation to service data plane traffic. Note that if attempting to recreate an
 Envoy configuration from a configuration dump, the warming clusters should generally be
 discarded.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;

Specified by:

getDynamicWarmingClustersList in interface ClustersConfigDumpOrBuilder

getDynamicWarmingClustersOrBuilderList

public List<? extends ClustersConfigDump.DynamicClusterOrBuilder> getDynamicWarmingClustersOrBuilderList()

 The dynamically loaded warming clusters. These are clusters that are currently undergoing
 warming in preparation to service data plane traffic. Note that if attempting to recreate an
 Envoy configuration from a configuration dump, the warming clusters should generally be
 discarded.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;

Specified by:

getDynamicWarmingClustersOrBuilderList in interface ClustersConfigDumpOrBuilder

getDynamicWarmingClustersCount

public int getDynamicWarmingClustersCount()

 The dynamically loaded warming clusters. These are clusters that are currently undergoing
 warming in preparation to service data plane traffic. Note that if attempting to recreate an
 Envoy configuration from a configuration dump, the warming clusters should generally be
 discarded.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;

Specified by:

getDynamicWarmingClustersCount in interface ClustersConfigDumpOrBuilder

getDynamicWarmingClusters

public ClustersConfigDump.DynamicCluster getDynamicWarmingClusters(int index)

 The dynamically loaded warming clusters. These are clusters that are currently undergoing
 warming in preparation to service data plane traffic. Note that if attempting to recreate an
 Envoy configuration from a configuration dump, the warming clusters should generally be
 discarded.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;

Specified by:

getDynamicWarmingClusters in interface ClustersConfigDumpOrBuilder

getDynamicWarmingClustersOrBuilder

public ClustersConfigDump.DynamicClusterOrBuilder getDynamicWarmingClustersOrBuilder(int index)

 The dynamically loaded warming clusters. These are clusters that are currently undergoing
 warming in preparation to service data plane traffic. Note that if attempting to recreate an
 Envoy configuration from a configuration dump, the warming clusters should generally be
 discarded.
 

repeated .envoy.admin.v2alpha.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;

Specified by:

getDynamicWarmingClustersOrBuilder in interface ClustersConfigDumpOrBuilder

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 ClustersConfigDump parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClustersConfigDump parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClustersConfigDump parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ClustersConfigDump parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ClustersConfigDump parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static ClustersConfigDump parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ClustersConfigDump.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ClustersConfigDump.Builder newBuilder()

newBuilder

public static ClustersConfigDump.Builder newBuilder(ClustersConfigDump prototype)

toBuilder

public ClustersConfigDump.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ClustersConfigDump.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ClustersConfigDump getDefaultInstance()

parser

public static com.google.protobuf.Parser<ClustersConfigDump> parser()

getParserForType

public com.google.protobuf.Parser<ClustersConfigDump> 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 ClustersConfigDump getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder