Package io.zeebe.client.impl.command

Class CancelWorkflowInstanceCommandImpl

java.lang.Object

io.zeebe.client.impl.command.CancelWorkflowInstanceCommandImpl

All Implemented Interfaces:

CancelWorkflowInstanceCommandStep1, FinalCommandStep<CancelWorkflowInstanceResponse>

public final class CancelWorkflowInstanceCommandImpl
extends Object
implements CancelWorkflowInstanceCommandStep1

Constructor Summary

Constructors

Constructor	Description
CancelWorkflowInstanceCommandImpl(GatewayGrpc.GatewayStub asyncStub, long workflowInstanceKey, Duration requestTimeout, Predicate<Throwable> retryPredicate)

Method Summary

Modifier and Type	Method	Description
FinalCommandStep<CancelWorkflowInstanceResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<CancelWorkflowInstanceResponse>	send()	Sends the command to the Zeebe broker.

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelWorkflowInstanceCommandImpl

public CancelWorkflowInstanceCommandImpl(GatewayGrpc.GatewayStub asyncStub,
                                         long workflowInstanceKey,
                                         Duration requestTimeout,
                                         Predicate<Throwable> retryPredicate)

Method Detail

requestTimeout

public FinalCommandStep<CancelWorkflowInstanceResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using ZeebeClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<CancelWorkflowInstanceResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<CancelWorkflowInstanceResponse> 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<CancelWorkflowInstanceResponse>

Returns:

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