Package io.camunda.client.impl.command

Class SuspendProcessInstanceCommandImpl

java.lang.Object

io.camunda.client.impl.command.SuspendProcessInstanceCommandImpl

All Implemented Interfaces:

CommandWithOperationReferenceStep<SuspendProcessInstanceCommandStep1>, FinalCommandStep<SuspendProcessInstanceResponse>, SuspendProcessInstanceCommandStep1

public class SuspendProcessInstanceCommandImpl
extends Object
implements SuspendProcessInstanceCommandStep1

Constructor Summary

Constructors

Constructor	Description
SuspendProcessInstanceCommandImpl(long processInstanceKey, CamundaClientConfiguration config, HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
SuspendProcessInstanceCommandStep1	operationReference(long operationReference)	Set the Operation Reference.
FinalCommandStep<SuspendProcessInstanceResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<SuspendProcessInstanceResponse>	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

SuspendProcessInstanceCommandImpl

public SuspendProcessInstanceCommandImpl(long processInstanceKey,
 CamundaClientConfiguration config,
 HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

operationReference

public SuspendProcessInstanceCommandStep1 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<SuspendProcessInstanceCommandStep1>

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

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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