VariableInstanceQueryDto (Camunda Platform Javadocs 7.15.19-ee)

java.lang.Object
- org.openapitools.client.model.VariableInstanceQueryDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-09-29T11:12:16.359+02:00[Europe/Berlin]")
public class VariableInstanceQueryDto
extends Object

A variable instance query which defines a list of variable instances

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACTIVITY_INSTANCE_ID_IN`
`static String`	`SERIALIZED_NAME_BATCH_ID_IN`
`static String`	`SERIALIZED_NAME_CASE_EXECUTION_ID_IN`
`static String`	`SERIALIZED_NAME_CASE_INSTANCE_ID_IN`
`static String`	`SERIALIZED_NAME_EXECUTION_ID_IN`
`static String`	`SERIALIZED_NAME_PROCESS_INSTANCE_ID_IN`
`static String`	`SERIALIZED_NAME_SORTING`
`static String`	`SERIALIZED_NAME_TASK_ID_IN`
`static String`	`SERIALIZED_NAME_TENANT_ID_IN`
`static String`	`SERIALIZED_NAME_VARIABLE_NAME`
`static String`	`SERIALIZED_NAME_VARIABLE_NAME_LIKE`
`static String`	`SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE`
`static String`	`SERIALIZED_NAME_VARIABLE_VALUES`
`static String`	`SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE`

Constructor Summary

Constructors
Constructor and Description

VariableInstanceQueryDto()

Constructors
Constructor and Description
`VariableInstanceQueryDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VariableInstanceQueryDto`	`activityInstanceIdIn(List<String> activityInstanceIdIn)`
`VariableInstanceQueryDto`	`addActivityInstanceIdInItem(String activityInstanceIdInItem)`
`VariableInstanceQueryDto`	`addBatchIdInItem(String batchIdInItem)`
`VariableInstanceQueryDto`	`addCaseExecutionIdInItem(String caseExecutionIdInItem)`
`VariableInstanceQueryDto`	`addCaseInstanceIdInItem(String caseInstanceIdInItem)`
`VariableInstanceQueryDto`	`addExecutionIdInItem(String executionIdInItem)`
`VariableInstanceQueryDto`	`addProcessInstanceIdInItem(String processInstanceIdInItem)`
`VariableInstanceQueryDto`	`addSortingItem(VariableInstanceQueryDtoSorting sortingItem)`
`VariableInstanceQueryDto`	`addTaskIdInItem(String taskIdInItem)`
`VariableInstanceQueryDto`	`addTenantIdInItem(String tenantIdInItem)`
`VariableInstanceQueryDto`	`addVariableValuesItem(VariableQueryParameterDto variableValuesItem)`
`VariableInstanceQueryDto`	`batchIdIn(List<String> batchIdIn)`
`VariableInstanceQueryDto`	`caseExecutionIdIn(List<String> caseExecutionIdIn)`
`VariableInstanceQueryDto`	`caseInstanceIdIn(List<String> caseInstanceIdIn)`
`boolean`	`equals(Object o)`
`VariableInstanceQueryDto`	`executionIdIn(List<String> executionIdIn)`
`List<String>`	`getActivityInstanceIdIn()` Only include variable instances which belong to one of the passed activity instance ids.
`List<String>`	`getBatchIdIn()` Only include variable instances which belong to one of the passed batch ids.
`List<String>`	`getCaseExecutionIdIn()` Only include variable instances which belong to one of the passed case execution ids.
`List<String>`	`getCaseInstanceIdIn()` Only include variable instances which belong to one of the passed case instance ids.
`List<String>`	`getExecutionIdIn()` Only include variable instances which belong to one of the passed execution ids.
`List<String>`	`getProcessInstanceIdIn()` Only include variable instances which belong to one of the passed process instance ids.
`List<VariableInstanceQueryDtoSorting>`	`getSorting()` An array of criteria to sort the result by.
`List<String>`	`getTaskIdIn()` Only include variable instances which belong to one of the passed task ids.
`List<String>`	`getTenantIdIn()` Only include variable instances which belong to one of the passed tenant ids.
`String`	`getVariableName()` Filter by variable instance name.
`String`	`getVariableNameLike()` Filter by the variable instance name.
`Boolean`	`getVariableNamesIgnoreCase()` Match all variable names provided in `variableValues` case-insensitively.
`List<VariableQueryParameterDto>`	`getVariableValues()` An array to only include variable instances that have the certain values.
`Boolean`	`getVariableValuesIgnoreCase()` Match all variable values provided in `variableValues` case-insensitively.
`int`	`hashCode()`
`VariableInstanceQueryDto`	`processInstanceIdIn(List<String> processInstanceIdIn)`
`void`	`setActivityInstanceIdIn(List<String> activityInstanceIdIn)`
`void`	`setBatchIdIn(List<String> batchIdIn)`
`void`	`setCaseExecutionIdIn(List<String> caseExecutionIdIn)`
`void`	`setCaseInstanceIdIn(List<String> caseInstanceIdIn)`
`void`	`setExecutionIdIn(List<String> executionIdIn)`
`void`	`setProcessInstanceIdIn(List<String> processInstanceIdIn)`
`void`	`setSorting(List<VariableInstanceQueryDtoSorting> sorting)`
`void`	`setTaskIdIn(List<String> taskIdIn)`
`void`	`setTenantIdIn(List<String> tenantIdIn)`
`void`	`setVariableName(String variableName)`
`void`	`setVariableNameLike(String variableNameLike)`
`void`	`setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)`
`void`	`setVariableValues(List<VariableQueryParameterDto> variableValues)`
`void`	`setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)`
`VariableInstanceQueryDto`	`sorting(List<VariableInstanceQueryDtoSorting> sorting)`
`VariableInstanceQueryDto`	`taskIdIn(List<String> taskIdIn)`
`VariableInstanceQueryDto`	`tenantIdIn(List<String> tenantIdIn)`
`String`	`toString()`
`VariableInstanceQueryDto`	`variableName(String variableName)`
`VariableInstanceQueryDto`	`variableNameLike(String variableNameLike)`
`VariableInstanceQueryDto`	`variableNamesIgnoreCase(Boolean variableNamesIgnoreCase)`
`VariableInstanceQueryDto`	`variableValues(List<VariableQueryParameterDto> variableValues)`
`VariableInstanceQueryDto`	`variableValuesIgnoreCase(Boolean variableValuesIgnoreCase)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_VARIABLE_NAME

public static final String SERIALIZED_NAME_VARIABLE_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_VARIABLE_NAME_LIKE

public static final String SERIALIZED_NAME_VARIABLE_NAME_LIKE

See Also:: Constant Field Values

SERIALIZED_NAME_PROCESS_INSTANCE_ID_IN

public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_EXECUTION_ID_IN

public static final String SERIALIZED_NAME_EXECUTION_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_CASE_INSTANCE_ID_IN

public static final String SERIALIZED_NAME_CASE_INSTANCE_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_CASE_EXECUTION_ID_IN

public static final String SERIALIZED_NAME_CASE_EXECUTION_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_TASK_ID_IN

public static final String SERIALIZED_NAME_TASK_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_BATCH_ID_IN

public static final String SERIALIZED_NAME_BATCH_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_ACTIVITY_INSTANCE_ID_IN

public static final String SERIALIZED_NAME_ACTIVITY_INSTANCE_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_TENANT_ID_IN

public static final String SERIALIZED_NAME_TENANT_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_VARIABLE_VALUES

public static final String SERIALIZED_NAME_VARIABLE_VALUES

See Also:: Constant Field Values

SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE

public static final String SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE

See Also:: Constant Field Values

SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE

public static final String SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE

See Also:: Constant Field Values

SERIALIZED_NAME_SORTING

public static final String SERIALIZED_NAME_SORTING

See Also:: Constant Field Values

Constructor Detail
- VariableInstanceQueryDto
```
public VariableInstanceQueryDto()
```

Method Detail

variableName

public VariableInstanceQueryDto variableName(String variableName)

getVariableName
```
@Nullable
public String getVariableName()
```
Filter by variable instance name.

Returns:

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

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

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

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

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

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

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

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

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

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

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

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

setVariableValuesIgnoreCase

public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

sorting

public VariableInstanceQueryDto sorting(List<VariableInstanceQueryDtoSorting> sorting)

addSortingItem

public VariableInstanceQueryDto addSortingItem(VariableInstanceQueryDtoSorting sortingItem)

getSorting
```
@Nullable
public List<VariableInstanceQueryDtoSorting> 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

setSorting

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

Class VariableInstanceQueryDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_VARIABLE_NAME

SERIALIZED_NAME_VARIABLE_NAME_LIKE

SERIALIZED_NAME_PROCESS_INSTANCE_ID_IN

SERIALIZED_NAME_EXECUTION_ID_IN

SERIALIZED_NAME_CASE_INSTANCE_ID_IN

SERIALIZED_NAME_CASE_EXECUTION_ID_IN

SERIALIZED_NAME_TASK_ID_IN

SERIALIZED_NAME_BATCH_ID_IN

SERIALIZED_NAME_ACTIVITY_INSTANCE_ID_IN

SERIALIZED_NAME_TENANT_ID_IN

SERIALIZED_NAME_VARIABLE_VALUES

SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE

SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE

SERIALIZED_NAME_SORTING

Constructor Detail

VariableInstanceQueryDto

Method Detail

variableName

getVariableName

setVariableName

variableNameLike

getVariableNameLike

setVariableNameLike

processInstanceIdIn

addProcessInstanceIdInItem

getProcessInstanceIdIn

setProcessInstanceIdIn

executionIdIn

addExecutionIdInItem

getExecutionIdIn

setExecutionIdIn

caseInstanceIdIn

addCaseInstanceIdInItem

getCaseInstanceIdIn

setCaseInstanceIdIn

caseExecutionIdIn

addCaseExecutionIdInItem

getCaseExecutionIdIn

setCaseExecutionIdIn

taskIdIn

addTaskIdInItem

getTaskIdIn

setTaskIdIn

batchIdIn

addBatchIdInItem

getBatchIdIn

setBatchIdIn

activityInstanceIdIn

addActivityInstanceIdInItem

getActivityInstanceIdIn

setActivityInstanceIdIn

tenantIdIn

addTenantIdInItem

getTenantIdIn

setTenantIdIn

variableValues

addVariableValuesItem

getVariableValues

setVariableValues

variableNamesIgnoreCase

getVariableNamesIgnoreCase

setVariableNamesIgnoreCase

variableValuesIgnoreCase

getVariableValuesIgnoreCase

setVariableValuesIgnoreCase

sorting

addSortingItem

getSorting

setSorting

equals

hashCode

toString