Zeebe.Client.Api.Commands.IActivateJobsCommandStep3 Interface Reference

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

Public Member Functions
IActivateJobsCommandStep3	Timeout (TimeSpan timeout)
	Set the time for how long a job is exclusively assigned for this subscription.
IActivateJobsCommandStep3	WorkerName (string workerName)
	Set the name of the job worker.
IActivateJobsCommandStep3	FetchVariables (IList< string > fetchVariables)
	Set a list of variable names which should be fetch on job activation.
IActivateJobsCommandStep3	PollingTimeout (TimeSpan pollingTimeout)
	Set the polling timeout.
IActivateJobsCommandStep3	FetchVariables (params string[] fetchVariables)
	Set a list of variable names which should be fetch on job activation.
Public Member Functions inherited from Zeebe.Client.Api.Commands.ITenantIdsCommandStep< IActivateJobsCommandStep3 >
T	TenantIds (IList< string > tenantIds)
	Specifies the tenants that may own any entities (e.g. process definition, process instances, etc.) resulting from this command.
T	TenantIds (params string[] tenantIds)
	Specifies the tenants that may own any entities (e.g. process definition, process instances, etc.) resulting from this command.
Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IActivateJobsResponse >
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.

Member Function Documentation

FetchVariables() [1/2]

IActivateJobsCommandStep3 Zeebe.Client.Api.Commands.IActivateJobsCommandStep3.FetchVariables

(

IList< string >

fetchVariables

)

Set a list of variable names which should be fetch on job activation.

The jobs which are activated by this command will only contain variables from this list.

This can be used to limit the number of variables of the activated jobs.

Parameters

fetchVariables

list of variables names to fetch on activation

Returns

the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

FetchVariables() [2/2]

IActivateJobsCommandStep3 Zeebe.Client.Api.Commands.IActivateJobsCommandStep3.FetchVariables

(

params string[]

fetchVariables

)

Set a list of variable names which should be fetch on job activation.

The jobs which are activated by this command will only contain variables from this list.

This can be used to limit the number of variables of the activated jobs.

Parameters

fetchVariables

list of variables names to fetch on activation

Returns

the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

PollingTimeout()

IActivateJobsCommandStep3 Zeebe.Client.Api.Commands.IActivateJobsCommandStep3.PollingTimeout

(

TimeSpan

pollingTimeout

)

Set the polling timeout.

The activate jobs request will be completed when at least one job is activated or after the given pollingTimeout.

Parameters

pollingTimeout

the polling timeout (e.g. "TimeSpan.FromMinutes(10)")

Returns

the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

Timeout()

IActivateJobsCommandStep3 Zeebe.Client.Api.Commands.IActivateJobsCommandStep3.Timeout

(

TimeSpan

timeout

)

Set the time for how long a job is exclusively assigned for this subscription.

In this time, the job can not be assigned by other subscriptions to ensure that only one subscription work on the job. When the time is over then the job can be assigned again by this or other subscription if it's not completed yet.

Parameters

timeout

the time as time span (e.g. "TimeSpan.FromMinutes(10)")

Returns

the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

WorkerName()

IActivateJobsCommandStep3 Zeebe.Client.Api.Commands.IActivateJobsCommandStep3.WorkerName

(

string

workerName

)

Set the name of the job worker.

This name is used to identify the worker which activated the jobs. Its main purpose is for monitoring and auditing. Commands on activated jobs do not check the worker name, i.e. complete or fail job.

Parameters

workerName

the name of the worker (e.g. "payment-service")

Returns

the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

---

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

• Client/Api/Commands/IActivateJobsCommandStep1.cs