Interface ClusterActuator


public interface ClusterActuator
  • Method Details

    • of

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

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

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

      static ClusterActuator of(String endpoint)
      Returns a ClusterActuator instance using the given endpoint as upstream.
      Parameters:
      endpoint - the endpoint to connect to
      Returns:
      a new instance of ClusterActuator
    • joinPartition

      PlannedOperationsResponse joinPartition(int brokerId, int partitionId, int priority)
      Request that the broker joins the partition with the given priority.
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)
    • leavePartition

      PlannedOperationsResponse leavePartition(int brokerId, int partitionId)
      Request that the broker leaves the partition.
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)
    • getTopology

      GetTopologyResponse getTopology()
      Queries the current cluster topology
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)
    • scaleBrokers

      Scales the given brokers up or down and reassigns partitions to the new brokers.
      Parameters:
      ids -
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)
    • scaleBrokers

      PlannedOperationsResponse scaleBrokers(List<Integer> ids, int newReplicationFactor)
      Scales the given brokers up or down and reassigns partitions to the new brokers based on new replication factor.
      Parameters:
      ids -
      newReplicationFactor - new replication factor after scaling, if invalid input: '<'=0 use the current value
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)
    • scaleBrokers

      PlannedOperationsResponse scaleBrokers(List<Integer> ids, boolean dryRun)
      Scales the given brokers up or down and reassigns partitions to the new brokers.
      Parameters:
      dryRun - if true, changes are not applied but only simulated.
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)
    • scaleBrokers

      PlannedOperationsResponse scaleBrokers(List<Integer> ids, boolean dryRun, boolean force)
      Scales the given brokers up or down and reassigns partitions to the new brokers.
      Parameters:
      dryRun - if true, changes are not applied but only simulated.
      force - if true, the brokers that are not specified will be forcely removed.
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)
    • addBroker

      PlannedOperationsResponse addBroker(int brokerId)
      Request that the broker is added to the cluster.
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)
    • removeBroker

      PlannedOperationsResponse removeBroker(int brokerId)
      Request that the broker is removed from the cluster
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)
    • cancelChange

      GetTopologyResponse cancelChange(long changeId)
    • scaleBrokersInvalidType

      PlannedOperationsResponse scaleBrokersInvalidType(List<String> ids)
    • addBrokerInvalidType

      PlannedOperationsResponse addBrokerInvalidType(String brokerId)
      Request that the broker is added to the cluster.
      Throws:
      feign.FeignException - if the request is not successful (e.g. 4xx or 5xx)