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:

  • Field Details

  • 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 class com.google.protobuf.GeneratedMessage

    • 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.

    • getStaticClustersList

      public List<ClustersConfigDump.StaticCluster> getStaticClustersList()
       The statically loaded cluster configs.
      repeated .envoy.admin.v3.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.v3.ClustersConfigDump.StaticCluster static_clusters = 2;
      Specified by:
      getStaticClustersOrBuilderList in interface ClustersConfigDumpOrBuilder

    • getStaticClustersCount

      public int getStaticClustersCount()
       The statically loaded cluster configs.
      repeated .envoy.admin.v3.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.v3.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.v3.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.v3.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.v3.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.v3.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.v3.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.v3.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.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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public ClustersConfigDump getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder