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

Class VariableInstanceQueryDto

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

  • Field Details

  • Constructor Details

    • VariableInstanceQueryDto

      public VariableInstanceQueryDto()

  • Method Details

    • variableName

      public VariableInstanceQueryDto variableName(String variableName)

    • getVariableName

      @Nullable public String getVariableName()
      Filter by variable instance 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 VariableInstanceQueryDto variableNameLike(String variableNameLike)

    • getVariableNameLike

      @Nullable public String getVariableNameLike()
      Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`).
      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)

    • processInstanceIdIn

      public VariableInstanceQueryDto processInstanceIdIn(List<String> processInstanceIdIn)

    • addProcessInstanceIdInItem

      public VariableInstanceQueryDto addProcessInstanceIdInItem(String processInstanceIdInItem)

    • getProcessInstanceIdIn

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

    • executionIdIn

      public VariableInstanceQueryDto executionIdIn(List<String> executionIdIn)

    • addExecutionIdInItem

      public VariableInstanceQueryDto addExecutionIdInItem(String executionIdInItem)

    • getExecutionIdIn

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

    • caseInstanceIdIn

      public VariableInstanceQueryDto caseInstanceIdIn(List<String> caseInstanceIdIn)

    • addCaseInstanceIdInItem

      public VariableInstanceQueryDto addCaseInstanceIdInItem(String caseInstanceIdInItem)

    • getCaseInstanceIdIn

      @Nullable public List<String> getCaseInstanceIdIn()
      Only include variable instances which belong to one of the passed case instance ids.
      Returns:
      caseInstanceIdIn

    • getCaseInstanceIdIn_JsonNullable

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

    • setCaseInstanceIdIn_JsonNullable

      public void setCaseInstanceIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> caseInstanceIdIn)

    • setCaseInstanceIdIn

      public void setCaseInstanceIdIn(List<String> caseInstanceIdIn)

    • caseExecutionIdIn

      public VariableInstanceQueryDto caseExecutionIdIn(List<String> caseExecutionIdIn)

    • addCaseExecutionIdInItem

      public VariableInstanceQueryDto addCaseExecutionIdInItem(String caseExecutionIdInItem)

    • getCaseExecutionIdIn

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

    • taskIdIn

      public VariableInstanceQueryDto taskIdIn(List<String> taskIdIn)

    • addTaskIdInItem

      public VariableInstanceQueryDto addTaskIdInItem(String taskIdInItem)

    • getTaskIdIn

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

    • batchIdIn

      public VariableInstanceQueryDto batchIdIn(List<String> batchIdIn)

    • addBatchIdInItem

      public VariableInstanceQueryDto addBatchIdInItem(String batchIdInItem)

    • getBatchIdIn

      @Nullable public List<String> getBatchIdIn()
      Only include variable instances which belong to one of the passed batch ids.
      Returns:
      batchIdIn

    • getBatchIdIn_JsonNullable

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

    • setBatchIdIn_JsonNullable

      public void setBatchIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> batchIdIn)

    • setBatchIdIn

      public void setBatchIdIn(List<String> batchIdIn)

    • activityInstanceIdIn

      public VariableInstanceQueryDto activityInstanceIdIn(List<String> activityInstanceIdIn)

    • addActivityInstanceIdInItem

      public VariableInstanceQueryDto addActivityInstanceIdInItem(String activityInstanceIdInItem)

    • getActivityInstanceIdIn

      @Nullable public List<String> getActivityInstanceIdIn()
      Only include variable instances which belong to one of the passed 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 VariableInstanceQueryDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public VariableInstanceQueryDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

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

    • variableValues

      public VariableInstanceQueryDto variableValues(List<VariableQueryParameterDto> variableValues)

    • addVariableValuesItem

      public VariableInstanceQueryDto addVariableValuesItem(VariableQueryParameterDto variableValuesItem)

    • getVariableValues

      @Nullable public List<VariableQueryParameterDto> getVariableValues()
      An array to only include variable instances that have the certain values. The array consists of objects with the three properties `name`, `operator` and `value`. `name (String)` is the variable name, `operator (String)` is the comparison operator to be used and `value` the variable value. `value` may be `String`, `Number` or `Boolean`. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`
      Returns:
      variableValues

    • getVariableValues_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<VariableQueryParameterDto>> getVariableValues_JsonNullable()

    • setVariableValues_JsonNullable

      public void setVariableValues_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<VariableQueryParameterDto>> variableValues)

    • setVariableValues

      public void setVariableValues(List<VariableQueryParameterDto> variableValues)

    • variableNamesIgnoreCase

      public VariableInstanceQueryDto variableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

    • getVariableNamesIgnoreCase

      @Nullable public Boolean getVariableNamesIgnoreCase()
      Match all variable names provided in `variableValues` 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 VariableInstanceQueryDto variableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

    • getVariableValuesIgnoreCase

      @Nullable public Boolean getVariableValuesIgnoreCase()
      Match all variable values provided in `variableValues` 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)

    • variableScopeIdIn

      public VariableInstanceQueryDto variableScopeIdIn(List<String> variableScopeIdIn)

    • addVariableScopeIdInItem

      public VariableInstanceQueryDto addVariableScopeIdInItem(String variableScopeIdInItem)

    • getVariableScopeIdIn

      @Nullable public List<String> getVariableScopeIdIn()
      Only include variable instances which belong to one of passed scope ids.
      Returns:
      variableScopeIdIn

    • getVariableScopeIdIn_JsonNullable

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

    • setVariableScopeIdIn_JsonNullable

      public void setVariableScopeIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> variableScopeIdIn)

    • setVariableScopeIdIn

      public void setVariableScopeIdIn(List<String> variableScopeIdIn)

    • sorting

      public VariableInstanceQueryDto sorting(List<VariableInstanceQueryDtoSortingInner> sorting)

    • addSortingItem

      public VariableInstanceQueryDto addSortingItem(VariableInstanceQueryDtoSortingInner sortingItem)

    • getSorting

      @Nullable public List<VariableInstanceQueryDtoSortingInner> 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<VariableInstanceQueryDtoSortingInner>> getSorting_JsonNullable()

    • setSorting_JsonNullable

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

    • setSorting

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