Package io.envoyproxy.envoy.admin.v3
Class ClustersConfigDump
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.admin.v3.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.GeneratedMessage
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.v3.ClustersConfigDump
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Envoy's cluster manager fills this message with all currently known clusters.static final class
Describes a dynamically loaded cluster via the CDS API.static interface
static final class
Describes a statically loaded cluster.static interface
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ClustersConfigDump
static final int
static final int
private List
<ClustersConfigDump.DynamicCluster> private List
<ClustersConfigDump.DynamicCluster> private byte
private static final com.google.protobuf.Parser
<ClustersConfigDump> private static final long
static final int
private List
<ClustersConfigDump.StaticCluster> static final int
private Object
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
ClustersConfigDump
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static ClustersConfigDump
static final com.google.protobuf.Descriptors.Descriptor
getDynamicActiveClusters
(int index) The dynamically loaded active clusters.int
The dynamically loaded active clusters.The dynamically loaded active clusters.getDynamicActiveClustersOrBuilder
(int index) The dynamically loaded active clusters.List
<? extends ClustersConfigDump.DynamicClusterOrBuilder> The dynamically loaded active clusters.getDynamicWarmingClusters
(int index) The dynamically loaded warming clusters.int
The dynamically loaded warming clusters.The dynamically loaded warming clusters.getDynamicWarmingClustersOrBuilder
(int index) The dynamically loaded warming clusters.List
<? extends ClustersConfigDump.DynamicClusterOrBuilder> The dynamically loaded warming clusters.com.google.protobuf.Parser
<ClustersConfigDump> int
getStaticClusters
(int index) The statically loaded cluster configs.int
The statically loaded cluster configs.The statically loaded cluster configs.getStaticClustersOrBuilder
(int index) The statically loaded cluster configs.List
<? extends ClustersConfigDump.StaticClusterOrBuilder> The statically loaded cluster configs.This is the :ref:`version_info <envoy_v3_api_field_service.discovery.v3.DiscoveryResponse.version_info>` in the last processed CDS discovery response.com.google.protobuf.ByteString
This is the :ref:`version_info <envoy_v3_api_field_service.discovery.v3.DiscoveryResponse.version_info>` in the last processed CDS discovery response.int
hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static ClustersConfigDump.Builder
static ClustersConfigDump.Builder
newBuilder
(ClustersConfigDump prototype) protected ClustersConfigDump.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) 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
(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 ClustersConfigDump
parseFrom
(ByteBuffer data) static ClustersConfigDump
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<ClustersConfigDump> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
VERSION_INFO_FIELD_NUMBER
public static final int VERSION_INFO_FIELD_NUMBER- See Also:
-
versionInfo_
-
STATIC_CLUSTERS_FIELD_NUMBER
public static final int STATIC_CLUSTERS_FIELD_NUMBER- See Also:
-
staticClusters_
-
DYNAMIC_ACTIVE_CLUSTERS_FIELD_NUMBER
public static final int DYNAMIC_ACTIVE_CLUSTERS_FIELD_NUMBER- See Also:
-
dynamicActiveClusters_
-
DYNAMIC_WARMING_CLUSTERS_FIELD_NUMBER
public static final int DYNAMIC_WARMING_CLUSTERS_FIELD_NUMBER- See Also:
-
dynamicWarmingClusters_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
ClustersConfigDump
private ClustersConfigDump(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
ClustersConfigDump
private ClustersConfigDump()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getVersionInfo
This is the :ref:`version_info <envoy_v3_api_field_service.discovery.v3.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 interfaceClustersConfigDumpOrBuilder
- Returns:
- The versionInfo.
-
getVersionInfoBytes
public com.google.protobuf.ByteString getVersionInfoBytes()This is the :ref:`version_info <envoy_v3_api_field_service.discovery.v3.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 interfaceClustersConfigDumpOrBuilder
- Returns:
- The bytes for versionInfo.
-
getStaticClustersList
The statically loaded cluster configs.
repeated .envoy.admin.v3.ClustersConfigDump.StaticCluster static_clusters = 2;
- Specified by:
getStaticClustersList
in interfaceClustersConfigDumpOrBuilder
-
getStaticClustersOrBuilderList
The statically loaded cluster configs.
repeated .envoy.admin.v3.ClustersConfigDump.StaticCluster static_clusters = 2;
- Specified by:
getStaticClustersOrBuilderList
in interfaceClustersConfigDumpOrBuilder
-
getStaticClustersCount
public int getStaticClustersCount()The statically loaded cluster configs.
repeated .envoy.admin.v3.ClustersConfigDump.StaticCluster static_clusters = 2;
- Specified by:
getStaticClustersCount
in interfaceClustersConfigDumpOrBuilder
-
getStaticClusters
The statically loaded cluster configs.
repeated .envoy.admin.v3.ClustersConfigDump.StaticCluster static_clusters = 2;
- Specified by:
getStaticClusters
in interfaceClustersConfigDumpOrBuilder
-
getStaticClustersOrBuilder
The statically loaded cluster configs.
repeated .envoy.admin.v3.ClustersConfigDump.StaticCluster static_clusters = 2;
- Specified by:
getStaticClustersOrBuilder
in interfaceClustersConfigDumpOrBuilder
-
getDynamicActiveClustersList
The dynamically loaded active clusters. These are clusters that are available to service data plane traffic.
repeated .envoy.admin.v3.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;
- Specified by:
getDynamicActiveClustersList
in interfaceClustersConfigDumpOrBuilder
-
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.v3.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;
- Specified by:
getDynamicActiveClustersOrBuilderList
in interfaceClustersConfigDumpOrBuilder
-
getDynamicActiveClustersCount
public int getDynamicActiveClustersCount()The dynamically loaded active clusters. These are clusters that are available to service data plane traffic.
repeated .envoy.admin.v3.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;
- Specified by:
getDynamicActiveClustersCount
in interfaceClustersConfigDumpOrBuilder
-
getDynamicActiveClusters
The dynamically loaded active clusters. These are clusters that are available to service data plane traffic.
repeated .envoy.admin.v3.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;
- Specified by:
getDynamicActiveClusters
in interfaceClustersConfigDumpOrBuilder
-
getDynamicActiveClustersOrBuilder
The dynamically loaded active clusters. These are clusters that are available to service data plane traffic.
repeated .envoy.admin.v3.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;
- Specified by:
getDynamicActiveClustersOrBuilder
in interfaceClustersConfigDumpOrBuilder
-
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.v3.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;
- Specified by:
getDynamicWarmingClustersList
in interfaceClustersConfigDumpOrBuilder
-
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.v3.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;
- Specified by:
getDynamicWarmingClustersOrBuilderList
in interfaceClustersConfigDumpOrBuilder
-
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.v3.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;
- Specified by:
getDynamicWarmingClustersCount
in interfaceClustersConfigDumpOrBuilder
-
getDynamicWarmingClusters
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.v3.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;
- Specified by:
getDynamicWarmingClusters
in interfaceClustersConfigDumpOrBuilder
-
getDynamicWarmingClustersOrBuilder
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.v3.ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4;
- Specified by:
getDynamicWarmingClustersOrBuilder
in interfaceClustersConfigDumpOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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
- Throws:
IOException
-
parseFrom
public static ClustersConfigDump parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ClustersConfigDump.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-