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

Class HistoricVariableInstanceDto

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

  • Field Details

  • Constructor Details

    • HistoricVariableInstanceDto

      public HistoricVariableInstanceDto()

  • Method Details

    • value

      public HistoricVariableInstanceDto value(Object value)

    • getValue

      @Nullable public Object getValue()
      Can be any value - string, number, boolean, array or object. **Note**: Not every endpoint supports every type.
      Returns:
      value

    • getValue_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Object> getValue_JsonNullable()

    • setValue_JsonNullable

      public void setValue_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Object> value)

    • setValue

      public void setValue(Object value)

    • type

      public HistoricVariableInstanceDto type(String type)

    • getType

      @Nullable public String getType()
      The value type of the variable.
      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)

    • valueInfo

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

    • putValueInfoItem

      public HistoricVariableInstanceDto putValueInfoItem(String key, Object valueInfoItem)

    • getValueInfo

      @Nullable public Map<String,Object> getValueInfo()
      A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object, the following properties can be provided: * `objectTypeName`: A string representation of the object's type name. * `serializationDataFormat`: The serialization format used to store the variable. For serialized variables of type File, the following properties can be provided: * `filename`: The name of the file. This is not the variable name but the name that will be used when downloading the file again. * `mimetype`: The MIME type of the file that is being uploaded. * `encoding`: The encoding of the file that is being uploaded. The following property can be provided for all value types: * `transient`: Indicates whether the variable should be transient or not. See [documentation](https://docs.camunda.org/manual/7.21/user-guide/process-engine/variables#transient-variables) for more informations. (Not applicable for `decision-definition`, ` /process-instance/variables-async`, and `/migration/executeAsync` endpoints)
      Returns:
      valueInfo

    • setValueInfo

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

    • id

      public HistoricVariableInstanceDto id(String id)

    • getId

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

    • name

      public HistoricVariableInstanceDto name(String name)

    • getName

      @Nullable public String getName()
      The name of the variable instance.
      Returns:
      name

    • getName_JsonNullable

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

    • setName_JsonNullable

      public void setName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> name)

    • setName

      public void setName(String name)

    • processDefinitionKey

      public HistoricVariableInstanceDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      The key of the process definition the variable 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 HistoricVariableInstanceDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      The id of the process definition the variable 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 HistoricVariableInstanceDto processInstanceId(String processInstanceId)

    • getProcessInstanceId

      @Nullable public String getProcessInstanceId()
      The process instance id the variable 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 HistoricVariableInstanceDto executionId(String executionId)

    • getExecutionId

      @Nullable public String getExecutionId()
      The execution id the variable instance 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)

    • activityInstanceId

      public HistoricVariableInstanceDto activityInstanceId(String activityInstanceId)

    • getActivityInstanceId

      @Nullable public String getActivityInstanceId()
      The id of the activity instance in which the variable is valid.
      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)

    • caseDefinitionKey

      public HistoricVariableInstanceDto caseDefinitionKey(String caseDefinitionKey)

    • getCaseDefinitionKey

      @Nullable public String getCaseDefinitionKey()
      The key of the case definition the variable instance 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 HistoricVariableInstanceDto caseDefinitionId(String caseDefinitionId)

    • getCaseDefinitionId

      @Nullable public String getCaseDefinitionId()
      The id of the case definition the variable instance 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 HistoricVariableInstanceDto caseInstanceId(String caseInstanceId)

    • getCaseInstanceId

      @Nullable public String getCaseInstanceId()
      The case instance id the variable instance 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 HistoricVariableInstanceDto caseExecutionId(String caseExecutionId)

    • getCaseExecutionId

      @Nullable public String getCaseExecutionId()
      The case execution id the variable instance 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 HistoricVariableInstanceDto taskId(String taskId)

    • getTaskId

      @Nullable public String getTaskId()
      The id of the task the variable instance 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 HistoricVariableInstanceDto tenantId(String tenantId)

    • getTenantId

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

    • errorMessage

      public HistoricVariableInstanceDto errorMessage(String errorMessage)

    • getErrorMessage

      @Nullable public String getErrorMessage()
      An error message in case a Java Serialized Object could not be de-serialized.
      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)

    • state

      public HistoricVariableInstanceDto state(String state)

    • getState

      @Nullable public String getState()
      The current state of the variable. Can be 'CREATED' or 'DELETED'.
      Returns:
      state

    • getState_JsonNullable

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

    • setState_JsonNullable

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

    • setState

      public void setState(String state)

    • createTime

      public HistoricVariableInstanceDto createTime(OffsetDateTime createTime)

    • getCreateTime

      @Nullable public OffsetDateTime getCreateTime()
      The time the variable was inserted. [Default format](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
      Returns:
      createTime

    • getCreateTime_JsonNullable

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

    • setCreateTime_JsonNullable

      public void setCreateTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> createTime)

    • setCreateTime

      public void setCreateTime(OffsetDateTime createTime)

    • removalTime

      public HistoricVariableInstanceDto removalTime(OffsetDateTime removalTime)

    • getRemovalTime

      @Nullable public OffsetDateTime getRemovalTime()
      The time after which the variable 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 HistoricVariableInstanceDto rootProcessInstanceId(String rootProcessInstanceId)

    • getRootProcessInstanceId

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