Package io.camunda.zeebe.client.api.command

Interface ActivateJobsCommandStep1.ActivateJobsCommandStep3

All Superinterfaces:
FinalCommandStep<ActivateJobsResponse>
All Known Implementing Classes:
ActivateJobsCommandImpl
Enclosing interface:
ActivateJobsCommandStep1
public static interface ActivateJobsCommandStep1.ActivateJobsCommandStep3 extends FinalCommandStep<ActivateJobsResponse>

  • Method Details

    • timeout

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

    • fetchVariables

      ActivateJobsCommandStep1.ActivateJobsCommandStep3 fetchVariables(List<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 FinalCommandStep.send() to complete the command and send it to the broker.

    • fetchVariables

      ActivateJobsCommandStep1.ActivateJobsCommandStep3 fetchVariables(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 FinalCommandStep.send() to complete the command and send it to the broker.