Package io.camunda.client.impl.command

Class AssignProcessInstanceBusinessIdCommandImpl

java.lang.Object

io.camunda.client.impl.command.AssignProcessInstanceBusinessIdCommandImpl

All Implemented Interfaces:

AssignProcessInstanceBusinessIdCommandStep1, AssignProcessInstanceBusinessIdCommandStep1.AssignProcessInstanceBusinessIdCommandStep2, CommandWithCommunicationApiStep<AssignProcessInstanceBusinessIdCommandStep1>, FinalCommandStep<AssignProcessInstanceBusinessIdResponse>

public final class AssignProcessInstanceBusinessIdCommandImpl
extends Object
implements AssignProcessInstanceBusinessIdCommandStep1, AssignProcessInstanceBusinessIdCommandStep1.AssignProcessInstanceBusinessIdCommandStep2

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.command.AssignProcessInstanceBusinessIdCommandStep1

AssignProcessInstanceBusinessIdCommandStep1.AssignProcessInstanceBusinessIdCommandStep2

Constructor Summary

Constructors

Constructor	Description
AssignProcessInstanceBusinessIdCommandImpl(long processInstanceKey, io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub asyncStub, Predicate<CredentialsProvider.StatusCode> retryPredicate, HttpClient httpClient, CamundaClientConfiguration config, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
AssignProcessInstanceBusinessIdCommandStep1.AssignProcessInstanceBusinessIdCommandStep2	businessId(String businessId)	Set the business id to assign to the process instance.
FinalCommandStep<AssignProcessInstanceBusinessIdResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<AssignProcessInstanceBusinessIdResponse>	send()	Sends the command to the Camunda gateway.
AssignProcessInstanceBusinessIdCommandStep1	useGrpc()	Sets gRPC as the communication API for this command.
AssignProcessInstanceBusinessIdCommandStep1	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

AssignProcessInstanceBusinessIdCommandImpl

public AssignProcessInstanceBusinessIdCommandImpl(long processInstanceKey,
 io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub asyncStub,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 HttpClient httpClient,
 CamundaClientConfiguration config,
 JsonMapper jsonMapper)

Method Details

businessId

public AssignProcessInstanceBusinessIdCommandStep1.AssignProcessInstanceBusinessIdCommandStep2 businessId(String businessId)

Description copied from interface: AssignProcessInstanceBusinessIdCommandStep1

Set the business id to assign to the process instance.

Specified by:

businessId in interface AssignProcessInstanceBusinessIdCommandStep1

Parameters:

businessId - the business id to assign

Returns:

the builder for this command

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

useRest

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

Returns:

the configured command

useGrpc

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

Returns:

the configured command