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

Interface GatewayHealthActuator

All Superinterfaces:

HealthActuator

public interface GatewayHealthActuator
extends HealthActuator

Java interface for the broker's health endpoints. 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.

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.zeebe.qa.util.actuator.HealthActuator

HealthActuator.NoopHealthActuator

Method Summary

Modifier and Type	Method	Description
void	live()	Succeeds if the node is live.
static GatewayHealthActuator	of(TestGateway<?> node)	Returns a GatewayHealthActuator instance using the given node as upstream.
static GatewayHealthActuator	of(io.zeebe.containers.ZeebeNode<?> node)	Returns a GatewayHealthActuator instance using the given node as upstream.
static GatewayHealthActuator	of(String endpoint)	Returns a GatewayHealthActuator instance using the given endpoint as upstream.
void	ready()	Succeeds if the node is ready.
void	startup()	Succeeds if the node is started.

Method Details

of

static GatewayHealthActuator of(io.zeebe.containers.ZeebeNode<?> node)

Returns a GatewayHealthActuator instance using the given node as upstream.

Parameters:

node - the node to connect to

Returns:

a new instance of GatewayHealthActuator

of

static GatewayHealthActuator of(TestGateway<?> node)

Returns a GatewayHealthActuator instance using the given node as upstream.

Parameters:

node - the node to connect to

Returns:

a new instance of GatewayHealthActuator

of

static GatewayHealthActuator of(String endpoint)

Returns a GatewayHealthActuator instance using the given endpoint as upstream. The endpoint is expected to be a complete absolute URL, e.g. "http://localhost:9600/".

Parameters:

endpoint - the actuator URL to connect to

Returns:

a new instance of GatewayHealthActuator

ready

void ready()

Description copied from interface: HealthActuator

Succeeds if the node is ready.

Specified by:

ready in interface HealthActuator

startup

void startup()

Description copied from interface: HealthActuator

Succeeds if the node is started.

Specified by:

startup in interface HealthActuator

live

void live()

Description copied from interface: HealthActuator

Succeeds if the node is live.

Specified by:

live in interface HealthActuator