io.zeebe.client.api.commands

Interface ActivateJobsCommandStep1.ActivateJobsCommandStep3

All Superinterfaces:

FinalCommandStep<ActivateJobsResponse>

All Known Implementing Classes:

ActivateJobsCommandImpl

Enclosing interface:

ActivateJobsCommandStep1

public static interface ActivateJobsCommandStep1.ActivateJobsCommandStep3
extends FinalCommandStep<ActivateJobsResponse>

Method Summary

Modifier and Type	Method and Description
ActivateJobsCommandStep1.ActivateJobsCommandStep3	timeout(java.time.Duration timeout) Set the time for how long a job is exclusively assigned for this subscription.
ActivateJobsCommandStep1.ActivateJobsCommandStep3	timeout(long timeout) Set the time for how long a job is exclusively assigned for this subscription.
ActivateJobsCommandStep1.ActivateJobsCommandStep3	workerName(String workerName) Set the name of the job worker.

Methods inherited from interface io.zeebe.client.api.commands.FinalCommandStep

send

Method Detail

timeout

ActivateJobsCommandStep1.ActivateJobsCommandStep3 timeout(long 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.

If no timeout is set, then the default is used from the configuration.

Parameters:

timeout - the time in milliseconds

Returns:

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

timeout

ActivateJobsCommandStep1.ActivateJobsCommandStep3 timeout(java.time.Duration 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.

If no time is set then the default is used from the configuration.

Parameters:

timeout - the time as duration (e.g. "Duration.ofMinutes(5)")

Returns:

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

workerName

ActivateJobsCommandStep1.ActivateJobsCommandStep3 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.

If no name is set then the default is used from the configuration.

Parameters:

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

Returns:

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