Class HistoricActivityInstanceDto

java.lang.Object
org.camunda.community.rest.client.dto.HistoricActivityInstanceDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricActivityInstanceDto extends Object
HistoricActivityInstanceDto
  • Field Details

  • Constructor Details

    • HistoricActivityInstanceDto

      public HistoricActivityInstanceDto()
  • Method Details

    • id

    • getId

      @Nullable public String getId()
      The id of the activity 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)
    • parentActivityInstanceId

      public HistoricActivityInstanceDto parentActivityInstanceId(String parentActivityInstanceId)
    • getParentActivityInstanceId

      @Nullable public String getParentActivityInstanceId()
      The id of the parent activity instance, for example a sub process instance.
      Returns:
      parentActivityInstanceId
    • getParentActivityInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getParentActivityInstanceId_JsonNullable()
    • setParentActivityInstanceId_JsonNullable

      public void setParentActivityInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> parentActivityInstanceId)
    • setParentActivityInstanceId

      public void setParentActivityInstanceId(String parentActivityInstanceId)
    • activityId

      public HistoricActivityInstanceDto activityId(String activityId)
    • getActivityId

      @Nullable public String getActivityId()
      The id of the activity that this object is an instance of.
      Returns:
      activityId
    • getActivityId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getActivityId_JsonNullable()
    • setActivityId_JsonNullable

      public void setActivityId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityId)
    • setActivityId

      public void setActivityId(String activityId)
    • activityName

      public HistoricActivityInstanceDto activityName(String activityName)
    • getActivityName

      @Nullable public String getActivityName()
      The name of the activity that this object is an instance of.
      Returns:
      activityName
    • getActivityName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getActivityName_JsonNullable()
    • setActivityName_JsonNullable

      public void setActivityName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityName)
    • setActivityName

      public void setActivityName(String activityName)
    • activityType

      public HistoricActivityInstanceDto activityType(String activityType)
    • getActivityType

      @Nullable public String getActivityType()
      The type of the activity that this object is an instance of.
      Returns:
      activityType
    • getActivityType_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getActivityType_JsonNullable()
    • setActivityType_JsonNullable

      public void setActivityType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityType)
    • setActivityType

      public void setActivityType(String activityType)
    • processDefinitionKey

      public HistoricActivityInstanceDto processDefinitionKey(String processDefinitionKey)
    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      The key of the process definition that this activity 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)
    • processDefinitionId

      public HistoricActivityInstanceDto processDefinitionId(String processDefinitionId)
    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      The id of the process definition that this activity 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)
    • processInstanceId

      public HistoricActivityInstanceDto processInstanceId(String processInstanceId)
    • getProcessInstanceId

      @Nullable public String getProcessInstanceId()
      The id of the process instance that this activity instance belongs to.
      Returns:
      processInstanceId
    • getProcessInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessInstanceId_JsonNullable()
    • setProcessInstanceId_JsonNullable

      public void setProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processInstanceId)
    • setProcessInstanceId

      public void setProcessInstanceId(String processInstanceId)
    • executionId

      public HistoricActivityInstanceDto executionId(String executionId)
    • getExecutionId

      @Nullable public String getExecutionId()
      The id of the execution that executed this activity instance.
      Returns:
      executionId
    • getExecutionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getExecutionId_JsonNullable()
    • setExecutionId_JsonNullable

      public void setExecutionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> executionId)
    • setExecutionId

      public void setExecutionId(String executionId)
    • taskId

      public HistoricActivityInstanceDto taskId(String taskId)
    • getTaskId

      @Nullable public String getTaskId()
      The id of the task that is associated to this activity instance. Is only set if the activity is a user task.
      Returns:
      taskId
    • getTaskId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getTaskId_JsonNullable()
    • setTaskId_JsonNullable

      public void setTaskId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> taskId)
    • setTaskId

      public void setTaskId(String taskId)
    • assignee

      public HistoricActivityInstanceDto assignee(String assignee)
    • getAssignee

      @Nullable public String getAssignee()
      The assignee of the task that is associated to this activity instance. Is only set if the activity is a user task.
      Returns:
      assignee
    • getAssignee_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getAssignee_JsonNullable()
    • setAssignee_JsonNullable

      public void setAssignee_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> assignee)
    • setAssignee

      public void setAssignee(String assignee)
    • calledProcessInstanceId

      public HistoricActivityInstanceDto calledProcessInstanceId(String calledProcessInstanceId)
    • getCalledProcessInstanceId

      @Nullable public String getCalledProcessInstanceId()
      The id of the called process instance. Is only set if the activity is a call activity and the called instance a process instance.
      Returns:
      calledProcessInstanceId
    • getCalledProcessInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getCalledProcessInstanceId_JsonNullable()
    • setCalledProcessInstanceId_JsonNullable

      public void setCalledProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> calledProcessInstanceId)
    • setCalledProcessInstanceId

      public void setCalledProcessInstanceId(String calledProcessInstanceId)
    • calledCaseInstanceId

      public HistoricActivityInstanceDto calledCaseInstanceId(String calledCaseInstanceId)
    • getCalledCaseInstanceId

      @Nullable public String getCalledCaseInstanceId()
      The id of the called case instance. Is only set if the activity is a call activity and the called instance a case instance.
      Returns:
      calledCaseInstanceId
    • getCalledCaseInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getCalledCaseInstanceId_JsonNullable()
    • setCalledCaseInstanceId_JsonNullable

      public void setCalledCaseInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> calledCaseInstanceId)
    • setCalledCaseInstanceId

      public void setCalledCaseInstanceId(String calledCaseInstanceId)
    • startTime

      public HistoricActivityInstanceDto startTime(OffsetDateTime startTime)
    • getStartTime

      @Nullable public OffsetDateTime getStartTime()
      The time the instance was started. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
      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 HistoricActivityInstanceDto endTime(OffsetDateTime endTime)
    • getEndTime

      @Nullable public OffsetDateTime getEndTime()
      The time the instance ended. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
      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)
    • durationInMillis

      public HistoricActivityInstanceDto 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)
    • canceled

      public HistoricActivityInstanceDto canceled(Boolean canceled)
    • getCanceled

      @Nullable public Boolean getCanceled()
      If `true`, this activity instance is canceled.
      Returns:
      canceled
    • getCanceled_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getCanceled_JsonNullable()
    • setCanceled_JsonNullable

      public void setCanceled_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> canceled)
    • setCanceled

      public void setCanceled(Boolean canceled)
    • completeScope

      public HistoricActivityInstanceDto completeScope(Boolean completeScope)
    • getCompleteScope

      @Nullable public Boolean getCompleteScope()
      If `true`, this activity instance did complete a BPMN 2.0 scope.
      Returns:
      completeScope
    • getCompleteScope_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getCompleteScope_JsonNullable()
    • setCompleteScope_JsonNullable

      public void setCompleteScope_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> completeScope)
    • setCompleteScope

      public void setCompleteScope(Boolean completeScope)
    • tenantId

      public HistoricActivityInstanceDto tenantId(String tenantId)
    • getTenantId

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

      public HistoricActivityInstanceDto removalTime(OffsetDateTime removalTime)
    • getRemovalTime

      @Nullable public OffsetDateTime getRemovalTime()
      The time after which the activity instance should be removed by the History Cleanup job. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
      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)
    • rootProcessInstanceId

      public HistoricActivityInstanceDto rootProcessInstanceId(String rootProcessInstanceId)
    • getRootProcessInstanceId

      @Nullable public String getRootProcessInstanceId()
      The process instance id of the root process instance that initiated the process containing this activity instance.
      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)
    • 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