BatchStatistics (Camunda Platform Javadocs 7.19.0-SNAPSHOT)

All Superinterfaces:

Batch

All Known Implementing Classes:

BatchStatisticsEntity
```
public interface BatchStatistics
extends Batch
```
Additional statistics for a single batch.

Contains the number of remaining jobs, completed and failed batch execution jobs. The following relation between these exists: batch total jobs = remaining jobs + completed jobs

Field Summary
- Fields inherited from interface org.camunda.bpm.engine.batch.Batch
  TYPE_BATCH_SET_REMOVAL_TIME, TYPE_CORRELATE_MESSAGE, TYPE_DECISION_SET_REMOVAL_TIME, TYPE_HISTORIC_DECISION_INSTANCE_DELETION, TYPE_HISTORIC_PROCESS_INSTANCE_DELETION, TYPE_PROCESS_INSTANCE_DELETION, TYPE_PROCESS_INSTANCE_MIGRATION, TYPE_PROCESS_INSTANCE_MODIFICATION, TYPE_PROCESS_INSTANCE_RESTART, TYPE_PROCESS_INSTANCE_UPDATE_SUSPENSION_STATE, TYPE_PROCESS_SET_REMOVAL_TIME, TYPE_SET_EXTERNAL_TASK_RETRIES, TYPE_SET_JOB_RETRIES, TYPE_SET_VARIABLES

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getCompletedJobs()`	The number of completed batch execution jobs.
`int`	`getFailedJobs()`	The number of failed batch execution jobs.
`int`	`getRemainingJobs()`	The number of remaining batch execution jobs.

Methods inherited from interface org.camunda.bpm.engine.batch.Batch
getBatchJobDefinitionId, getBatchJobsPerSeed, getCreateUserId, getExecutionStartTime, getId, getInvocationsPerBatchJob, getJobsCreated, getMonitorJobDefinitionId, getSeedJobDefinitionId, getStartTime, getTenantId, getTotalJobs, getType, isSuspended

- Method Detail
  - getRemainingJobs
```
int getRemainingJobs()
```
    The number of remaining batch execution jobs. This does include failed batch execution jobs and batch execution jobs which still have to be created by the seed job.
    
    See Batch.getTotalJobs() for the number of all batch execution jobs, getCompletedJobs() for the number of completed batch execution jobs and getFailedJobs() for the number of failed batch execution jobs.
    
    Returns:
    
    the number of remaining batch execution jobs
  - getCompletedJobs
```
int getCompletedJobs()
```
    The number of completed batch execution jobs. This does include aborted/deleted batch execution jobs.
    
    See Batch.getTotalJobs() for the number of all batch execution jobs, getRemainingJobs() ()} for the number of remaining batch execution jobs and getFailedJobs() for the number of failed batch execution jobs.
    
    Returns:
    
    the number of completed batch execution jobs
  - getFailedJobs
```
int getFailedJobs()
```
    The number of failed batch execution jobs. This does not include aborted or deleted batch execution jobs.
    
    See Batch.getTotalJobs() for the number of all batch execution jobs, getRemainingJobs() ()} for the number of remaining batch execution jobs and getCompletedJobs() ()} for the number of completed batch execution jobs.
    
    Returns:
    
    the number of failed batch execution jobs