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

Class HistoricProcessInstanceDto

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

  • Field Details

  • Constructor Details

    • HistoricProcessInstanceDto

      public HistoricProcessInstanceDto()

  • Method Details

    • id

      public HistoricProcessInstanceDto id(String id)

    • getId

      @Nullable public String getId()
      The id of the process instance.
      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)

    • rootProcessInstanceId

      public HistoricProcessInstanceDto rootProcessInstanceId(String rootProcessInstanceId)

    • getRootProcessInstanceId

      @Nullable public String getRootProcessInstanceId()
      The process instance id of the root process instance that initiated the process.
      Returns:
      rootProcessInstanceId

    • getRootProcessInstanceId_JsonNullable

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

    • setRootProcessInstanceId_JsonNullable

      public void setRootProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> rootProcessInstanceId)

    • setRootProcessInstanceId

      public void setRootProcessInstanceId(String rootProcessInstanceId)

    • superProcessInstanceId

      public HistoricProcessInstanceDto superProcessInstanceId(String superProcessInstanceId)

    • getSuperProcessInstanceId

      @Nullable public String getSuperProcessInstanceId()
      The id of the parent process instance, if it exists.
      Returns:
      superProcessInstanceId

    • getSuperProcessInstanceId_JsonNullable

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

    • setSuperProcessInstanceId_JsonNullable

      public void setSuperProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> superProcessInstanceId)

    • setSuperProcessInstanceId

      public void setSuperProcessInstanceId(String superProcessInstanceId)

    • superCaseInstanceId

      public HistoricProcessInstanceDto superCaseInstanceId(String superCaseInstanceId)

    • getSuperCaseInstanceId

      @Nullable public String getSuperCaseInstanceId()
      The id of the parent case instance, if it exists.
      Returns:
      superCaseInstanceId

    • getSuperCaseInstanceId_JsonNullable

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

    • setSuperCaseInstanceId_JsonNullable

      public void setSuperCaseInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> superCaseInstanceId)

    • setSuperCaseInstanceId

      public void setSuperCaseInstanceId(String superCaseInstanceId)

    • caseInstanceId

      public HistoricProcessInstanceDto caseInstanceId(String caseInstanceId)

    • getCaseInstanceId

      @Nullable public String getCaseInstanceId()
      The id of the parent case instance, if it exists.
      Returns:
      caseInstanceId

    • getCaseInstanceId_JsonNullable

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

    • setCaseInstanceId_JsonNullable

      public void setCaseInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> caseInstanceId)

    • setCaseInstanceId

      public void setCaseInstanceId(String caseInstanceId)

    • processDefinitionName

      public HistoricProcessInstanceDto processDefinitionName(String processDefinitionName)

    • getProcessDefinitionName

      @Nullable public String getProcessDefinitionName()
      The name of the process definition that this process instance belongs to.
      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)

    • processDefinitionKey

      public HistoricProcessInstanceDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      The key of the process definition that this process instance belongs to.
      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)

    • processDefinitionVersion

      public HistoricProcessInstanceDto processDefinitionVersion(Integer processDefinitionVersion)

    • getProcessDefinitionVersion

      @Nullable public Integer getProcessDefinitionVersion()
      The version of the process definition that this process instance belongs to.
      Returns:
      processDefinitionVersion

    • getProcessDefinitionVersion_JsonNullable

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

    • setProcessDefinitionVersion_JsonNullable

      public void setProcessDefinitionVersion_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> processDefinitionVersion)

    • setProcessDefinitionVersion

      public void setProcessDefinitionVersion(Integer processDefinitionVersion)

    • processDefinitionId

      public HistoricProcessInstanceDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      The id of the process definition that this process instance belongs to.
      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)

    • businessKey

      public HistoricProcessInstanceDto businessKey(String businessKey)

    • getBusinessKey

      @Nullable public String getBusinessKey()
      The business key of the process instance.
      Returns:
      businessKey

    • getBusinessKey_JsonNullable

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

    • setBusinessKey_JsonNullable

      public void setBusinessKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> businessKey)

    • setBusinessKey

      public void setBusinessKey(String businessKey)

    • startTime

      public HistoricProcessInstanceDto startTime(OffsetDateTime startTime)

    • getStartTime

      @Nullable public OffsetDateTime getStartTime()
      The time the instance was started. Default [format](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
      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)

    • endTime

      public HistoricProcessInstanceDto endTime(OffsetDateTime endTime)

    • getEndTime

      @Nullable public OffsetDateTime getEndTime()
      The time the instance ended. Default [format](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
      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 HistoricProcessInstanceDto removalTime(OffsetDateTime removalTime)

    • getRemovalTime

      @Nullable public OffsetDateTime getRemovalTime()
      The time after which the instance should be removed by the History Cleanup job. Default [format](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
      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)

    • durationInMillis

      public HistoricProcessInstanceDto durationInMillis(Long durationInMillis)

    • getDurationInMillis

      @Nullable public Long getDurationInMillis()
      The time the instance took to finish (in milliseconds).
      Returns:
      durationInMillis

    • getDurationInMillis_JsonNullable

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

    • setDurationInMillis_JsonNullable

      public void setDurationInMillis_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> durationInMillis)

    • setDurationInMillis

      public void setDurationInMillis(Long durationInMillis)

    • startUserId

      public HistoricProcessInstanceDto startUserId(String startUserId)

    • getStartUserId

      @Nullable public String getStartUserId()
      The id of the user who started the process instance.
      Returns:
      startUserId

    • getStartUserId_JsonNullable

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

    • setStartUserId_JsonNullable

      public void setStartUserId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> startUserId)

    • setStartUserId

      public void setStartUserId(String startUserId)

    • startActivityId

      public HistoricProcessInstanceDto startActivityId(String startActivityId)

    • getStartActivityId

      @Nullable public String getStartActivityId()
      The id of the initial activity that was executed (e.g., a start event).
      Returns:
      startActivityId

    • getStartActivityId_JsonNullable

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

    • setStartActivityId_JsonNullable

      public void setStartActivityId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> startActivityId)

    • setStartActivityId

      public void setStartActivityId(String startActivityId)

    • deleteReason

      public HistoricProcessInstanceDto deleteReason(String deleteReason)

    • getDeleteReason

      @Nullable public String getDeleteReason()
      The provided delete reason in case the process instance was canceled during execution.
      Returns:
      deleteReason

    • getDeleteReason_JsonNullable

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

    • setDeleteReason_JsonNullable

      public void setDeleteReason_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> deleteReason)

    • setDeleteReason

      public void setDeleteReason(String deleteReason)

    • tenantId

      public HistoricProcessInstanceDto tenantId(String tenantId)

    • getTenantId

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

    • state

      public HistoricProcessInstanceDto state(HistoricProcessInstanceDto.StateEnum state)

    • getState

      @Nullable public HistoricProcessInstanceDto.StateEnum getState()
      Last state of the process instance, possible values are: `ACTIVE` - running process instance `SUSPENDED` - suspended process instances `COMPLETED` - completed through normal end event `EXTERNALLY_TERMINATED` - terminated externally, for instance through REST API `INTERNALLY_TERMINATED` - terminated internally, for instance by terminating boundary event
      Returns:
      state

    • getState_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<HistoricProcessInstanceDto.StateEnum> getState_JsonNullable()

    • setState_JsonNullable

      public void setState_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<HistoricProcessInstanceDto.StateEnum> state)

    • setState

      public void setState(HistoricProcessInstanceDto.StateEnum state)

    • 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