Package io.camunda.zeebe.broker.system.management

Interface BrokerAdminService

All Known Implementing Classes:
BrokerAdminServiceImpl
public interface BrokerAdminService

  • Method Details

    • pauseStreamProcessing

      void pauseStreamProcessing()
      Request a partition to pause its StreamProcessor

    • resumeStreamProcessing

      void resumeStreamProcessing()
      Request a partition to resume its StreamProcessor

    • pauseExporting

      void pauseExporting()
      Request a partition to pause exporting

    • resumeExporting

      void resumeExporting()
      Request a partition to resume exporting

    • takeSnapshot

      void takeSnapshot()
      Trigger a snapshot. Partition will attempt to take a snapshot instead of waiting for the snapshot interval.

    • prepareForUpgrade

      void prepareForUpgrade()
      Prepares for upgrade by pausing stream processors and triggering snapshots. It is not normally required to call this before every upgrade. However, this is useful as an upgrade procedure to mitigate the effects of some known bugs.

    • getPartitionStatus

      Map<Integer,PartitionStatus> getPartitionStatus()
      Returns PartitionStatus of all partitions running on this broker.
      Returns:
      a map of partition id and partition status