Package io.camunda.client.impl.command

Class EvaluateConditionalCommandImpl

java.lang.Object

io.camunda.client.impl.command.CommandWithVariables<EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2>

io.camunda.client.impl.command.EvaluateConditionalCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<EvaluateConditionalCommandStep1>, CommandWithTenantStep<EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2>, CommandWithVariables<EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2>, EvaluateConditionalCommandStep1, EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2, FinalCommandStep<EvaluateConditionalResponse>

public final class EvaluateConditionalCommandImpl
extends CommandWithVariables<EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2>
implements EvaluateConditionalCommandStep1, EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2

Nested Class Summary

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

EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2

Field Summary

Fields inherited from class io.camunda.client.impl.command.CommandWithVariables

objectMapper

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

DEFAULT_TENANT_IDENTIFIER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2	processDefinitionKey(long processDefinitionKey)	Set the key of the process definition to evaluate conditional start events for.
FinalCommandStep<EvaluateConditionalResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<EvaluateConditionalResponse>	send()	Sends the command to the Camunda gateway.
protected EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2	setVariablesInternal(String variables)
EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2	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.
EvaluateConditionalCommandStep1	useGrpc()	Sets gRPC as the communication API for this command.
EvaluateConditionalCommandStep1	useRest()	Sets REST as the communication API for this command.

Methods inherited from class io.camunda.client.impl.command.CommandWithVariables

variable, variables, variables, variables, variables

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.CommandWithVariables

variable, variables, variables, variables, variables

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

execute

Constructor Details

EvaluateConditionalCommandImpl

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

Method Details

setVariablesInternal

protected EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2 setVariablesInternal(String variables)

Specified by:

setVariablesInternal in class CommandWithVariables<EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2>

processDefinitionKey

public EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2 processDefinitionKey(long processDefinitionKey)

Description copied from interface: EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2

Set the key of the process definition to evaluate conditional start events for. If a key is not set, the root-level conditional start events across all process definitions will be evaluated.

This value will be used to evaluate only the conditional start events of the specified process definition.

Specified by:

processDefinitionKey in interface EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2

Parameters:

processDefinitionKey - the key of the process definition

Returns:

the builder for this command

tenantId

public EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2 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<EvaluateConditionalCommandStep1.EvaluateConditionalCommandStep2>

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

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

useRest

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

Returns:

the configured command

useGrpc

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

Returns:

the configured command