Package io.camunda.zeebe.gateway.query.impl

Class QueryApiImpl

java.lang.Object

io.camunda.zeebe.gateway.query.impl.QueryApiImpl

All Implemented Interfaces:

QueryApi

public final class QueryApiImpl
extends Object
implements QueryApi

Constructor Summary

Constructors

Constructor	Description
QueryApiImpl(BrokerClient client)

Method Summary

Modifier and Type	Method	Description
CompletionStage<String>	getBpmnProcessIdFromJob(long key, Duration timeout)	Looks up the job identified by the given key, and returns the BPMN process ID associated with its process instance.
CompletionStage<String>	getBpmnProcessIdFromProcess(long key, Duration timeout)	Looks up the process definition from the given key, and returns its BPMN process ID.
CompletionStage<String>	getBpmnProcessIdFromProcessInstance(long key, Duration timeout)	Looks up the process instance identified by the given key, and returns the BPMN process ID of its process definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QueryApiImpl

public QueryApiImpl(BrokerClient client)

Method Details

getBpmnProcessIdFromProcess

public CompletionStage<String> getBpmnProcessIdFromProcess(long key,
 Duration timeout)

Description copied from interface: QueryApi

Looks up the process definition from the given key, and returns its BPMN process ID. The key should be the one obtained via the deployment command for the given process.

After timeout duration, the returned future is completed exceptionally with a TimeoutException.

Specified by:

getBpmnProcessIdFromProcess in interface QueryApi

Parameters:

key - the process definition key

timeout - the maximum duration to wait for until the request is completed

Returns:

the process ID of the process definition identified by the given key

getBpmnProcessIdFromProcessInstance

public CompletionStage<String> getBpmnProcessIdFromProcessInstance(long key,
 Duration timeout)

Description copied from interface: QueryApi

Looks up the process instance identified by the given key, and returns the BPMN process ID of its process definition. The key should be the one obtained via the instance creation command.

After timeout duration, the returned future is completed exceptionally with a TimeoutException.

Specified by:

getBpmnProcessIdFromProcessInstance in interface QueryApi

Parameters:

key - the process instance key

timeout - the maximum duration to wait for until the request is completed

Returns:

the process ID associated with the process instance identified by the given key

getBpmnProcessIdFromJob

public CompletionStage<String> getBpmnProcessIdFromJob(long key,
 Duration timeout)

Description copied from interface: QueryApi

Looks up the job identified by the given key, and returns the BPMN process ID associated with its process instance. The key should be the one obtained one of the job commands, e.g. job activation.

After timeout duration, the returned future is completed exceptionally with a TimeoutException.

Specified by:

getBpmnProcessIdFromJob in interface QueryApi

Parameters:

key - the job key

timeout - the maximum duration to wait for until the request is completed

Returns:

the process ID associated with the job identified by the given key