Package io.camunda.client.impl.command

Class CreateProcessInstanceWithResultCommandImpl

java.lang.Object

io.camunda.client.impl.command.CreateProcessInstanceWithResultCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1>, CommandWithTenantStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1>, CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1, FinalCommandStep<ProcessInstanceResult>

public final class CreateProcessInstanceWithResultCommandImpl
extends Object
implements CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1

Field Summary

Fields inherited from interface io.camunda.client.api.command.CommandWithTenantStep

DEFAULT_TENANT_IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
CreateProcessInstanceWithResultCommandImpl(JsonMapper jsonMapper, GatewayGrpc.GatewayStub asyncStub, GatewayOuterClass.CreateProcessInstanceRequest.Builder grpcRequestObject, Predicate<CredentialsProvider.StatusCode> retryPredicate, Duration requestTimeout, HttpClient httpClient, boolean preferRestOverGrpc, ProcessInstanceCreationInstruction httpRequestObject)

Method Summary

Modifier and Type	Method	Description
CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1	fetchVariables(String... fetchVariables)	Set a list of variables names which should be fetched in the response.
CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1	fetchVariables(List<String> fetchVariables)	Set a list of variables names which should be fetched in the response.
FinalCommandStep<ProcessInstanceResult>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<ProcessInstanceResult>	send()	Sends the command to the Camunda gateway.
CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1	tenantId(String tenantId)	Specifies the tenant that will own any entities (e.g. process definition, process instances, etc.) resulting from this command, or that owns any entities (e.g. jobs) referred to from this command.
CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1	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

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

execute

Constructor Details

CreateProcessInstanceWithResultCommandImpl

public CreateProcessInstanceWithResultCommandImpl(JsonMapper jsonMapper,
 GatewayGrpc.GatewayStub asyncStub,
 GatewayOuterClass.CreateProcessInstanceRequest.Builder grpcRequestObject,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 Duration requestTimeout,
 HttpClient httpClient,
 boolean preferRestOverGrpc,
 ProcessInstanceCreationInstruction httpRequestObject)

Method Details

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

fetchVariables

public CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1 fetchVariables(List<String> fetchVariables)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1

Set a list of variables names which should be fetched in the response.

Specified by:

fetchVariables in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1

Parameters:

fetchVariables - set of names of variables to be included in the response

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send * it to the broker

fetchVariables

public CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1 fetchVariables(String... fetchVariables)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1

Set a list of variables names which should be fetched in the response.

Specified by:

fetchVariables in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1

Parameters:

fetchVariables - set of names of variables to be included in the response

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send * it to the broker

tenantId

public CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1 tenantId(String tenantId)

Description copied from interface: CommandWithTenantStep

Specifies the tenant that will own any entities (e.g. process definition, process instances, etc.) resulting from this command, or that owns any entities (e.g. jobs) referred to from this command.

Multi-tenancy

Multiple tenants can share a Camunda cluster. Entities can be assigned to a specific tenant using an identifier. Only that tenant can access these entities.

Any entities created before multi-tenancy has been enabled in the Camunda cluster, are assigned to the CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER.

If no tenant is explicitly specified, then the command is rejected.

Specified by:

tenantId in interface CommandWithTenantStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1>

Parameters:

tenantId - the identifier of the tenant to specify for this command, e.g. "ACME"

Returns:

the builder for this command with the tenant specified

useRest

public CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1 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 Camunda, and already wants to use this API during its development. As support for REST is added to Camunda, 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 CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1>

Returns:

the configured command

useGrpc

public CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1 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 Camunda, 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 CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1>

Returns:

the configured command