Package io.camunda.client.impl.command

Class CancelProcessInstanceCommandImpl

java.lang.Object

io.camunda.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(io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub asyncStub, long processInstanceKey, Predicate<CredentialsProvider.StatusCode> retryPredicate, HttpClient httpClient, CamundaClientConfiguration 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.
CamundaFuture<CancelProcessInstanceResponse>	send()	Sends the command to the Camunda gateway.
CamundaFuture<CancelProcessInstanceResponse>	sendGrpcRequest()
CancelProcessInstanceCommandStep1	useGrpc()	Sets gRPC as the communication API for this command.
CancelProcessInstanceCommandStep1	useRest()	Sets REST as the communication API for this command.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute

Constructor Details

CancelProcessInstanceCommandImpl

public CancelProcessInstanceCommandImpl(io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub asyncStub,
 long processInstanceKey,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 HttpClient httpClient,
 CamundaClientConfiguration 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 CamundaClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<CancelProcessInstanceResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<CancelProcessInstanceResponse> send()

Description copied from interface: FinalCommandStep

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

Call CamundaFuture.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 CamundaFuture<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

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 CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<CancelProcessInstanceCommandStep1>

Returns:

the configured command

useGrpc

public CancelProcessInstanceCommandStep1 useGrpc()

Description copied from interface: CommandWithCommunicationApiStep

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 CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<CancelProcessInstanceCommandStep1>

Returns:

the configured command