Package io.camunda.zeebe.qa.util.actuator

Interface BackupActuator

public interface BackupActuator
Java interface for the node's backup actuator. To instantiate this interface, you can use Feign; see of(String) as an example.

You can use one of of(String) or of(ZeebeNode) to create a new client to use for yourself.

  • Method Details

    • of

      static BackupActuator of(io.zeebe.containers.ZeebeNode<?> node)
      Returns a BackupActuator instance using the given node as upstream.
      Parameters:
      node - the node to connect to
      Returns:
      a new instance of BackupActuator

    • ofAddress

      static BackupActuator ofAddress(String address)
      Returns a BackupActuator instance using the given node as upstream.
      Parameters:
      address - the monitoring address
      Returns:
      a new instance of BackupActuator

    • of

      static BackupActuator of(TestApplication<?> node)
      Returns a BackupActuator instance using the given node as upstream.
      Parameters:
      node - the node to connect to
      Returns:
      a new instance of BackupActuator

    • of

      static BackupActuator of(String endpoint)
      Returns a BackupActuator instance using the given endpoint as upstream. The endpoint is expected to be a complete absolute URL, e.g. "http://localhost:9600/actuator/backups".
      Parameters:
      endpoint - the actuator URL to connect to
      Returns:
      a new instance of BackupActuator

    • take

      TakeBackupResponse take(long backupId)
      Triggers taking a backup of the cluster.
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)

    • status

      BackupInfo status(long id)

    • list

      List<BackupInfo> list()

    • delete

      void delete(long id)