Zeebe.Client.Api.Commands.IModifyProcessInstanceCommandStep3 Interface Reference

Third command step, to optionally add variables to the element which should be activated. More...

Inheritance diagram for Zeebe.Client.Api.Commands.IModifyProcessInstanceCommandStep3:

Public Member Functions
IModifyProcessInstanceCommandStep3	WithVariables (string variables)
	Create a variable instruction for the element that's getting activated. These variables will be created in the global scope of the process instance.
IModifyProcessInstanceCommandStep3	WithVariables (string variables, string scopeId)
	Create a variable instruction for the element that's getting activated. These variables will be created in the scope of the passed element.
Public Member Functions inherited from Zeebe.Client.Api.Commands.IModifyProcessInstanceCommandStep2
IModifyProcessInstanceCommandStep1	And ()
	Acts as a boundary between the different activate and terminate instructions. Use this if you want to activate or terminate another element. Otherwise, use IFinalCommandWithRetryStep<T>.SendWithRetry to send the command.
Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IModifyProcessInstanceResponse >
Task< T >	SendWithRetry (TimeSpan? timeout=null, CancellationToken token=default)
	Sends the command with retry to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command. If the sending of the command fails, because of broker back pressure or network issues the request is retried until the command succeeds. The wait time between retries can be configured on the ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds etc. until it reaches the maximum of one minute.

Detailed Description

Third command step, to optionally add variables to the element which should be activated.

Member Function Documentation

WithVariables() [1/2]

IModifyProcessInstanceCommandStep3 Zeebe.Client.Api.Commands.IModifyProcessInstanceCommandStep3.WithVariables

(

string

variables

)

Create a variable instruction for the element that's getting activated. These variables will be created in the global scope of the process instance.

Parameters

variables

The variables JSON document as String.

Returns

The builder for this command.

WithVariables() [2/2]

IModifyProcessInstanceCommandStep3 Zeebe.Client.Api.Commands.IModifyProcessInstanceCommandStep3.WithVariables	(	string	variables,
		string	scopeId
	)

Create a variable instruction for the element that's getting activated. These variables will be created in the scope of the passed element.

Parameters

variables	The variables JSON document as String.
scopeId	The id of the element in which scope the variables should be created.

Returns

The builder for this command.

---

The documentation for this interface was generated from the following file:

• Client/Api/Commands/IModifyProcessInstanceCommandStep1.cs