Class CreateProcessInstanceWithResultCommandImpl
java.lang.Object
io.camunda.zeebe.client.impl.command.CreateProcessInstanceWithResultCommandImpl
- All Implemented Interfaces:
CommandWithTenantStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1>
,CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1
,FinalCommandStep<ProcessInstanceResult>
public final class CreateProcessInstanceWithResultCommandImpl
extends Object
implements CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1
-
Field Summary
Fields inherited from interface io.camunda.zeebe.client.api.command.CommandWithTenantStep
DEFAULT_TENANT_IDENTIFIER
-
Constructor Summary
ConstructorDescriptionCreateProcessInstanceWithResultCommandImpl
(JsonMapper jsonMapper, GatewayGrpc.GatewayStub asyncStub, GatewayOuterClass.CreateProcessInstanceRequest.Builder builder, Predicate<Throwable> retryPredicate, Duration requestTimeout) -
Method Summary
Modifier and TypeMethodDescriptionfetchVariables
(String... fetchVariables) Set a list of variables names which should be fetched in the response.fetchVariables
(List<String> fetchVariables) Set a list of variables names which should be fetched in the response.requestTimeout
(Duration requestTimeout) Sets the request timeout for the command.send()
Sends the command to the Zeebe broker.Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
-
Constructor Details
-
CreateProcessInstanceWithResultCommandImpl
public CreateProcessInstanceWithResultCommandImpl(JsonMapper jsonMapper, GatewayGrpc.GatewayStub asyncStub, GatewayOuterClass.CreateProcessInstanceRequest.Builder builder, Predicate<Throwable> retryPredicate, Duration requestTimeout)
-
-
Method Details
-
requestTimeout
Description copied from interface:FinalCommandStep
Sets the request timeout for the command. The default request timeout can be configured usingZeebeClientBuilder.defaultRequestTimeout(Duration)
.- Specified by:
requestTimeout
in interfaceFinalCommandStep<ProcessInstanceResult>
- Parameters:
requestTimeout
- the request timeout- Returns:
- the configured command
-
send
Description copied from interface:FinalCommandStep
Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.Call
ZeebeFuture.join()
to wait until the response is available.Future<JobEventinvalid input: '>' future = command.send(); JobEvent event = future.join();
- Specified by:
send
in interfaceFinalCommandStep<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 interfaceCreateProcessInstanceCommandStep1.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 interfaceCreateProcessInstanceCommandStep1.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
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 multi-tenancy, and already wants to use this API during its development. As support for multi-tenancy 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.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 Zeebe 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 Zeebe cluster, are assigned to the
CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER
.If no tenant is explicitly specified, then the command is rejected.
- Specified by:
tenantId
in interfaceCommandWithTenantStep<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
-