Package org.camunda.community.rest.client.dto

Class HistoricBatchDto

java.lang.Object
org.camunda.community.rest.client.dto.HistoricBatchDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricBatchDto extends Object
HistoricBatchDto

  • Field Details

  • Constructor Details

    • HistoricBatchDto

      public HistoricBatchDto()

  • Method Details

    • id

      public HistoricBatchDto id(String id)

    • getId

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

    • getId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getId_JsonNullable()

    • setId_JsonNullable

      public void setId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> id)

    • setId

      public void setId(String id)

    • type

      public HistoricBatchDto type(String type)

    • getType

      @Nullable public String getType()
      The type of the batch. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types.
      Returns:
      type

    • getType_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getType_JsonNullable()

    • setType_JsonNullable

      public void setType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> type)

    • setType

      public void setType(String type)

    • totalJobs

      public HistoricBatchDto totalJobs(Integer totalJobs)

    • getTotalJobs

      @Nullable public Integer getTotalJobs()
      The total jobs of a batch is the number of batch execution jobs required to complete the batch.
      Returns:
      totalJobs

    • getTotalJobs_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Integer> getTotalJobs_JsonNullable()

    • setTotalJobs_JsonNullable

      public void setTotalJobs_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> totalJobs)

    • setTotalJobs

      public void setTotalJobs(Integer totalJobs)

    • batchJobsPerSeed

      public HistoricBatchDto batchJobsPerSeed(Integer batchJobsPerSeed)

    • getBatchJobsPerSeed

      @Nullable 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

    • getBatchJobsPerSeed_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Integer> getBatchJobsPerSeed_JsonNullable()

    • setBatchJobsPerSeed_JsonNullable

      public void setBatchJobsPerSeed_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> batchJobsPerSeed)

    • setBatchJobsPerSeed

      public void setBatchJobsPerSeed(Integer batchJobsPerSeed)

    • invocationsPerBatchJob

      public HistoricBatchDto invocationsPerBatchJob(Integer invocationsPerBatchJob)

    • getInvocationsPerBatchJob

      @Nullable 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

    • getInvocationsPerBatchJob_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Integer> getInvocationsPerBatchJob_JsonNullable()

    • setInvocationsPerBatchJob_JsonNullable

      public void setInvocationsPerBatchJob_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> invocationsPerBatchJob)

    • setInvocationsPerBatchJob

      public void setInvocationsPerBatchJob(Integer invocationsPerBatchJob)

    • seedJobDefinitionId

      public HistoricBatchDto seedJobDefinitionId(String seedJobDefinitionId)

    • getSeedJobDefinitionId

      @Nullable public String getSeedJobDefinitionId()
      The job definition id for the seed jobs of this batch.
      Returns:
      seedJobDefinitionId

    • getSeedJobDefinitionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getSeedJobDefinitionId_JsonNullable()

    • setSeedJobDefinitionId_JsonNullable

      public void setSeedJobDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> seedJobDefinitionId)

    • setSeedJobDefinitionId

      public void setSeedJobDefinitionId(String seedJobDefinitionId)

    • monitorJobDefinitionId

      public HistoricBatchDto monitorJobDefinitionId(String monitorJobDefinitionId)

    • getMonitorJobDefinitionId

      @Nullable public String getMonitorJobDefinitionId()
      The job definition id for the monitor jobs of this batch.
      Returns:
      monitorJobDefinitionId

    • getMonitorJobDefinitionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getMonitorJobDefinitionId_JsonNullable()

    • setMonitorJobDefinitionId_JsonNullable

      public void setMonitorJobDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> monitorJobDefinitionId)

    • setMonitorJobDefinitionId

      public void setMonitorJobDefinitionId(String monitorJobDefinitionId)

    • batchJobDefinitionId

      public HistoricBatchDto batchJobDefinitionId(String batchJobDefinitionId)

    • getBatchJobDefinitionId

      @Nullable public String getBatchJobDefinitionId()
      The job definition id for the batch execution jobs of this batch.
      Returns:
      batchJobDefinitionId

    • getBatchJobDefinitionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getBatchJobDefinitionId_JsonNullable()

    • setBatchJobDefinitionId_JsonNullable

      public void setBatchJobDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> batchJobDefinitionId)

    • setBatchJobDefinitionId

      public void setBatchJobDefinitionId(String batchJobDefinitionId)

    • tenantId

      public HistoricBatchDto tenantId(String tenantId)

    • getTenantId

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

    • getTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getTenantId_JsonNullable()

    • setTenantId_JsonNullable

      public void setTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> tenantId)

    • setTenantId

      public void setTenantId(String tenantId)

    • createUserId

      public HistoricBatchDto createUserId(String createUserId)

    • getCreateUserId

      @Nullable public String getCreateUserId()
      The batch creator's user id.
      Returns:
      createUserId

    • getCreateUserId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getCreateUserId_JsonNullable()

    • setCreateUserId_JsonNullable

      public void setCreateUserId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> createUserId)

    • setCreateUserId

      public void setCreateUserId(String createUserId)

    • startTime

      public HistoricBatchDto startTime(OffsetDateTime startTime)

    • getStartTime

      @Nullable public OffsetDateTime 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.21/reference/rest/overview/date-format/)
      Returns:
      startTime

    • getStartTime_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getStartTime_JsonNullable()

    • setStartTime_JsonNullable

      public void setStartTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> startTime)

    • setStartTime

      public void setStartTime(OffsetDateTime startTime)

    • executionStartTime

      public HistoricBatchDto executionStartTime(OffsetDateTime executionStartTime)

    • getExecutionStartTime

      @Nullable public OffsetDateTime 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.21/reference/rest/overview/date-format/)
      Returns:
      executionStartTime

    • getExecutionStartTime_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getExecutionStartTime_JsonNullable()

    • setExecutionStartTime_JsonNullable

      public void setExecutionStartTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> executionStartTime)

    • setExecutionStartTime

      public void setExecutionStartTime(OffsetDateTime executionStartTime)

    • endTime

      public HistoricBatchDto endTime(OffsetDateTime endTime)

    • getEndTime

      @Nullable public OffsetDateTime 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.21/reference/rest/overview/date-format/)
      Returns:
      endTime

    • getEndTime_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getEndTime_JsonNullable()

    • setEndTime_JsonNullable

      public void setEndTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> endTime)

    • setEndTime

      public void setEndTime(OffsetDateTime endTime)

    • removalTime

      public HistoricBatchDto removalTime(OffsetDateTime removalTime)

    • getRemovalTime

      @Nullable public OffsetDateTime 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.21/reference/rest/overview/date-format/)
      Returns:
      removalTime

    • getRemovalTime_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getRemovalTime_JsonNullable()

    • setRemovalTime_JsonNullable

      public void setRemovalTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> removalTime)

    • setRemovalTime

      public void setRemovalTime(OffsetDateTime 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

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string