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

Class HistoricDetailQueryDto

java.lang.Object
org.camunda.community.rest.client.dto.HistoricDetailQueryDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricDetailQueryDto extends Object
A historic detail query which defines a group of historic details.

  • Field Details

  • Constructor Details

    • HistoricDetailQueryDto

      public HistoricDetailQueryDto()

  • Method Details

    • processInstanceId

      public HistoricDetailQueryDto processInstanceId(String processInstanceId)

    • getProcessInstanceId

      @Nullable public String getProcessInstanceId()
      Filter by process instance id.
      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)

    • processInstanceIdIn

      public HistoricDetailQueryDto processInstanceIdIn(List<String> processInstanceIdIn)

    • addProcessInstanceIdInItem

      public HistoricDetailQueryDto addProcessInstanceIdInItem(String processInstanceIdInItem)

    • getProcessInstanceIdIn

      @Nullable public List<String> getProcessInstanceIdIn()
      Only include historic details which belong to one of the passed process instance ids.
      Returns:
      processInstanceIdIn

    • getProcessInstanceIdIn_JsonNullable

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

    • setProcessInstanceIdIn_JsonNullable

      public void setProcessInstanceIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> processInstanceIdIn)

    • setProcessInstanceIdIn

      public void setProcessInstanceIdIn(List<String> processInstanceIdIn)

    • executionId

      public HistoricDetailQueryDto executionId(String executionId)

    • getExecutionId

      @Nullable public String getExecutionId()
      Filter by execution id.
      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 HistoricDetailQueryDto taskId(String taskId)

    • getTaskId

      @Nullable public String getTaskId()
      Filter by task id.
      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)

    • activityInstanceId

      public HistoricDetailQueryDto activityInstanceId(String activityInstanceId)

    • getActivityInstanceId

      @Nullable public String getActivityInstanceId()
      Filter by activity instance id.
      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)

    • caseInstanceId

      public HistoricDetailQueryDto caseInstanceId(String caseInstanceId)

    • getCaseInstanceId

      @Nullable public String getCaseInstanceId()
      Filter by case instance id.
      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 HistoricDetailQueryDto caseExecutionId(String caseExecutionId)

    • getCaseExecutionId

      @Nullable public String getCaseExecutionId()
      Filter by case execution id.
      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)

    • variableInstanceId

      public HistoricDetailQueryDto variableInstanceId(String variableInstanceId)

    • getVariableInstanceId

      @Nullable public String getVariableInstanceId()
      Filter by variable instance id.
      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)

    • variableTypeIn

      public HistoricDetailQueryDto variableTypeIn(List<String> variableTypeIn)

    • addVariableTypeInItem

      public HistoricDetailQueryDto addVariableTypeInItem(String variableTypeInItem)

    • getVariableTypeIn

      @Nullable public List<String> getVariableTypeIn()
      Only include historic details where the variable updates belong to one of the passed list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.21/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`.
      Returns:
      variableTypeIn

    • getVariableTypeIn_JsonNullable

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

    • setVariableTypeIn_JsonNullable

      public void setVariableTypeIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> variableTypeIn)

    • setVariableTypeIn

      public void setVariableTypeIn(List<String> variableTypeIn)

    • tenantIdIn

      public HistoricDetailQueryDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public HistoricDetailQueryDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

      @Nullable public List<String> getTenantIdIn()
      Filter by a list of tenant ids.
      Returns:
      tenantIdIn

    • getTenantIdIn_JsonNullable

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

    • setTenantIdIn_JsonNullable

      public void setTenantIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> tenantIdIn)

    • setTenantIdIn

      public void setTenantIdIn(List<String> tenantIdIn)

    • withoutTenantId

      public HistoricDetailQueryDto withoutTenantId(Boolean withoutTenantId)

    • getWithoutTenantId

      @Nullable public Boolean getWithoutTenantId()
      Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior.
      Returns:
      withoutTenantId

    • getWithoutTenantId_JsonNullable

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

    • setWithoutTenantId_JsonNullable

      public void setWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withoutTenantId)

    • setWithoutTenantId

      public void setWithoutTenantId(Boolean withoutTenantId)

    • userOperationId

      public HistoricDetailQueryDto userOperationId(String userOperationId)

    • getUserOperationId

      @Nullable public String getUserOperationId()
      Filter by a user operation id.
      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)

    • formFields

      public HistoricDetailQueryDto formFields(Boolean formFields)

    • getFormFields

      @Nullable public Boolean getFormFields()
      Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior.
      Returns:
      formFields

    • getFormFields_JsonNullable

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

    • setFormFields_JsonNullable

      public void setFormFields_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> formFields)

    • setFormFields

      public void setFormFields(Boolean formFields)

    • variableUpdates

      public HistoricDetailQueryDto variableUpdates(Boolean variableUpdates)

    • getVariableUpdates

      @Nullable public Boolean getVariableUpdates()
      Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior.
      Returns:
      variableUpdates

    • getVariableUpdates_JsonNullable

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

    • setVariableUpdates_JsonNullable

      public void setVariableUpdates_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> variableUpdates)

    • setVariableUpdates

      public void setVariableUpdates(Boolean variableUpdates)

    • excludeTaskDetails

      public HistoricDetailQueryDto excludeTaskDetails(Boolean excludeTaskDetails)

    • getExcludeTaskDetails

      @Nullable public Boolean getExcludeTaskDetails()
      Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior.
      Returns:
      excludeTaskDetails

    • getExcludeTaskDetails_JsonNullable

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

    • setExcludeTaskDetails_JsonNullable

      public void setExcludeTaskDetails_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> excludeTaskDetails)

    • setExcludeTaskDetails

      public void setExcludeTaskDetails(Boolean excludeTaskDetails)

    • initial

      public HistoricDetailQueryDto initial(Boolean initial)

    • getInitial

      @Nullable public Boolean getInitial()
      Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior.
      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)

    • occurredBefore

      public HistoricDetailQueryDto occurredBefore(OffsetDateTime occurredBefore)

    • getOccurredBefore

      @Nullable public OffsetDateTime getOccurredBefore()
      Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200.
      Returns:
      occurredBefore

    • getOccurredBefore_JsonNullable

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

    • setOccurredBefore_JsonNullable

      public void setOccurredBefore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> occurredBefore)

    • setOccurredBefore

      public void setOccurredBefore(OffsetDateTime occurredBefore)

    • occurredAfter

      public HistoricDetailQueryDto occurredAfter(OffsetDateTime occurredAfter)

    • getOccurredAfter

      @Nullable public OffsetDateTime getOccurredAfter()
      Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200.
      Returns:
      occurredAfter

    • getOccurredAfter_JsonNullable

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

    • setOccurredAfter_JsonNullable

      public void setOccurredAfter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> occurredAfter)

    • setOccurredAfter

      public void setOccurredAfter(OffsetDateTime occurredAfter)

    • sorting

      public HistoricDetailQueryDto sorting(List<HistoricDetailQueryDtoSortingInner> sorting)

    • addSortingItem

      public HistoricDetailQueryDto addSortingItem(HistoricDetailQueryDtoSortingInner sortingItem)

    • getSorting

      @Nullable public List<HistoricDetailQueryDtoSortingInner> getSorting()
      A JSON array of criteria to sort the result by. Each element of the array is a JSON object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Does not have an effect for the `count` endpoint.
      Returns:
      sorting

    • getSorting_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<HistoricDetailQueryDtoSortingInner>> getSorting_JsonNullable()

    • setSorting_JsonNullable

      public void setSorting_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<HistoricDetailQueryDtoSortingInner>> sorting)

    • setSorting

      public void setSorting(List<HistoricDetailQueryDtoSortingInner> sorting)

    • 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