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

Class HistoricTaskInstanceReportResultDto

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

  • Field Details

  • Constructor Details

    • HistoricTaskInstanceReportResultDto

      public HistoricTaskInstanceReportResultDto()

  • Method Details

    • taskName

      public HistoricTaskInstanceReportResultDto taskName(String taskName)

    • getTaskName

      @Nullable public String getTaskName()
      The name of the task. It is only available when the `groupBy` parameter is set to `taskName`. Else the value is `null`. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`.
      Returns:
      taskName

    • getTaskName_JsonNullable

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

    • setTaskName_JsonNullable

      public void setTaskName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> taskName)

    • setTaskName

      public void setTaskName(String taskName)

    • count

      public HistoricTaskInstanceReportResultDto count(Long count)

    • getCount

      @Nullable public Long getCount()
      The number of tasks which have the given definition. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`.
      Returns:
      count

    • getCount_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getCount_JsonNullable()

    • setCount_JsonNullable

      public void setCount_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> count)

    • setCount

      public void setCount(Long count)

    • processDefinitionKey

      public HistoricTaskInstanceReportResultDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      The key of the process definition. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`.
      Returns:
      processDefinitionKey

    • getProcessDefinitionKey_JsonNullable

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

    • setProcessDefinitionKey_JsonNullable

      public void setProcessDefinitionKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionKey)

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)

    • processDefinitionId

      public HistoricTaskInstanceReportResultDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      The id of the process definition. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`.
      Returns:
      processDefinitionId

    • getProcessDefinitionId_JsonNullable

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

    • setProcessDefinitionId_JsonNullable

      public void setProcessDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionId)

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • processDefinitionName

      public HistoricTaskInstanceReportResultDto processDefinitionName(String processDefinitionName)

    • getProcessDefinitionName

      @Nullable public String getProcessDefinitionName()
      The name of the process definition. **Note:** This property is only set for a historic task report object. In these cases, the value of the `reportType` query parameter is `count`.
      Returns:
      processDefinitionName

    • getProcessDefinitionName_JsonNullable

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

    • setProcessDefinitionName_JsonNullable

      public void setProcessDefinitionName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionName)

    • setProcessDefinitionName

      public void setProcessDefinitionName(String processDefinitionName)

    • period

      public HistoricTaskInstanceReportResultDto period(Integer period)

    • getPeriod

      @Nullable public Integer getPeriod()
      Specifies a span of time within a year. **Note:** The period must be interpreted in conjunction with the returned `periodUnit`. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`.
      Returns:
      period

    • getPeriod_JsonNullable

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

    • setPeriod_JsonNullable

      public void setPeriod_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> period)

    • setPeriod

      public void setPeriod(Integer period)

    • periodUnit

      public HistoricTaskInstanceReportResultDto periodUnit(HistoricTaskInstanceReportResultDto.PeriodUnitEnum periodUnit)

    • getPeriodUnit

      @Nullable public HistoricTaskInstanceReportResultDto.PeriodUnitEnum getPeriodUnit()
      The unit of the given period. Possible values are `MONTH` and `QUARTER`. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`.
      Returns:
      periodUnit

    • getPeriodUnit_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<HistoricTaskInstanceReportResultDto.PeriodUnitEnum> getPeriodUnit_JsonNullable()

    • setPeriodUnit_JsonNullable

      public void setPeriodUnit_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<HistoricTaskInstanceReportResultDto.PeriodUnitEnum> periodUnit)

    • setPeriodUnit

      public void setPeriodUnit(HistoricTaskInstanceReportResultDto.PeriodUnitEnum periodUnit)

    • minimum

      public HistoricTaskInstanceReportResultDto minimum(Long minimum)

    • getMinimum

      @Nullable public Long getMinimum()
      The smallest duration in milliseconds of all completed process instances which were started in the given period. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`.
      Returns:
      minimum

    • getMinimum_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getMinimum_JsonNullable()

    • setMinimum_JsonNullable

      public void setMinimum_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> minimum)

    • setMinimum

      public void setMinimum(Long minimum)

    • maximum

      public HistoricTaskInstanceReportResultDto maximum(Long maximum)

    • getMaximum

      @Nullable public Long getMaximum()
      The greatest duration in milliseconds of all completed process instances which were started in the given period. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`.
      Returns:
      maximum

    • getMaximum_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getMaximum_JsonNullable()

    • setMaximum_JsonNullable

      public void setMaximum_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> maximum)

    • setMaximum

      public void setMaximum(Long maximum)

    • average

      public HistoricTaskInstanceReportResultDto average(Long average)

    • getAverage

      @Nullable public Long getAverage()
      The average duration in milliseconds of all completed process instances which were started in the given period. **Note:** This property is only set for a duration report object. In these cases, the value of the `reportType` query parameter is `duration`.
      Returns:
      average

    • getAverage_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getAverage_JsonNullable()

    • setAverage_JsonNullable

      public void setAverage_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> average)

    • setAverage

      public void setAverage(Long average)

    • tenantId

      public HistoricTaskInstanceReportResultDto tenantId(String tenantId)

    • getTenantId

      @Nullable public String getTenantId()
      The id of the tenant.
      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)

    • 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