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

Class HistoricVariableInstanceQueryDto

java.lang.Object
org.camunda.community.rest.client.dto.HistoricVariableInstanceQueryDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricVariableInstanceQueryDto extends Object
A Historic Variable Instance instance query which defines a list of Historic Variable Instance instances

  • Field Details

  • Constructor Details

    • HistoricVariableInstanceQueryDto

      public HistoricVariableInstanceQueryDto()

  • Method Details

    • variableName

      public HistoricVariableInstanceQueryDto variableName(String variableName)

    • getVariableName

      @Nullable public String getVariableName()
      Filter by variable name.
      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)

    • variableNameLike

      public HistoricVariableInstanceQueryDto variableNameLike(String variableNameLike)

    • getVariableNameLike

      @Nullable public String getVariableNameLike()
      Restrict to variables with a name like the parameter.
      Returns:
      variableNameLike

    • getVariableNameLike_JsonNullable

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

    • setVariableNameLike_JsonNullable

      public void setVariableNameLike_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> variableNameLike)

    • setVariableNameLike

      public void setVariableNameLike(String variableNameLike)

    • variableValue

      public HistoricVariableInstanceQueryDto variableValue(Object variableValue)

    • getVariableValue

      @Nullable public Object getVariableValue()
      Filter by variable value. May be `String`, `Number` or `Boolean`.
      Returns:
      variableValue

    • setVariableValue

      public void setVariableValue(Object variableValue)

    • variableNamesIgnoreCase

      public HistoricVariableInstanceQueryDto variableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

    • getVariableNamesIgnoreCase

      @Nullable public Boolean getVariableNamesIgnoreCase()
      Match the variable name provided in `variableName` and `variableNameLike` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal.
      Returns:
      variableNamesIgnoreCase

    • getVariableNamesIgnoreCase_JsonNullable

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

    • setVariableNamesIgnoreCase_JsonNullable

      public void setVariableNamesIgnoreCase_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> variableNamesIgnoreCase)

    • setVariableNamesIgnoreCase

      public void setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

    • variableValuesIgnoreCase

      public HistoricVariableInstanceQueryDto variableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

    • getVariableValuesIgnoreCase

      @Nullable public Boolean getVariableValuesIgnoreCase()
      Match the variable value provided in `variableValue` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal.
      Returns:
      variableValuesIgnoreCase

    • getVariableValuesIgnoreCase_JsonNullable

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

    • setVariableValuesIgnoreCase_JsonNullable

      public void setVariableValuesIgnoreCase_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> variableValuesIgnoreCase)

    • setVariableValuesIgnoreCase

      public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

    • variableTypeIn

      public HistoricVariableInstanceQueryDto variableTypeIn(List<String> variableTypeIn)

    • addVariableTypeInItem

      public HistoricVariableInstanceQueryDto addVariableTypeInItem(String variableTypeInItem)

    • getVariableTypeIn

      @Nullable public List<String> getVariableTypeIn()
      Only include historic variable instances which belong to one of the passed and comma- separated 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)

    • includeDeleted

      public HistoricVariableInstanceQueryDto includeDeleted(Boolean includeDeleted)

    • getIncludeDeleted

      @Nullable public Boolean getIncludeDeleted()
      Include variables that has already been deleted during the execution.
      Returns:
      includeDeleted

    • getIncludeDeleted_JsonNullable

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

    • setIncludeDeleted_JsonNullable

      public void setIncludeDeleted_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> includeDeleted)

    • setIncludeDeleted

      public void setIncludeDeleted(Boolean includeDeleted)

    • processInstanceId

      public HistoricVariableInstanceQueryDto processInstanceId(String processInstanceId)

    • getProcessInstanceId

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

    • processInstanceIdIn

      public HistoricVariableInstanceQueryDto processInstanceIdIn(List<String> processInstanceIdIn)

    • addProcessInstanceIdInItem

      public HistoricVariableInstanceQueryDto addProcessInstanceIdInItem(String processInstanceIdInItem)

    • getProcessInstanceIdIn

      @Nullable public List<String> getProcessInstanceIdIn()
      Only include historic variable instances 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)

    • processDefinitionId

      public HistoricVariableInstanceQueryDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      Filter by the process definition the variable 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)

    • processDefinitionKey

      public HistoricVariableInstanceQueryDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      Filter by a key of the process definition the variable 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)

    • executionIdIn

      public HistoricVariableInstanceQueryDto executionIdIn(List<String> executionIdIn)

    • addExecutionIdInItem

      public HistoricVariableInstanceQueryDto addExecutionIdInItem(String executionIdInItem)

    • getExecutionIdIn

      @Nullable public List<String> getExecutionIdIn()
      Only include historic variable instances which belong to one of the passed and execution ids.
      Returns:
      executionIdIn

    • getExecutionIdIn_JsonNullable

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

    • setExecutionIdIn_JsonNullable

      public void setExecutionIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> executionIdIn)

    • setExecutionIdIn

      public void setExecutionIdIn(List<String> executionIdIn)

    • caseInstanceId

      public HistoricVariableInstanceQueryDto caseInstanceId(String caseInstanceId)

    • getCaseInstanceId

      @Nullable public String getCaseInstanceId()
      Filter by the case instance the variable 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)

    • caseExecutionIdIn

      public HistoricVariableInstanceQueryDto caseExecutionIdIn(List<String> caseExecutionIdIn)

    • addCaseExecutionIdInItem

      public HistoricVariableInstanceQueryDto addCaseExecutionIdInItem(String caseExecutionIdInItem)

    • getCaseExecutionIdIn

      @Nullable public List<String> getCaseExecutionIdIn()
      Only include historic variable instances which belong to one of the passed and case execution ids.
      Returns:
      caseExecutionIdIn

    • getCaseExecutionIdIn_JsonNullable

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

    • setCaseExecutionIdIn_JsonNullable

      public void setCaseExecutionIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> caseExecutionIdIn)

    • setCaseExecutionIdIn

      public void setCaseExecutionIdIn(List<String> caseExecutionIdIn)

    • caseActivityIdIn

      public HistoricVariableInstanceQueryDto caseActivityIdIn(List<String> caseActivityIdIn)

    • addCaseActivityIdInItem

      public HistoricVariableInstanceQueryDto addCaseActivityIdInItem(String caseActivityIdInItem)

    • getCaseActivityIdIn

      @Nullable public List<String> getCaseActivityIdIn()
      Only include historic variable instances which belong to one of the passed and case activity ids.
      Returns:
      caseActivityIdIn

    • getCaseActivityIdIn_JsonNullable

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

    • setCaseActivityIdIn_JsonNullable

      public void setCaseActivityIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> caseActivityIdIn)

    • setCaseActivityIdIn

      public void setCaseActivityIdIn(List<String> caseActivityIdIn)

    • taskIdIn

      public HistoricVariableInstanceQueryDto taskIdIn(List<String> taskIdIn)

    • addTaskIdInItem

      public HistoricVariableInstanceQueryDto addTaskIdInItem(String taskIdInItem)

    • getTaskIdIn

      @Nullable public List<String> getTaskIdIn()
      Only include historic variable instances which belong to one of the passed and task ids.
      Returns:
      taskIdIn

    • getTaskIdIn_JsonNullable

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

    • setTaskIdIn_JsonNullable

      public void setTaskIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> taskIdIn)

    • setTaskIdIn

      public void setTaskIdIn(List<String> taskIdIn)

    • activityInstanceIdIn

      public HistoricVariableInstanceQueryDto activityInstanceIdIn(List<String> activityInstanceIdIn)

    • addActivityInstanceIdInItem

      public HistoricVariableInstanceQueryDto addActivityInstanceIdInItem(String activityInstanceIdInItem)

    • getActivityInstanceIdIn

      @Nullable public List<String> getActivityInstanceIdIn()
      Only include historic variable instances which belong to one of the passed and activity instance ids.
      Returns:
      activityInstanceIdIn

    • getActivityInstanceIdIn_JsonNullable

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

    • setActivityInstanceIdIn_JsonNullable

      public void setActivityInstanceIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> activityInstanceIdIn)

    • setActivityInstanceIdIn

      public void setActivityInstanceIdIn(List<String> activityInstanceIdIn)

    • tenantIdIn

      public HistoricVariableInstanceQueryDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public HistoricVariableInstanceQueryDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

      @Nullable public List<String> getTenantIdIn()
      Only include historic variable instances which belong to one of the passed and comma- separated 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 HistoricVariableInstanceQueryDto withoutTenantId(Boolean withoutTenantId)

    • getWithoutTenantId

      @Nullable public Boolean getWithoutTenantId()
      Only include historic variable instances 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)

    • variableNameIn

      public HistoricVariableInstanceQueryDto variableNameIn(List<String> variableNameIn)

    • addVariableNameInItem

      public HistoricVariableInstanceQueryDto addVariableNameInItem(String variableNameInItem)

    • getVariableNameIn

      @Nullable public List<String> getVariableNameIn()
      Only include historic variable instances which belong to one of the passed variable names.
      Returns:
      variableNameIn

    • getVariableNameIn_JsonNullable

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

    • setVariableNameIn_JsonNullable

      public void setVariableNameIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> variableNameIn)

    • setVariableNameIn

      public void setVariableNameIn(List<String> variableNameIn)

    • sorting

      public HistoricVariableInstanceQueryDto sorting(List<HistoricVariableInstanceQueryDtoSortingInner> sorting)

    • addSortingItem

      public HistoricVariableInstanceQueryDto addSortingItem(HistoricVariableInstanceQueryDtoSortingInner sortingItem)

    • getSorting

      @Nullable public List<HistoricVariableInstanceQueryDtoSortingInner> getSorting()
      An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Sorting has no effect for `count` endpoints
      Returns:
      sorting

    • getSorting_JsonNullable

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

    • setSorting_JsonNullable

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

    • setSorting

      public void setSorting(List<HistoricVariableInstanceQueryDtoSortingInner> 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