Package io.camunda.zeebe.protocol.record.value

Interface JobBatchRecordValue

All Superinterfaces:
JsonSerializable, RecordValue
All Known Implementing Classes:
ImmutableJobBatchRecordValue
@Immutable public interface JobBatchRecordValue extends RecordValue
Represents a job batch related event or command.

See JobBatchIntent for intents.

  • Method Details

    • getType

      String getType()
      Returns:
      the type of the job

    • getWorker

      String getWorker()
      Returns:
      the assigned worker to complete the job

    • getTimeout

      long getTimeout()
      Returns:
      the timeout (time span in milliseconds) for which a job is exclusively assigned to this worker. If the timeout is exceeded, it can happen that the job is handed to another worker and the work is performed twice.

    • getMaxJobsToActivate

      int getMaxJobsToActivate()
      Returns:
      the number of jobs to handle

    • getJobKeys

      List<Long> getJobKeys()
      Returns:
      list of the keys from the jobs assigned to this batch

    • getJobs

      List<JobRecordValue> getJobs()
      Returns:
      the jobs assigned to this batch

    • isTruncated

      boolean isTruncated()
      Returns:
      the broker has more JobRecords that couldn't fit in this batch

    • getTenantIds

      List<String> getTenantIds()
      Since a job batch contains many jobs, it is possible that the jobs belong to different tenants.

      This can be useful when requesting jobs for multiple tenants at once. Each of the activated jobs will be owned by the tenant that owns the corresponding process instance.

      Returns:
      the identifiers of the tenants that this job batch may contain jobs for