Package org.openapitools.client.model

Class BatchDto

  • public class BatchDto
extends Object
    BatchDto

    • Constructor Detail

      • BatchDto

        public BatchDto()

    • Method Detail

      • getId

        public String getId()
        The id of the batch.
        Returns:
        id

      • setId

        public void setId​(String id)

      • 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)

      • 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)

      • 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 BatchDto 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 BatchDto 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 BatchDto 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 BatchDto 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 BatchDto 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)

      • getSuspended

        public Boolean getSuspended()
        Indicates whether this batch is suspended or not.
        Returns:
        suspended

      • setSuspended

        public void setSuspended​(Boolean suspended)

      • getTenantId

        public String getTenantId()
        The tenant id of the batch.
        Returns:
        tenantId

      • setTenantId

        public void setTenantId​(String tenantId)

      • createUserId

        public BatchDto createUserId​(String createUserId)

      • getCreateUserId

        public String getCreateUserId()
        The id of the user that created the batch.
        Returns:
        createUserId

      • setCreateUserId

        public void setCreateUserId​(String createUserId)

      • 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 BatchDto 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)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object