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

Class BatchStatisticsDto

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

  • Field Details

  • Constructor Details

    • BatchStatisticsDto

      public BatchStatisticsDto()

  • Method Details

    • id

      public BatchStatisticsDto 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 BatchStatisticsDto 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 BatchStatisticsDto 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)

    • jobsCreated

      public BatchStatisticsDto jobsCreated(Integer jobsCreated)

    • getJobsCreated

      @Nullable public Integer getJobsCreated()
      The number of batch execution jobs already created by the seed job.
      Returns:
      jobsCreated

    • getJobsCreated_JsonNullable

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

    • setJobsCreated_JsonNullable

      public void setJobsCreated_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> jobsCreated)

    • setJobsCreated

      public void setJobsCreated(Integer jobsCreated)

    • batchJobsPerSeed

      public BatchStatisticsDto 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 BatchStatisticsDto 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 BatchStatisticsDto 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 BatchStatisticsDto 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 BatchStatisticsDto 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)

    • suspended

      public BatchStatisticsDto suspended(Boolean suspended)

    • getSuspended

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

    • getSuspended_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getSuspended_JsonNullable()

    • setSuspended_JsonNullable

      public void setSuspended_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> suspended)

    • setSuspended

      public void setSuspended(Boolean suspended)

    • tenantId

      public BatchStatisticsDto 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 BatchStatisticsDto createUserId(String createUserId)

    • getCreateUserId

      @Nullable public String getCreateUserId()
      The id of the user that created the batch.
      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 BatchStatisticsDto 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 BatchStatisticsDto 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)

    • remainingJobs

      public BatchStatisticsDto remainingJobs(Integer remainingJobs)

    • getRemainingJobs

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

    • getRemainingJobs_JsonNullable

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

    • setRemainingJobs_JsonNullable

      public void setRemainingJobs_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> remainingJobs)

    • setRemainingJobs

      public void setRemainingJobs(Integer remainingJobs)

    • completedJobs

      public BatchStatisticsDto completedJobs(Integer completedJobs)

    • getCompletedJobs

      @Nullable public Integer getCompletedJobs()
      The number of completed batch execution jobs. This does include aborted/deleted batch execution jobs.
      Returns:
      completedJobs

    • getCompletedJobs_JsonNullable

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

    • setCompletedJobs_JsonNullable

      public void setCompletedJobs_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> completedJobs)

    • setCompletedJobs

      public void setCompletedJobs(Integer completedJobs)

    • failedJobs

      public BatchStatisticsDto failedJobs(Integer failedJobs)

    • getFailedJobs

      @Nullable public Integer getFailedJobs()
      The number of failed batch execution jobs. This does not include aborted or deleted batch execution jobs.
      Returns:
      failedJobs

    • getFailedJobs_JsonNullable

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

    • setFailedJobs_JsonNullable

      public void setFailedJobs_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> failedJobs)

    • setFailedJobs

      public void setFailedJobs(Integer failedJobs)

    • 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