Batch (Camunda Platform Javadocs 7.15.19-ee)

All Known Subinterfaces:

BatchStatistics

All Known Implementing Classes:

BatchEntity, BatchStatisticsEntity
```
public interface Batch
```
A batch represents a number of jobs which execute a number of commands asynchronously.

Batches have three types of jobs:
- Seed jobs: Create execution jobs
- Execution jobs: Execute the actual action
- Monitor jobs: Manage the batch once all execution jobs have been created (e.g. responsible for deletion of the Batch after completion).
All three job types have independent job definitions. They can be controlled individually (e.g. suspension) and are independently represented in the historic job log.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TYPE_BATCH_SET_REMOVAL_TIME`
`static String`	`TYPE_DECISION_SET_REMOVAL_TIME`
`static String`	`TYPE_HISTORIC_DECISION_INSTANCE_DELETION`
`static String`	`TYPE_HISTORIC_PROCESS_INSTANCE_DELETION`
`static String`	`TYPE_PROCESS_INSTANCE_DELETION`
`static String`	`TYPE_PROCESS_INSTANCE_MIGRATION`
`static String`	`TYPE_PROCESS_INSTANCE_MODIFICATION`
`static String`	`TYPE_PROCESS_INSTANCE_RESTART`
`static String`	`TYPE_PROCESS_INSTANCE_UPDATE_SUSPENSION_STATE`
`static String`	`TYPE_PROCESS_SET_REMOVAL_TIME`
`static String`	`TYPE_SET_EXTERNAL_TASK_RETRIES`
`static String`	`TYPE_SET_JOB_RETRIES`
`static String`	`TYPE_SET_VARIABLES`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getBatchJobDefinitionId()`
`int`	`getBatchJobsPerSeed()`
`String`	`getCreateUserId()`
`String`	`getId()`
`int`	`getInvocationsPerBatchJob()`
`int`	`getJobsCreated()`
`String`	`getMonitorJobDefinitionId()`
`String`	`getSeedJobDefinitionId()`
`String`	`getTenantId()`
`int`	`getTotalJobs()`
`String`	`getType()`
`boolean`	`isSuspended()` Indicates whether this batch is suspended.

- Field Detail
  - TYPE_PROCESS_INSTANCE_MIGRATION
```
static final String TYPE_PROCESS_INSTANCE_MIGRATION
```
    See Also:
    
    Constant Field Values
  - TYPE_PROCESS_INSTANCE_MODIFICATION
```
static final String TYPE_PROCESS_INSTANCE_MODIFICATION
```
    See Also:
    
    Constant Field Values
  - TYPE_PROCESS_INSTANCE_RESTART
```
static final String TYPE_PROCESS_INSTANCE_RESTART
```
    See Also:
    
    Constant Field Values
  - TYPE_PROCESS_INSTANCE_DELETION
```
static final String TYPE_PROCESS_INSTANCE_DELETION
```
    See Also:
    
    Constant Field Values
  - TYPE_PROCESS_INSTANCE_UPDATE_SUSPENSION_STATE
```
static final String TYPE_PROCESS_INSTANCE_UPDATE_SUSPENSION_STATE
```
    See Also:
    
    Constant Field Values
  - TYPE_HISTORIC_PROCESS_INSTANCE_DELETION
```
static final String TYPE_HISTORIC_PROCESS_INSTANCE_DELETION
```
    See Also:
    
    Constant Field Values
  - TYPE_HISTORIC_DECISION_INSTANCE_DELETION
```
static final String TYPE_HISTORIC_DECISION_INSTANCE_DELETION
```
    See Also:
    
    Constant Field Values
  - TYPE_SET_JOB_RETRIES
```
static final String TYPE_SET_JOB_RETRIES
```
    See Also:
    
    Constant Field Values
  - TYPE_SET_EXTERNAL_TASK_RETRIES
```
static final String TYPE_SET_EXTERNAL_TASK_RETRIES
```
    See Also:
    
    Constant Field Values
  - TYPE_PROCESS_SET_REMOVAL_TIME
```
static final String TYPE_PROCESS_SET_REMOVAL_TIME
```
    See Also:
    
    Constant Field Values
  - TYPE_DECISION_SET_REMOVAL_TIME
```
static final String TYPE_DECISION_SET_REMOVAL_TIME
```
    See Also:
    
    Constant Field Values
  - TYPE_BATCH_SET_REMOVAL_TIME
```
static final String TYPE_BATCH_SET_REMOVAL_TIME
```
    See Also:
    
    Constant Field Values
  - TYPE_SET_VARIABLES
```
static final String TYPE_SET_VARIABLES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
String getId()
```
    Returns:
    
    the id of the batch
  - getType
```
String getType()
```
    Returns:
    
    the type of the batch
  - getTotalJobs
```
int getTotalJobs()
```
    Returns:
    
    the number of batch execution jobs required to complete the batch
  - getJobsCreated
```
int getJobsCreated()
```
    Returns:
    
    the number of batch execution jobs already created by the seed job
  - getBatchJobsPerSeed
```
int getBatchJobsPerSeed()
```
    Returns:
    
    number of batch jobs created per batch seed job invocation
  - getInvocationsPerBatchJob
```
int getInvocationsPerBatchJob()
```
    Returns:
    
    the number of invocations executed per batch job
  - getSeedJobDefinitionId
```
String getSeedJobDefinitionId()
```
    Returns:
    
    the id of the batch seed job definition
  - getMonitorJobDefinitionId
```
String getMonitorJobDefinitionId()
```
    Returns:
    
    the id of the batch monitor job definition
  - getBatchJobDefinitionId
```
String getBatchJobDefinitionId()
```
    Returns:
    
    the id of the batch job definition
  - getTenantId
```
String getTenantId()
```
    Returns:
    
    the batch's tenant id or null
  - getCreateUserId
```
String getCreateUserId()
```
    Returns:
    
    the batch creator's user id
  - isSuspended
```
boolean isSuspended()
```
    Indicates whether this batch is suspended. If a batch is suspended, the batch jobs will not be acquired by the job executor.
    
    Note: It is still possible to manually suspend and activate jobs and job definitions using the ManagementService, which will not change the suspension state of the batch.
    
    Returns:
    
    true if this batch is currently suspended, false otherwise
    
    See Also:
    
    ManagementService.suspendBatchById(String), ManagementService.activateBatchById(String)

Interface Batch

Field Summary

Method Summary

Field Detail

TYPE_PROCESS_INSTANCE_MIGRATION

TYPE_PROCESS_INSTANCE_MODIFICATION

TYPE_PROCESS_INSTANCE_RESTART

TYPE_PROCESS_INSTANCE_DELETION

TYPE_PROCESS_INSTANCE_UPDATE_SUSPENSION_STATE

TYPE_HISTORIC_PROCESS_INSTANCE_DELETION

TYPE_HISTORIC_DECISION_INSTANCE_DELETION

TYPE_SET_JOB_RETRIES

TYPE_SET_EXTERNAL_TASK_RETRIES

TYPE_PROCESS_SET_REMOVAL_TIME

TYPE_DECISION_SET_REMOVAL_TIME

TYPE_BATCH_SET_REMOVAL_TIME

TYPE_SET_VARIABLES

Method Detail

getId

getType

getTotalJobs

getJobsCreated

getBatchJobsPerSeed

getInvocationsPerBatchJob

getSeedJobDefinitionId

getMonitorJobDefinitionId

getBatchJobDefinitionId

getTenantId

getCreateUserId

isSuspended