Package io.camunda.client.api.command

Interface EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2

All Superinterfaces:

CommandWithTenantStep<EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2>, CommandWithVariables<EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2>, FinalCommandStep<EvaluateExpressionResponse>

All Known Implementing Classes:

EvaluateExpressionCommandImpl

Enclosing interface:

EvaluateExpressionCommandStep1

public static interface EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2
extends CommandWithTenantStep<EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2>, FinalCommandStep<EvaluateExpressionResponse>, CommandWithVariables<EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2>

Field Summary

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

DEFAULT_TENANT_IDENTIFIER

Method Summary

Modifier and Type	Method	Description
EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2	scopeKey(long scopeKey)	Evaluate the expression in the variable scope of the given process or element instance.
EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2	variable(String key, Object value)	Set a single variable for the expression evaluation.
EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2	variables(InputStream variables)	Set the variables for the expression evaluation.
EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2	variables(Object variables)	Set the variables for the expression evaluation.
EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2	variables(String variables)	Set the variables for the expression evaluation.
EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2	variables(Map<String,Object> variables)	Set the variables for the expression evaluation.

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

tenantId

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

execute, requestTimeout, send

Method Details

variables

EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2 variables(String variables)

Set the variables for the expression evaluation.

Specified by:

variables in interface CommandWithVariables<EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2>

Parameters:

variables - the variables JSON document as String

Returns:

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

variables

EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2 variables(Object variables)

Set the variables for the expression evaluation.

Specified by:

variables in interface CommandWithVariables<EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2>

Parameters:

variables - the variables document as object to be serialized to JSON

Returns:

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

variables

EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2 variables(InputStream variables)

Set the variables for the expression evaluation.

Specified by:

variables in interface CommandWithVariables<EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2>

Parameters:

variables - the variables JSON document as stream

Returns:

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

variables

EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2 variables(Map<String,Object> variables)

Set the variables for the expression evaluation.

Specified by:

variables in interface CommandWithVariables<EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2>

Parameters:

variables - the variables document as map

Returns:

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

variable

EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2 variable(String key,
 Object value)

Set a single variable for the expression evaluation.

Specified by:

variable in interface CommandWithVariables<EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2>

Parameters:

key - the key of the variable as string

value - the value of the variable as object

Returns:

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

scopeKey

EvaluateExpressionCommandStep1.EvaluateExpressionCommandStep2 scopeKey(long scopeKey)

Evaluate the expression in the variable scope of the given process or element instance. Engine variables visible at this scope are exposed to the expression in addition to the request-body variables and tenant-scoped cluster variables.

When a key is present both in the request-body variables and in the engine variable scope, the value from variables takes precedence for this evaluation only.

Parameters:

scopeKey - the key of the process or element instance scope whose variables are exposed to the expression

Returns:

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