Package io.camunda.client.impl.command

Class CancelBatchOperationCommandImpl

java.lang.Object

io.camunda.client.impl.command.CancelBatchOperationCommandImpl

All Implemented Interfaces:

CancelBatchOperationStep1, FinalCommandStep<CancelBatchOperationResponse>

public final class CancelBatchOperationCommandImpl
extends Object
implements CancelBatchOperationStep1

Implementation of the command to cancel a batch operation.

Constructor Summary

Constructors

Constructor	Description
CancelBatchOperationCommandImpl(HttpClient httpClient, String batchOperationKey)

Method Summary

Modifier and Type	Method	Description
FinalCommandStep<CancelBatchOperationResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<CancelBatchOperationResponse>	send()	Sends the command to the Camunda gateway.

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

CancelBatchOperationCommandImpl

public CancelBatchOperationCommandImpl(HttpClient httpClient,
 String batchOperationKey)

Method Details

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<CancelBatchOperationResponse> 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<CancelBatchOperationResponse>

Returns:

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