Package io.camunda.zeebe.client.impl.command

Class CancelProcessInstanceCommandImpl

java.lang.Object

io.camunda.zeebe.client.impl.command.CancelProcessInstanceCommandImpl

All Implemented Interfaces:

CancelProcessInstanceCommandStep1, CommandWithCommunicationApiStep<CancelProcessInstanceCommandStep1>, CommandWithOperationReferenceStep<CancelProcessInstanceCommandStep1>, FinalCommandStep<CancelProcessInstanceResponse>

public final class CancelProcessInstanceCommandImpl
extends Object
implements CancelProcessInstanceCommandStep1

Constructor Summary

Constructors

Constructor	Description
CancelProcessInstanceCommandImpl(GatewayGrpc.GatewayStub asyncStub, long processInstanceKey, Predicate<CredentialsProvider.StatusCode> retryPredicate, HttpClient httpClient, ZeebeClientConfiguration config, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
CancelProcessInstanceCommandStep1	operationReference(long operationReference)	Set the Operation Reference.
FinalCommandStep<CancelProcessInstanceResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<CancelProcessInstanceResponse>	send()	Sends the command to the Zeebe broker.
ZeebeFuture<CancelProcessInstanceResponse>	sendGrpcRequest()
CancelProcessInstanceCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
CancelProcessInstanceCommandStep1	useRest()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.

Methods inherited from class java.lang.Object

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

Constructor Details

CancelProcessInstanceCommandImpl

public CancelProcessInstanceCommandImpl(GatewayGrpc.GatewayStub asyncStub,
 long processInstanceKey,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 HttpClient httpClient,
 ZeebeClientConfiguration config,
 JsonMapper jsonMapper)

Method Details

requestTimeout

public FinalCommandStep<CancelProcessInstanceResponse> 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<CancelProcessInstanceResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<CancelProcessInstanceResponse> 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<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<CancelProcessInstanceResponse>

Returns:

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

sendGrpcRequest

public ZeebeFuture<CancelProcessInstanceResponse> sendGrpcRequest()

operationReference

public CancelProcessInstanceCommandStep1 operationReference(long operationReference)

Description copied from interface: CommandWithOperationReferenceStep

Set the Operation Reference.

This is a key chosen by the user and will be part of all records resulted from this operation

Specified by:

operationReference in interface CommandWithOperationReferenceStep<CancelProcessInstanceCommandStep1>

Parameters:

operationReference - a reference key chosen by the user and will be part of all records resulted from this operation

Returns:

the builder for this command with the operation reference specified

useRest

public CancelProcessInstanceCommandStep1 useRest()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Zeebe, and already wants to use this API during its development. As support for REST is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets REST as the communication API for this command. If this command doesn't support communication over REST, it simply returns the command builder instance unchanged. The default communication API can be configured using ZeebeClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<CancelProcessInstanceCommandStep1>

Returns:

the configured command

useGrpc

public CancelProcessInstanceCommandStep1 useGrpc()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Zeebe, and already wants to use this API during its development. As support for REST is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets gRPC as the communication API for this command. If this command doesn't support communication over gRPC, it simply returns the command builder instance unchanged. The default communication API can be configured using ZeebeClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<CancelProcessInstanceCommandStep1>

Returns:

the configured command