Interface PartitionsActuator
public interface PartitionsActuator
Java interface for the broker's partitions actuator (roughly mapping to the broker admin
service). To instantiate this interface, you can use
Feign; see of(String) as an
example.
You can use one of of(String) or of(ZeebeBrokerNode) to create a new client
to use for yourself.
Adding a new method is simple: simply define the input/output here as you normally would, and
make sure to add the correct JSON encoding headers (`Accept` for the response type,
`Content-Type` if there's a body to send). See LoggersActuator for a more complete
example.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic PartitionsActuatorof(TestStandaloneBroker node) Returns aPartitionsActuatorinstance using the given node as upstream.static PartitionsActuatorof(io.zeebe.containers.ZeebeBrokerNode<?> node) Returns aPartitionsActuatorinstance using the given node as upstream.static PartitionsActuatorReturns aPartitionsActuatorinstance using the given endpoint as upstream.query()
-
Method Details
-
of
Returns aPartitionsActuatorinstance using the given node as upstream. This only acceptsZeebeBrokerNodeat the moment, as only the broker has this actuator. It can be changed if we move these to the gateway.- Parameters:
node- the node to connect to- Returns:
- a new instance of
PartitionsActuator
-
of
Returns aPartitionsActuatorinstance using the given node as upstream. This only acceptsTestStandaloneBrokerat the moment, as only the broker has this actuator. It can be changed if we move these to the gateway.- Parameters:
node- the node to connect to- Returns:
- a new instance of
PartitionsActuator
-
of
Returns aPartitionsActuatorinstance using the given endpoint as upstream. The endpoint is expected to be a complete absolute URL, e.g. "http://localhost:9600/actuator/partitions".- Parameters:
endpoint- the actuator URL to connect to- Returns:
- a new instance of
PartitionsActuator
-
query
Map<Integer,PartitionsActuator.PartitionStatus> query() -
pauseExporting
Map<Integer,PartitionsActuator.PartitionStatus> pauseExporting() -
softPauseExporting
Map<Integer,PartitionsActuator.PartitionStatus> softPauseExporting() -
resumeExporting
Map<Integer,PartitionsActuator.PartitionStatus> resumeExporting() -
pauseProcessing
Map<Integer,PartitionsActuator.PartitionStatus> pauseProcessing() -
resumeProcessing
Map<Integer,PartitionsActuator.PartitionStatus> resumeProcessing() -
takeSnapshot
Map<Integer,PartitionsActuator.PartitionStatus> takeSnapshot() -
prepareUpgrade
Map<Integer,PartitionsActuator.PartitionStatus> prepareUpgrade()
-