Package io.envoyproxy.envoy.admin.v3

Class 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.v3.ClustersConfigDump
    See Also:
    Serialized Form

    • 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_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 interface ClustersConfigDumpOrBuilder
        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 interface ClustersConfigDumpOrBuilder
        Returns:
        The bytes for versionInfo.

      • getStaticClustersCount

        public int getStaticClustersCount()
         The statically loaded cluster configs.
        repeated .envoy.admin.v3.ClustersConfigDump.StaticCluster static_clusters = 2;
        Specified by:
        getStaticClustersCount 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.v3.ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3;
        Specified by:
        getDynamicActiveClustersCount 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.v3.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.v3.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.v3.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.v3.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.v3.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​(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

      • 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

      • 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