ExecutionQueryDto (Camunda Platform Javadocs 7.15.19-ee)

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

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

A Execution instance query which defines a list of Execution instances

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACTIVE`
`static String`	`SERIALIZED_NAME_ACTIVITY_ID`
`static String`	`SERIALIZED_NAME_BUSINESS_KEY`
`static String`	`SERIALIZED_NAME_INCIDENT_ID`
`static String`	`SERIALIZED_NAME_INCIDENT_MESSAGE`
`static String`	`SERIALIZED_NAME_INCIDENT_MESSAGE_LIKE`
`static String`	`SERIALIZED_NAME_INCIDENT_TYPE`
`static String`	`SERIALIZED_NAME_MESSAGE_EVENT_SUBSCRIPTION_NAME`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_KEY`
`static String`	`SERIALIZED_NAME_PROCESS_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_PROCESS_VARIABLES`
`static String`	`SERIALIZED_NAME_SIGNAL_EVENT_SUBSCRIPTION_NAME`
`static String`	`SERIALIZED_NAME_SORTING`
`static String`	`SERIALIZED_NAME_SUSPENDED`
`static String`	`SERIALIZED_NAME_TENANT_ID_IN`
`static String`	`SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE`
`static String`	`SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE`
`static String`	`SERIALIZED_NAME_VARIABLES`

Constructor Summary

Constructors
Constructor and Description

ExecutionQueryDto()

Constructors
Constructor and Description
`ExecutionQueryDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExecutionQueryDto`	`active(Boolean active)`
`ExecutionQueryDto`	`activityId(String activityId)`
`ExecutionQueryDto`	`addProcessVariablesItem(VariableQueryParameterDto processVariablesItem)`
`ExecutionQueryDto`	`addSortingItem(ExecutionQueryDtoSorting sortingItem)`
`ExecutionQueryDto`	`addTenantIdInItem(String tenantIdInItem)`
`ExecutionQueryDto`	`addVariablesItem(VariableQueryParameterDto variablesItem)`
`ExecutionQueryDto`	`businessKey(String businessKey)`
`boolean`	`equals(Object o)`
`Boolean`	`getActive()` Only include active executions.
`String`	`getActivityId()` Filter by the id of the activity the execution currently executes.
`String`	`getBusinessKey()` Filter by the business key of the process instances the executions belong to.
`String`	`getIncidentId()` Filter by the incident id.
`String`	`getIncidentMessage()` Filter by the incident message.
`String`	`getIncidentMessageLike()` Filter by the incident message that the parameter is a substring of.
`String`	`getIncidentType()` Filter by the incident type.
`String`	`getMessageEventSubscriptionName()` Select only those executions that expect a message of the given name.
`String`	`getProcessDefinitionId()` Filter by the process definition the executions run on.
`String`	`getProcessDefinitionKey()` Filter by the key of the process definition the executions run on.
`String`	`getProcessInstanceId()` Filter by the id of the process instance the execution belongs to.
`List<VariableQueryParameterDto>`	`getProcessVariables()` An array to only include executions that belong to a process instance with variables with certain values.
`String`	`getSignalEventSubscriptionName()` Select only those executions that expect a signal of the given name.
`List<ExecutionQueryDtoSorting>`	`getSorting()` An array of criteria to sort the result by.
`Boolean`	`getSuspended()` Only include suspended executions.
`List<String>`	`getTenantIdIn()` Filter by a list of tenant ids.
`Boolean`	`getVariableNamesIgnoreCase()` Match all variable names provided in `variables` and `processVariables` case- insensitively.
`List<VariableQueryParameterDto>`	`getVariables()` An array to only include executions that have variables with certain values.
`Boolean`	`getVariableValuesIgnoreCase()` Match all variable values provided in `variables` and `processVariables` case- insensitively.
`int`	`hashCode()`
`ExecutionQueryDto`	`incidentId(String incidentId)`
`ExecutionQueryDto`	`incidentMessage(String incidentMessage)`
`ExecutionQueryDto`	`incidentMessageLike(String incidentMessageLike)`
`ExecutionQueryDto`	`incidentType(String incidentType)`
`ExecutionQueryDto`	`messageEventSubscriptionName(String messageEventSubscriptionName)`
`ExecutionQueryDto`	`processDefinitionId(String processDefinitionId)`
`ExecutionQueryDto`	`processDefinitionKey(String processDefinitionKey)`
`ExecutionQueryDto`	`processInstanceId(String processInstanceId)`
`ExecutionQueryDto`	`processVariables(List<VariableQueryParameterDto> processVariables)`
`void`	`setActive(Boolean active)`
`void`	`setActivityId(String activityId)`
`void`	`setBusinessKey(String businessKey)`
`void`	`setIncidentId(String incidentId)`
`void`	`setIncidentMessage(String incidentMessage)`
`void`	`setIncidentMessageLike(String incidentMessageLike)`
`void`	`setIncidentType(String incidentType)`
`void`	`setMessageEventSubscriptionName(String messageEventSubscriptionName)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessDefinitionKey(String processDefinitionKey)`
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setProcessVariables(List<VariableQueryParameterDto> processVariables)`
`void`	`setSignalEventSubscriptionName(String signalEventSubscriptionName)`
`void`	`setSorting(List<ExecutionQueryDtoSorting> sorting)`
`void`	`setSuspended(Boolean suspended)`
`void`	`setTenantIdIn(List<String> tenantIdIn)`
`void`	`setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)`
`void`	`setVariables(List<VariableQueryParameterDto> variables)`
`void`	`setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)`
`ExecutionQueryDto`	`signalEventSubscriptionName(String signalEventSubscriptionName)`
`ExecutionQueryDto`	`sorting(List<ExecutionQueryDtoSorting> sorting)`
`ExecutionQueryDto`	`suspended(Boolean suspended)`
`ExecutionQueryDto`	`tenantIdIn(List<String> tenantIdIn)`
`String`	`toString()`
`ExecutionQueryDto`	`variableNamesIgnoreCase(Boolean variableNamesIgnoreCase)`
`ExecutionQueryDto`	`variables(List<VariableQueryParameterDto> variables)`
`ExecutionQueryDto`	`variableValuesIgnoreCase(Boolean variableValuesIgnoreCase)`

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

- Field Detail
  - SERIALIZED_NAME_BUSINESS_KEY
```
public static final String SERIALIZED_NAME_BUSINESS_KEY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_DEFINITION_ID
```
public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_DEFINITION_KEY
```
public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_INSTANCE_ID
```
public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACTIVITY_ID
```
public static final String SERIALIZED_NAME_ACTIVITY_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SIGNAL_EVENT_SUBSCRIPTION_NAME
```
public static final String SERIALIZED_NAME_SIGNAL_EVENT_SUBSCRIPTION_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MESSAGE_EVENT_SUBSCRIPTION_NAME
```
public static final String SERIALIZED_NAME_MESSAGE_EVENT_SUBSCRIPTION_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACTIVE
```
public static final String SERIALIZED_NAME_ACTIVE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUSPENDED
```
public static final String SERIALIZED_NAME_SUSPENDED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INCIDENT_ID
```
public static final String SERIALIZED_NAME_INCIDENT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INCIDENT_TYPE
```
public static final String SERIALIZED_NAME_INCIDENT_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INCIDENT_MESSAGE
```
public static final String SERIALIZED_NAME_INCIDENT_MESSAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INCIDENT_MESSAGE_LIKE
```
public static final String SERIALIZED_NAME_INCIDENT_MESSAGE_LIKE
```
    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_VARIABLES
```
public static final String SERIALIZED_NAME_VARIABLES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_VARIABLES
```
public static final String SERIALIZED_NAME_PROCESS_VARIABLES
```
    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
  - ExecutionQueryDto
```
public ExecutionQueryDto()
```
- Method Detail
  - businessKey
```
public ExecutionQueryDto businessKey(String businessKey)
```
  - getBusinessKey
```
@Nullable
public String getBusinessKey()
```
    Filter by the business key of the process instances the executions belong to.
    
    Returns:
    
    businessKey
  - setBusinessKey
```
public void setBusinessKey(String businessKey)
```
  - processDefinitionId
```
public ExecutionQueryDto processDefinitionId(String processDefinitionId)
```
  - getProcessDefinitionId
```
@Nullable
public String getProcessDefinitionId()
```
    Filter by the process definition the executions run on.
    
    Returns:
    
    processDefinitionId
  - setProcessDefinitionId
```
public void setProcessDefinitionId(String processDefinitionId)
```
  - processDefinitionKey
```
public ExecutionQueryDto processDefinitionKey(String processDefinitionKey)
```
  - getProcessDefinitionKey
```
@Nullable
public String getProcessDefinitionKey()
```
    Filter by the key of the process definition the executions run on.
    
    Returns:
    
    processDefinitionKey
  - setProcessDefinitionKey
```
public void setProcessDefinitionKey(String processDefinitionKey)
```
  - processInstanceId
```
public ExecutionQueryDto processInstanceId(String processInstanceId)
```
  - getProcessInstanceId
```
@Nullable
public String getProcessInstanceId()
```
    Filter by the id of the process instance the execution belongs to.
    
    Returns:
    
    processInstanceId
  - setProcessInstanceId
```
public void setProcessInstanceId(String processInstanceId)
```
  - activityId
```
public ExecutionQueryDto activityId(String activityId)
```
  - getActivityId
```
@Nullable
public String getActivityId()
```
    Filter by the id of the activity the execution currently executes.
    
    Returns:
    
    activityId
  - setActivityId
```
public void setActivityId(String activityId)
```
  - signalEventSubscriptionName
```
public ExecutionQueryDto signalEventSubscriptionName(String signalEventSubscriptionName)
```
  - getSignalEventSubscriptionName
```
@Nullable
public String getSignalEventSubscriptionName()
```
    Select only those executions that expect a signal of the given name.
    
    Returns:
    
    signalEventSubscriptionName
  - setSignalEventSubscriptionName
```
public void setSignalEventSubscriptionName(String signalEventSubscriptionName)
```
  - messageEventSubscriptionName
```
public ExecutionQueryDto messageEventSubscriptionName(String messageEventSubscriptionName)
```
  - getMessageEventSubscriptionName
```
@Nullable
public String getMessageEventSubscriptionName()
```
    Select only those executions that expect a message of the given name.
    
    Returns:
    
    messageEventSubscriptionName
  - setMessageEventSubscriptionName
```
public void setMessageEventSubscriptionName(String messageEventSubscriptionName)
```
  - active
```
public ExecutionQueryDto active(Boolean active)
```
  - getActive
```
@Nullable
public Boolean getActive()
```
    Only include active executions. Value may only be `true`, as `false` is the default behavior.
    
    Returns:
    
    active
  - setActive
```
public void setActive(Boolean active)
```
  - suspended
```
public ExecutionQueryDto suspended(Boolean suspended)
```
  - getSuspended
```
@Nullable
public Boolean getSuspended()
```
    Only include suspended executions. Value may only be `true`, as `false` is the default behavior.
    
    Returns:
    
    suspended
  - setSuspended
```
public void setSuspended(Boolean suspended)
```
  - incidentId
```
public ExecutionQueryDto incidentId(String incidentId)
```
  - getIncidentId
```
@Nullable
public String getIncidentId()
```
    Filter by the incident id.
    
    Returns:
    
    incidentId
  - setIncidentId
```
public void setIncidentId(String incidentId)
```
  - incidentType
```
public ExecutionQueryDto incidentType(String incidentType)
```
  - getIncidentType
```
@Nullable
public String getIncidentType()
```
    Filter by the incident type. See the [User Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
    
    Returns:
    
    incidentType
  - setIncidentType
```
public void setIncidentType(String incidentType)
```
  - incidentMessage
```
public ExecutionQueryDto incidentMessage(String incidentMessage)
```
  - getIncidentMessage
```
@Nullable
public String getIncidentMessage()
```
    Filter by the incident message. Exact match.
    
    Returns:
    
    incidentMessage
  - setIncidentMessage
```
public void setIncidentMessage(String incidentMessage)
```
  - incidentMessageLike
```
public ExecutionQueryDto incidentMessageLike(String incidentMessageLike)
```
  - getIncidentMessageLike
```
@Nullable
public String getIncidentMessageLike()
```
    Filter by the incident message that the parameter is a substring of.
    
    Returns:
    
    incidentMessageLike
  - setIncidentMessageLike
```
public void setIncidentMessageLike(String incidentMessageLike)
```
  - tenantIdIn
```
public ExecutionQueryDto tenantIdIn(List<String> tenantIdIn)
```
  - addTenantIdInItem
```
public ExecutionQueryDto addTenantIdInItem(String tenantIdInItem)
```
  - getTenantIdIn
```
@Nullable
public List<String> getTenantIdIn()
```
    Filter by a list of tenant ids. An execution must have one of the given tenant ids.
    
    Returns:
    
    tenantIdIn
  - setTenantIdIn
```
public void setTenantIdIn(List<String> tenantIdIn)
```
  - variables
```
public ExecutionQueryDto variables(List<VariableQueryParameterDto> variables)
```
  - addVariablesItem
```
public ExecutionQueryDto addVariablesItem(VariableQueryParameterDto variablesItem)
```
  - getVariables
```
@Nullable
public List<VariableQueryParameterDto> getVariables()
```
    An array to only include executions that have variables with 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:
    
    variables
  - setVariables
```
public void setVariables(List<VariableQueryParameterDto> variables)
```
  - processVariables
```
public ExecutionQueryDto processVariables(List<VariableQueryParameterDto> processVariables)
```
  - addProcessVariablesItem
```
public ExecutionQueryDto addProcessVariablesItem(VariableQueryParameterDto processVariablesItem)
```
  - getProcessVariables
```
@Nullable
public List<VariableQueryParameterDto> getProcessVariables()
```
    An array to only include executions that belong to a process instance with variables with 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.
    
    Returns:
    
    processVariables
  - setProcessVariables
```
public void setProcessVariables(List<VariableQueryParameterDto> processVariables)
```
  - variableNamesIgnoreCase
```
public ExecutionQueryDto variableNamesIgnoreCase(Boolean variableNamesIgnoreCase)
```
  - getVariableNamesIgnoreCase
```
@Nullable
public Boolean getVariableNamesIgnoreCase()
```
    Match all variable names provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal.
    
    Returns:
    
    variableNamesIgnoreCase
  - setVariableNamesIgnoreCase
```
public void setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)
```
  - variableValuesIgnoreCase
```
public ExecutionQueryDto variableValuesIgnoreCase(Boolean variableValuesIgnoreCase)
```
  - getVariableValuesIgnoreCase
```
@Nullable
public Boolean getVariableValuesIgnoreCase()
```
    Match all variable values provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal.
    
    Returns:
    
    variableValuesIgnoreCase
  - setVariableValuesIgnoreCase
```
public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)
```
  - sorting
```
public ExecutionQueryDto sorting(List<ExecutionQueryDtoSorting> sorting)
```
  - addSortingItem
```
public ExecutionQueryDto addSortingItem(ExecutionQueryDtoSorting sortingItem)
```
  - getSorting
```
@Nullable
public List<ExecutionQueryDtoSorting> 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. Has no effect for the `/count` endpoint
    
    Returns:
    
    sorting
  - setSorting
```
public void setSorting(List<ExecutionQueryDtoSorting> 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 ExecutionQueryDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_BUSINESS_KEY

SERIALIZED_NAME_PROCESS_DEFINITION_ID

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

SERIALIZED_NAME_PROCESS_INSTANCE_ID

SERIALIZED_NAME_ACTIVITY_ID

SERIALIZED_NAME_SIGNAL_EVENT_SUBSCRIPTION_NAME

SERIALIZED_NAME_MESSAGE_EVENT_SUBSCRIPTION_NAME

SERIALIZED_NAME_ACTIVE

SERIALIZED_NAME_SUSPENDED

SERIALIZED_NAME_INCIDENT_ID

SERIALIZED_NAME_INCIDENT_TYPE

SERIALIZED_NAME_INCIDENT_MESSAGE

SERIALIZED_NAME_INCIDENT_MESSAGE_LIKE

SERIALIZED_NAME_TENANT_ID_IN

SERIALIZED_NAME_VARIABLES

SERIALIZED_NAME_PROCESS_VARIABLES

SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE

SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE

SERIALIZED_NAME_SORTING

Constructor Detail

ExecutionQueryDto

Method Detail

businessKey

getBusinessKey

setBusinessKey

processDefinitionId

getProcessDefinitionId

setProcessDefinitionId

processDefinitionKey

getProcessDefinitionKey

setProcessDefinitionKey

processInstanceId

getProcessInstanceId

setProcessInstanceId

activityId

getActivityId

setActivityId

signalEventSubscriptionName

getSignalEventSubscriptionName

setSignalEventSubscriptionName

messageEventSubscriptionName

getMessageEventSubscriptionName

setMessageEventSubscriptionName

active

getActive

setActive

suspended

getSuspended

setSuspended

incidentId

getIncidentId

setIncidentId

incidentType

getIncidentType

setIncidentType

incidentMessage

getIncidentMessage

setIncidentMessage

incidentMessageLike

getIncidentMessageLike

setIncidentMessageLike

tenantIdIn

addTenantIdInItem

getTenantIdIn

setTenantIdIn

variables

addVariablesItem

getVariables

setVariables

processVariables

addProcessVariablesItem

getProcessVariables

setProcessVariables

variableNamesIgnoreCase