java.lang.Object
- org.openapitools.client.model.BatchStatisticsDto

public class BatchStatisticsDto
extends Object

BatchStatisticsDto

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`SERIALIZED_NAME_BATCH_JOB_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_BATCH_JOBS_PER_SEED`
`static String`	`SERIALIZED_NAME_COMPLETED_JOBS`
`static String`	`SERIALIZED_NAME_CREATE_USER_ID`
`static String`	`SERIALIZED_NAME_EXECUTION_START_TIME`
`static String`	`SERIALIZED_NAME_FAILED_JOBS`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_INVOCATIONS_PER_BATCH_JOB`
`static String`	`SERIALIZED_NAME_JOBS_CREATED`
`static String`	`SERIALIZED_NAME_MONITOR_JOB_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_REMAINING_JOBS`
`static String`	`SERIALIZED_NAME_SEED_JOB_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_START_TIME`
`static String`	`SERIALIZED_NAME_SUSPENDED`
`static String`	`SERIALIZED_NAME_TENANT_ID`
`static String`	`SERIALIZED_NAME_TOTAL_JOBS`
`static String`	`SERIALIZED_NAME_TYPE`

Constructor Summary

Constructors
Constructor Description

BatchStatisticsDto()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BatchStatisticsDto`	`batchJobDefinitionId(String batchJobDefinitionId)`
`BatchStatisticsDto`	`batchJobsPerSeed(Integer batchJobsPerSeed)`
`BatchStatisticsDto`	`completedJobs(Integer completedJobs)`
`BatchStatisticsDto`	`createUserId(String createUserId)`
`boolean`	`equals(Object o)`
`BatchStatisticsDto`	`executionStartTime(Date executionStartTime)`
`BatchStatisticsDto`	`failedJobs(Integer failedJobs)`
`String`	`getBatchJobDefinitionId()`	The job definition id for the batch execution jobs of this batch.
`Integer`	`getBatchJobsPerSeed()`	The number of batch execution jobs created per seed job invocation.
`Integer`	`getCompletedJobs()`	The number of completed batch execution jobs.
`String`	`getCreateUserId()`	The id of the user that created the batch.
`Date`	`getExecutionStartTime()`	The time the batch execution was started, i.e., at least one batch job has been executed.
`Integer`	`getFailedJobs()`	The number of failed batch execution jobs.
`String`	`getId()`	The id of the batch.
`Integer`	`getInvocationsPerBatchJob()`	Every batch execution job invokes the command executed by the batch `invocationsPerBatchJob` times.
`Integer`	`getJobsCreated()`	The number of batch execution jobs already created by the seed job.
`String`	`getMonitorJobDefinitionId()`	The job definition id for the monitor jobs of this batch.
`Integer`	`getRemainingJobs()`	The number of remaining batch execution jobs.
`String`	`getSeedJobDefinitionId()`	The job definition id for the seed jobs of this batch.
`Date`	`getStartTime()`	The time the batch was started.
`Boolean`	`getSuspended()`	Indicates whether this batch is suspended or not.
`String`	`getTenantId()`	The tenant id of the batch.
`Integer`	`getTotalJobs()`	The total jobs of a batch is the number of batch execution jobs required to complete the batch.
`String`	`getType()`	The type of the batch.
`int`	`hashCode()`
`BatchStatisticsDto`	`id(String id)`
`BatchStatisticsDto`	`invocationsPerBatchJob(Integer invocationsPerBatchJob)`
`BatchStatisticsDto`	`jobsCreated(Integer jobsCreated)`
`BatchStatisticsDto`	`monitorJobDefinitionId(String monitorJobDefinitionId)`
`BatchStatisticsDto`	`remainingJobs(Integer remainingJobs)`
`BatchStatisticsDto`	`seedJobDefinitionId(String seedJobDefinitionId)`
`void`	`setBatchJobDefinitionId(String batchJobDefinitionId)`
`void`	`setBatchJobsPerSeed(Integer batchJobsPerSeed)`
`void`	`setCompletedJobs(Integer completedJobs)`
`void`	`setCreateUserId(String createUserId)`
`void`	`setExecutionStartTime(Date executionStartTime)`
`void`	`setFailedJobs(Integer failedJobs)`
`void`	`setId(String id)`
`void`	`setInvocationsPerBatchJob(Integer invocationsPerBatchJob)`
`void`	`setJobsCreated(Integer jobsCreated)`
`void`	`setMonitorJobDefinitionId(String monitorJobDefinitionId)`
`void`	`setRemainingJobs(Integer remainingJobs)`
`void`	`setSeedJobDefinitionId(String seedJobDefinitionId)`
`void`	`setStartTime(Date startTime)`
`void`	`setSuspended(Boolean suspended)`
`void`	`setTenantId(String tenantId)`
`void`	`setTotalJobs(Integer totalJobs)`
`void`	`setType(String type)`
`BatchStatisticsDto`	`startTime(Date startTime)`
`BatchStatisticsDto`	`suspended(Boolean suspended)`
`BatchStatisticsDto`	`tenantId(String tenantId)`
`String`	`toString()`
`BatchStatisticsDto`	`totalJobs(Integer totalJobs)`
`BatchStatisticsDto`	`type(String type)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_REMAINING_JOBS
```
public static final String SERIALIZED_NAME_REMAINING_JOBS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COMPLETED_JOBS
```
public static final String SERIALIZED_NAME_COMPLETED_JOBS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FAILED_JOBS
```
public static final String SERIALIZED_NAME_FAILED_JOBS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TOTAL_JOBS
```
public static final String SERIALIZED_NAME_TOTAL_JOBS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_JOBS_CREATED
```
public static final String SERIALIZED_NAME_JOBS_CREATED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BATCH_JOBS_PER_SEED
```
public static final String SERIALIZED_NAME_BATCH_JOBS_PER_SEED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INVOCATIONS_PER_BATCH_JOB
```
public static final String SERIALIZED_NAME_INVOCATIONS_PER_BATCH_JOB
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SEED_JOB_DEFINITION_ID
```
public static final String SERIALIZED_NAME_SEED_JOB_DEFINITION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MONITOR_JOB_DEFINITION_ID
```
public static final String SERIALIZED_NAME_MONITOR_JOB_DEFINITION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BATCH_JOB_DEFINITION_ID
```
public static final String SERIALIZED_NAME_BATCH_JOB_DEFINITION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUSPENDED
```
public static final String SERIALIZED_NAME_SUSPENDED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TENANT_ID
```
public static final String SERIALIZED_NAME_TENANT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATE_USER_ID
```
public static final String SERIALIZED_NAME_CREATE_USER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_START_TIME
```
public static final String SERIALIZED_NAME_START_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXECUTION_START_TIME
```
public static final String SERIALIZED_NAME_EXECUTION_START_TIME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BatchStatisticsDto
```
public BatchStatisticsDto()
```
- Method Detail
  - remainingJobs
```
public BatchStatisticsDto remainingJobs(Integer remainingJobs)
```
  - getRemainingJobs
```
public Integer 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.
    
    Returns:
    
    remainingJobs
  - setRemainingJobs
```
public void setRemainingJobs(Integer remainingJobs)
```
  - completedJobs
```
public BatchStatisticsDto completedJobs(Integer completedJobs)
```
  - getCompletedJobs
```
public Integer getCompletedJobs()
```
    The number of completed batch execution jobs. This does include aborted/deleted batch execution jobs.
    
    Returns:
    
    completedJobs
  - setCompletedJobs
```
public void setCompletedJobs(Integer completedJobs)
```
  - failedJobs
```
public BatchStatisticsDto failedJobs(Integer failedJobs)
```
  - getFailedJobs
```
public Integer getFailedJobs()
```
    The number of failed batch execution jobs. This does not include aborted or deleted batch execution jobs.
    
    Returns:
    
    failedJobs
  - setFailedJobs
```
public void setFailedJobs(Integer failedJobs)
```
  - id
```
public BatchStatisticsDto id(String id)
```
  - getId
```
public String getId()
```
    The id of the batch.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - type
```
public BatchStatisticsDto type(String type)
```
  - getType
```
public String getType()
```
    The type of the batch. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types.
    
    Returns:
    
    type
  - setType
```
public void setType(String type)
```
  - totalJobs
```
public BatchStatisticsDto totalJobs(Integer totalJobs)
```
  - getTotalJobs
```
public Integer getTotalJobs()
```
    The total jobs of a batch is the number of batch execution jobs required to complete the batch.
    
    Returns:
    
    totalJobs
  - setTotalJobs
```
public void setTotalJobs(Integer totalJobs)
```
  - jobsCreated
```
public BatchStatisticsDto jobsCreated(Integer jobsCreated)
```
  - getJobsCreated
```
public Integer getJobsCreated()
```
    The number of batch execution jobs already created by the seed job.
    
    Returns:
    
    jobsCreated
  - setJobsCreated
```
public void setJobsCreated(Integer jobsCreated)
```
  - batchJobsPerSeed
```
public BatchStatisticsDto batchJobsPerSeed(Integer batchJobsPerSeed)
```
  - getBatchJobsPerSeed
```
public Integer getBatchJobsPerSeed()
```
    The number of batch execution jobs created per seed job invocation. The batch seed job is invoked until it has created all batch execution jobs required by the batch (see `totalJobs` property).
    
    Returns:
    
    batchJobsPerSeed
  - setBatchJobsPerSeed
```
public void setBatchJobsPerSeed(Integer batchJobsPerSeed)
```
  - invocationsPerBatchJob
```
public BatchStatisticsDto invocationsPerBatchJob(Integer invocationsPerBatchJob)
```
  - getInvocationsPerBatchJob
```
public Integer getInvocationsPerBatchJob()
```
    Every batch execution job invokes the command executed by the batch `invocationsPerBatchJob` times. E.g., for a process instance migration batch this specifies the number of process instances which are migrated per batch execution job.
    
    Returns:
    
    invocationsPerBatchJob
  - setInvocationsPerBatchJob
```
public void setInvocationsPerBatchJob(Integer invocationsPerBatchJob)
```
  - seedJobDefinitionId
```
public BatchStatisticsDto seedJobDefinitionId(String seedJobDefinitionId)
```
  - getSeedJobDefinitionId
```
public String getSeedJobDefinitionId()
```
    The job definition id for the seed jobs of this batch.
    
    Returns:
    
    seedJobDefinitionId
  - setSeedJobDefinitionId
```
public void setSeedJobDefinitionId(String seedJobDefinitionId)
```
  - monitorJobDefinitionId
```
public BatchStatisticsDto monitorJobDefinitionId(String monitorJobDefinitionId)
```
  - getMonitorJobDefinitionId
```
public String getMonitorJobDefinitionId()
```
    The job definition id for the monitor jobs of this batch.
    
    Returns:
    
    monitorJobDefinitionId
  - setMonitorJobDefinitionId
```
public void setMonitorJobDefinitionId(String monitorJobDefinitionId)
```
  - batchJobDefinitionId
```
public BatchStatisticsDto batchJobDefinitionId(String batchJobDefinitionId)
```
  - getBatchJobDefinitionId
```
public String getBatchJobDefinitionId()
```
    The job definition id for the batch execution jobs of this batch.
    
    Returns:
    
    batchJobDefinitionId
  - setBatchJobDefinitionId
```
public void setBatchJobDefinitionId(String batchJobDefinitionId)
```
  - suspended
```
public BatchStatisticsDto suspended(Boolean suspended)
```
  - getSuspended
```
public Boolean getSuspended()
```
    Indicates whether this batch is suspended or not.
    
    Returns:
    
    suspended
  - setSuspended
```
public void setSuspended(Boolean suspended)
```
  - tenantId
```
public BatchStatisticsDto tenantId(String tenantId)
```
  - getTenantId
```
public String getTenantId()
```
    The tenant id of the batch.
    
    Returns:
    
    tenantId
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - createUserId
```
public BatchStatisticsDto createUserId(String createUserId)
```
  - getCreateUserId
```
public String getCreateUserId()
```
    The id of the user that created the batch.
    
    Returns:
    
    createUserId
  - setCreateUserId
```
public void setCreateUserId(String createUserId)
```
  - startTime
```
public BatchStatisticsDto startTime(Date startTime)
```
  - getStartTime
```
public Date getStartTime()
```
    The time the batch was started. Default format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For further information, please see the [documentation] (https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/)
    
    Returns:
    
    startTime
  - setStartTime
```
public void setStartTime(Date startTime)
```
  - executionStartTime
```
public BatchStatisticsDto executionStartTime(Date executionStartTime)
```
  - getExecutionStartTime
```
public Date getExecutionStartTime()
```
    The time the batch execution was started, i.e., at least one batch job has been executed. Default format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For further information, please see the [documentation] (https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/)
    
    Returns:
    
    executionStartTime
  - setExecutionStartTime
```
public void setExecutionStartTime(Date executionStartTime)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BatchStatisticsDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_REMAINING_JOBS

SERIALIZED_NAME_COMPLETED_JOBS

SERIALIZED_NAME_FAILED_JOBS

SERIALIZED_NAME_ID

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_TOTAL_JOBS

SERIALIZED_NAME_JOBS_CREATED

SERIALIZED_NAME_BATCH_JOBS_PER_SEED

SERIALIZED_NAME_INVOCATIONS_PER_BATCH_JOB

SERIALIZED_NAME_SEED_JOB_DEFINITION_ID

SERIALIZED_NAME_MONITOR_JOB_DEFINITION_ID

SERIALIZED_NAME_BATCH_JOB_DEFINITION_ID

SERIALIZED_NAME_SUSPENDED

SERIALIZED_NAME_TENANT_ID

SERIALIZED_NAME_CREATE_USER_ID

SERIALIZED_NAME_START_TIME

SERIALIZED_NAME_EXECUTION_START_TIME

Constructor Detail

BatchStatisticsDto

Method Detail

remainingJobs

getRemainingJobs

setRemainingJobs

completedJobs

getCompletedJobs

setCompletedJobs

failedJobs

getFailedJobs

setFailedJobs

id

getId

setId

type

getType

setType

totalJobs

getTotalJobs

setTotalJobs

jobsCreated

getJobsCreated

setJobsCreated

batchJobsPerSeed

getBatchJobsPerSeed

setBatchJobsPerSeed

invocationsPerBatchJob

getInvocationsPerBatchJob

setInvocationsPerBatchJob

seedJobDefinitionId

getSeedJobDefinitionId

setSeedJobDefinitionId

monitorJobDefinitionId

getMonitorJobDefinitionId

setMonitorJobDefinitionId

batchJobDefinitionId

getBatchJobDefinitionId

setBatchJobDefinitionId

suspended

getSuspended

setSuspended

tenantId

getTenantId

setTenantId

createUserId

getCreateUserId

setCreateUserId

startTime

getStartTime

setStartTime

executionStartTime

getExecutionStartTime

setExecutionStartTime

equals

hashCode

toString