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

public class HistoricBatchDto
extends Object

HistoricBatchDto

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_CREATE_USER_ID`
`static String`	`SERIALIZED_NAME_END_TIME`
`static String`	`SERIALIZED_NAME_EXECUTION_START_TIME`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_INVOCATIONS_PER_BATCH_JOB`
`static String`	`SERIALIZED_NAME_MONITOR_JOB_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_REMOVAL_TIME`
`static String`	`SERIALIZED_NAME_SEED_JOB_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_START_TIME`
`static String`	`SERIALIZED_NAME_TENANT_ID`
`static String`	`SERIALIZED_NAME_TOTAL_JOBS`
`static String`	`SERIALIZED_NAME_TYPE`

Constructor Summary

Constructors
Constructor Description

HistoricBatchDto()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HistoricBatchDto`	`batchJobDefinitionId(String batchJobDefinitionId)`
`HistoricBatchDto`	`batchJobsPerSeed(Integer batchJobsPerSeed)`
`HistoricBatchDto`	`createUserId(String createUserId)`
`HistoricBatchDto`	`endTime(Date endTime)`
`boolean`	`equals(Object o)`
`HistoricBatchDto`	`executionStartTime(Date executionStartTime)`
`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.
`String`	`getCreateUserId()`	The batch creator's user id.
`Date`	`getEndTime()`	The time the batch ended.
`Date`	`getExecutionStartTime()`	The time the batch execution was started, i.e., at least one batch job has been executed.
`String`	`getId()`	The id of the batch.
`Integer`	`getInvocationsPerBatchJob()`	Every batch execution job invokes the command executed by the batch `invocationsPerBatchJob` times.
`String`	`getMonitorJobDefinitionId()`	The job definition id for the monitor jobs of this batch.
`Date`	`getRemovalTime()`	The time after which the historic batch should be removed by the History Cleanup job.
`String`	`getSeedJobDefinitionId()`	The job definition id for the seed jobs of this batch.
`Date`	`getStartTime()`	The time the batch was started.
`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()`
`HistoricBatchDto`	`id(String id)`
`HistoricBatchDto`	`invocationsPerBatchJob(Integer invocationsPerBatchJob)`
`HistoricBatchDto`	`monitorJobDefinitionId(String monitorJobDefinitionId)`
`HistoricBatchDto`	`removalTime(Date removalTime)`
`HistoricBatchDto`	`seedJobDefinitionId(String seedJobDefinitionId)`
`void`	`setBatchJobDefinitionId(String batchJobDefinitionId)`
`void`	`setBatchJobsPerSeed(Integer batchJobsPerSeed)`
`void`	`setCreateUserId(String createUserId)`
`void`	`setEndTime(Date endTime)`
`void`	`setExecutionStartTime(Date executionStartTime)`
`void`	`setId(String id)`
`void`	`setInvocationsPerBatchJob(Integer invocationsPerBatchJob)`
`void`	`setMonitorJobDefinitionId(String monitorJobDefinitionId)`
`void`	`setRemovalTime(Date removalTime)`
`void`	`setSeedJobDefinitionId(String seedJobDefinitionId)`
`void`	`setStartTime(Date startTime)`
`void`	`setTenantId(String tenantId)`
`void`	`setTotalJobs(Integer totalJobs)`
`void`	`setType(String type)`
`HistoricBatchDto`	`startTime(Date startTime)`
`HistoricBatchDto`	`tenantId(String tenantId)`
`String`	`toString()`
`HistoricBatchDto`	`totalJobs(Integer totalJobs)`
`HistoricBatchDto`	`type(String type)`

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

- Field Detail
  - 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_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_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
  - SERIALIZED_NAME_END_TIME
```
public static final String SERIALIZED_NAME_END_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REMOVAL_TIME
```
public static final String SERIALIZED_NAME_REMOVAL_TIME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HistoricBatchDto
```
public HistoricBatchDto()
```
- Method Detail
  - id
```
public HistoricBatchDto id(String id)
```
  - getId
```
public String getId()
```
    The id of the batch.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - type
```
public HistoricBatchDto 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 HistoricBatchDto 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)
```
  - batchJobsPerSeed
```
public HistoricBatchDto 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 HistoricBatchDto 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 HistoricBatchDto 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 HistoricBatchDto 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 HistoricBatchDto 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)
```
  - tenantId
```
public HistoricBatchDto tenantId(String tenantId)
```
  - getTenantId
```
public String getTenantId()
```
    The tenant id of the batch.
    
    Returns:
    
    tenantId
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - createUserId
```
public HistoricBatchDto createUserId(String createUserId)
```
  - getCreateUserId
```
public String getCreateUserId()
```
    The batch creator's user id.
    
    Returns:
    
    createUserId
  - setCreateUserId
```
public void setCreateUserId(String createUserId)
```
  - startTime
```
public HistoricBatchDto 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 HistoricBatchDto 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)
```
  - endTime
```
public HistoricBatchDto endTime(Date endTime)
```
  - getEndTime
```
public Date getEndTime()
```
    The time the batch ended. 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:
    
    endTime
  - setEndTime
```
public void setEndTime(Date endTime)
```
  - removalTime
```
public HistoricBatchDto removalTime(Date removalTime)
```
  - getRemovalTime
```
public Date getRemovalTime()
```
    The time after which the historic batch should be removed by the History Cleanup job. 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:
    
    removalTime
  - setRemovalTime
```
public void setRemovalTime(Date removalTime)
```
  - 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 HistoricBatchDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_TOTAL_JOBS

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_TENANT_ID

SERIALIZED_NAME_CREATE_USER_ID

SERIALIZED_NAME_START_TIME

SERIALIZED_NAME_EXECUTION_START_TIME

SERIALIZED_NAME_END_TIME

SERIALIZED_NAME_REMOVAL_TIME

Constructor Detail

HistoricBatchDto

Method Detail

id

getId

setId

type

getType

setType

totalJobs

getTotalJobs

setTotalJobs

batchJobsPerSeed

getBatchJobsPerSeed

setBatchJobsPerSeed

invocationsPerBatchJob

getInvocationsPerBatchJob

setInvocationsPerBatchJob

seedJobDefinitionId

getSeedJobDefinitionId

setSeedJobDefinitionId

monitorJobDefinitionId

getMonitorJobDefinitionId

setMonitorJobDefinitionId

batchJobDefinitionId

getBatchJobDefinitionId

setBatchJobDefinitionId

tenantId

getTenantId

setTenantId

createUserId

getCreateUserId

setCreateUserId

startTime

getStartTime

setStartTime

executionStartTime

getExecutionStartTime

setExecutionStartTime

endTime

getEndTime

setEndTime

removalTime

getRemovalTime

setRemovalTime

equals

hashCode

toString