io.zeebe.client.impl.workflow

Class GetWorkflowCommandImpl

java.lang.Object

io.zeebe.client.impl.workflow.GetWorkflowCommandImpl

All Implemented Interfaces:

FinalCommandStep<WorkflowResource>, WorkflowResourceRequestStep1, WorkflowResourceRequestStep1.WorkflowResourceRequestStep2, WorkflowResourceRequestStep1.WorkflowResourceRequestStep3

public class GetWorkflowCommandImpl
extends Object
implements WorkflowResourceRequestStep1, WorkflowResourceRequestStep1.WorkflowResourceRequestStep2, WorkflowResourceRequestStep1.WorkflowResourceRequestStep3

Nested Class Summary

Nested classes/interfaces inherited from interface io.zeebe.client.api.commands.WorkflowResourceRequestStep1

WorkflowResourceRequestStep1.WorkflowResourceRequestStep2, WorkflowResourceRequestStep1.WorkflowResourceRequestStep3

Field Summary

Fields inherited from interface io.zeebe.client.api.commands.WorkflowResourceRequestStep1

LATEST_VERSION

Constructor Summary

Constructors

Constructor and Description
GetWorkflowCommandImpl(GatewayGrpc.GatewayStub gatewayStub)

Method Summary

Modifier and Type	Method and Description
WorkflowResourceRequestStep1.WorkflowResourceRequestStep2	bpmnProcessId(String bpmnProcessId) Set the BPMN process id of the workflow to get the resource of.
WorkflowResourceRequestStep1.WorkflowResourceRequestStep3	latestVersion() Use the latest version of the workflow to get the resource of.
ZeebeFuture<WorkflowResource>	send() Sends the command to the Zeebe broker.
WorkflowResourceRequestStep1.WorkflowResourceRequestStep3	version(int version) Set the version of the workflow to get the resource of.
WorkflowResourceRequestStep1.WorkflowResourceRequestStep3	workflowKey(long workflowKey) Set the key of the workflow to get the resource of.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetWorkflowCommandImpl

public GetWorkflowCommandImpl(GatewayGrpc.GatewayStub gatewayStub)

Method Detail

bpmnProcessId

public WorkflowResourceRequestStep1.WorkflowResourceRequestStep2 bpmnProcessId(String bpmnProcessId)

Description copied from interface: WorkflowResourceRequestStep1

Set the BPMN process id of the workflow to get the resource of. This is the static id of the process in the BPMN XML (i.e. "<bpmn:process id='my-workflow'>").

Specified by:

bpmnProcessId in interface WorkflowResourceRequestStep1

Parameters:

bpmnProcessId - the BPMN process id of the workflow

Returns:

the builder for this request

workflowKey

public WorkflowResourceRequestStep1.WorkflowResourceRequestStep3 workflowKey(long workflowKey)

Description copied from interface: WorkflowResourceRequestStep1

Set the key of the workflow to get the resource of. The key is assigned by the broker while deploying the workflow. It can be picked from the deployment or workflow event.

Specified by:

workflowKey in interface WorkflowResourceRequestStep1

Parameters:

workflowKey - the key of the workflow

Returns:

the builder for this request

version

public WorkflowResourceRequestStep1.WorkflowResourceRequestStep3 version(int version)

Description copied from interface: WorkflowResourceRequestStep1.WorkflowResourceRequestStep2

Set the version of the workflow to get the resource of. The version is assigned by the broker while deploying the workflow. It can be picked from the deployment or workflow event.

Specified by:

version in interface WorkflowResourceRequestStep1.WorkflowResourceRequestStep2

Parameters:

version - the version of the workflow

Returns:

the builder for this request

latestVersion

public WorkflowResourceRequestStep1.WorkflowResourceRequestStep3 latestVersion()

Description copied from interface: WorkflowResourceRequestStep1.WorkflowResourceRequestStep2

Use the latest version of the workflow to get the resource of.

Specified by:

latestVersion in interface WorkflowResourceRequestStep1.WorkflowResourceRequestStep2

Returns:

the builder for this request

send

public ZeebeFuture<WorkflowResource> send()

Description copied from interface: FinalCommandStep

Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.

Call ZeebeFuture.join() to wait until the response is available.

 Future<JobEvent> future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<WorkflowResource>

Returns:

a future tracking state of success/failure of the command.