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

Class HistoricDetailDto

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

  • Field Details

  • Constructor Details

    • HistoricDetailDto

      public HistoricDetailDto()

  • Method Details

    • id

      public HistoricDetailDto id(String id)

    • getId

      @Nullable public String getId()
      The id of the historic detail.
      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 HistoricDetailDto type(String type)

    • getType

      @Nullable public String getType()
      The type of the historic detail. Either `formField` for a submitted form field value or `variableUpdate` for variable updates.
      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)

    • processDefinitionKey

      public HistoricDetailDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

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

    • getProcessDefinitionId

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

    • getProcessInstanceId

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

    • activityInstanceId

      public HistoricDetailDto activityInstanceId(String activityInstanceId)

    • getActivityInstanceId

      @Nullable public String getActivityInstanceId()
      The id of the activity instance the historic detail belongs to.
      Returns:
      activityInstanceId

    • getActivityInstanceId_JsonNullable

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

    • setActivityInstanceId_JsonNullable

      public void setActivityInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityInstanceId)

    • setActivityInstanceId

      public void setActivityInstanceId(String activityInstanceId)

    • executionId

      public HistoricDetailDto executionId(String executionId)

    • getExecutionId

      @Nullable public String getExecutionId()
      The id of the execution the historic detail belongs to.
      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)

    • caseDefinitionKey

      public HistoricDetailDto caseDefinitionKey(String caseDefinitionKey)

    • getCaseDefinitionKey

      @Nullable public String getCaseDefinitionKey()
      The key of the case definition that this historic detail belongs to.
      Returns:
      caseDefinitionKey

    • getCaseDefinitionKey_JsonNullable

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

    • setCaseDefinitionKey_JsonNullable

      public void setCaseDefinitionKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> caseDefinitionKey)

    • setCaseDefinitionKey

      public void setCaseDefinitionKey(String caseDefinitionKey)

    • caseDefinitionId

      public HistoricDetailDto caseDefinitionId(String caseDefinitionId)

    • getCaseDefinitionId

      @Nullable public String getCaseDefinitionId()
      The id of the case definition that this historic detail belongs to.
      Returns:
      caseDefinitionId

    • getCaseDefinitionId_JsonNullable

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

    • setCaseDefinitionId_JsonNullable

      public void setCaseDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> caseDefinitionId)

    • setCaseDefinitionId

      public void setCaseDefinitionId(String caseDefinitionId)

    • caseInstanceId

      public HistoricDetailDto caseInstanceId(String caseInstanceId)

    • getCaseInstanceId

      @Nullable public String getCaseInstanceId()
      The id of the case instance the historic detail belongs to.
      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)

    • caseExecutionId

      public HistoricDetailDto caseExecutionId(String caseExecutionId)

    • getCaseExecutionId

      @Nullable public String getCaseExecutionId()
      The id of the case execution the historic detail belongs to.
      Returns:
      caseExecutionId

    • getCaseExecutionId_JsonNullable

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

    • setCaseExecutionId_JsonNullable

      public void setCaseExecutionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> caseExecutionId)

    • setCaseExecutionId

      public void setCaseExecutionId(String caseExecutionId)

    • taskId

      public HistoricDetailDto taskId(String taskId)

    • getTaskId

      @Nullable public String getTaskId()
      The id of the task the historic detail belongs to.
      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)

    • tenantId

      public HistoricDetailDto tenantId(String tenantId)

    • getTenantId

      @Nullable public String getTenantId()
      The id of the tenant that this historic detail belongs to.
      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)

    • userOperationId

      public HistoricDetailDto userOperationId(String userOperationId)

    • getUserOperationId

      @Nullable public String getUserOperationId()
      The id of user operation which links historic detail with [user operation log](https://docs.camunda.org/manual/7.21/reference/rest/history/user-operation-log/) entries.
      Returns:
      userOperationId

    • getUserOperationId_JsonNullable

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

    • setUserOperationId_JsonNullable

      public void setUserOperationId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> userOperationId)

    • setUserOperationId

      public void setUserOperationId(String userOperationId)

    • time

      public HistoricDetailDto time(OffsetDateTime time)

    • getTime

      @Nullable public OffsetDateTime getTime()
      The time when this historic detail occurred. Default [format](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
      Returns:
      time

    • getTime_JsonNullable

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

    • setTime_JsonNullable

      public void setTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> time)

    • setTime

      public void setTime(OffsetDateTime time)

    • removalTime

      public HistoricDetailDto removalTime(OffsetDateTime removalTime)

    • getRemovalTime

      @Nullable public OffsetDateTime getRemovalTime()
      The time after which the historic detail 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)

    • rootProcessInstanceId

      public HistoricDetailDto rootProcessInstanceId(String rootProcessInstanceId)

    • getRootProcessInstanceId

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

    • fieldId

      public HistoricDetailDto fieldId(String fieldId)

    • getFieldId

      @Nullable public String getFieldId()
      The id of the form field. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `formField`.
      Returns:
      fieldId

    • getFieldId_JsonNullable

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

    • setFieldId_JsonNullable

      public void setFieldId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> fieldId)

    • setFieldId

      public void setFieldId(String fieldId)

    • fieldValue

      public HistoricDetailDto fieldValue(Object fieldValue)

    • getFieldValue

      @Nullable public Object getFieldValue()
      The submitted form field value. The value differs depending on the form field's type and on the `deserializeValue` parameter. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `formField`.
      Returns:
      fieldValue

    • setFieldValue

      public void setFieldValue(Object fieldValue)

    • variableName

      public HistoricDetailDto variableName(String variableName)

    • getVariableName

      @Nullable public String getVariableName()
      The name of the variable which has been updated. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
      Returns:
      variableName

    • getVariableName_JsonNullable

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

    • setVariableName_JsonNullable

      public void setVariableName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> variableName)

    • setVariableName

      public void setVariableName(String variableName)

    • variableInstanceId

      public HistoricDetailDto variableInstanceId(String variableInstanceId)

    • getVariableInstanceId

      @Nullable public String getVariableInstanceId()
      The id of the associated variable instance. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
      Returns:
      variableInstanceId

    • getVariableInstanceId_JsonNullable

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

    • setVariableInstanceId_JsonNullable

      public void setVariableInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> variableInstanceId)

    • setVariableInstanceId

      public void setVariableInstanceId(String variableInstanceId)

    • variableType

      public HistoricDetailDto variableType(String variableType)

    • getVariableType

      @Nullable public String getVariableType()
      The value type of the variable. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
      Returns:
      variableType

    • getVariableType_JsonNullable

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

    • setVariableType_JsonNullable

      public void setVariableType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> variableType)

    • setVariableType

      public void setVariableType(String variableType)

    • value

      public HistoricDetailDto value(Object value)

    • getValue

      @Nullable public Object getValue()
      The variable's value. Value differs depending on the variable's type and on the deserializeValues parameter. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
      Returns:
      value

    • setValue

      public void setValue(Object value)

    • valueInfo

      public HistoricDetailDto valueInfo(Map<String,Object> valueInfo)

    • putValueInfoItem

      public HistoricDetailDto putValueInfoItem(String key, Object valueInfoItem)

    • getValueInfo

      @Nullable public Map<String,Object> getValueInfo()
      A JSON object containing additional, value-type-dependent properties. For variables of type `Object`, the following properties are returned: * `objectTypeName`: A string representation of the object's type name. * `serializationDataFormat`: The serialization format used to store the variable. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
      Returns:
      valueInfo

    • setValueInfo

      public void setValueInfo(Map<String,Object> valueInfo)

    • initial

      public HistoricDetailDto initial(Boolean initial)

    • getInitial

      @Nullable public Boolean getInitial()
      Returns `true` for variable updates that contains the initial values of the variables. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
      Returns:
      initial

    • getInitial_JsonNullable

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

    • setInitial_JsonNullable

      public void setInitial_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> initial)

    • setInitial

      public void setInitial(Boolean initial)

    • revision

      public HistoricDetailDto revision(Integer revision)

    • getRevision

      @Nullable public Integer getRevision()
      The revision of the historic variable update. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
      Returns:
      revision

    • getRevision_JsonNullable

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

    • setRevision_JsonNullable

      public void setRevision_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> revision)

    • setRevision

      public void setRevision(Integer revision)

    • errorMessage

      public HistoricDetailDto errorMessage(String errorMessage)

    • getErrorMessage

      @Nullable public String getErrorMessage()
      An error message in case a Java Serialized Object could not be de-serialized. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
      Returns:
      errorMessage

    • getErrorMessage_JsonNullable

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

    • setErrorMessage_JsonNullable

      public void setErrorMessage_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> errorMessage)

    • setErrorMessage

      public void setErrorMessage(String errorMessage)

    • 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