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

Class ExecutionQueryDto

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

  • Field Details

  • Constructor Details

    • ExecutionQueryDto

      public ExecutionQueryDto()

  • Method Details

    • 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

    • getBusinessKey_JsonNullable

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

    • setBusinessKey_JsonNullable

      public void setBusinessKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • 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 ExecutionQueryDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      Filter by the key of the process definition the executions run on.
      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)

    • 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

    • 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)

    • activityId

      public ExecutionQueryDto activityId(String activityId)

    • getActivityId

      @Nullable public String getActivityId()
      Filter by the id of the activity the execution currently executes.
      Returns:
      activityId

    • getActivityId_JsonNullable

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

    • setActivityId_JsonNullable

      public void setActivityId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getSignalEventSubscriptionName_JsonNullable

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

    • setSignalEventSubscriptionName_JsonNullable

      public void setSignalEventSubscriptionName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getMessageEventSubscriptionName_JsonNullable

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

    • setMessageEventSubscriptionName_JsonNullable

      public void setMessageEventSubscriptionName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getActive_JsonNullable

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

    • setActive_JsonNullable

      public void setActive_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getSuspended_JsonNullable

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

    • setSuspended_JsonNullable

      public void setSuspended_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getIncidentId_JsonNullable

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

    • setIncidentId_JsonNullable

      public void setIncidentId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getIncidentType_JsonNullable

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

    • setIncidentType_JsonNullable

      public void setIncidentType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getIncidentMessage_JsonNullable

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

    • setIncidentMessage_JsonNullable

      public void setIncidentMessage_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getIncidentMessageLike_JsonNullable

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

    • setIncidentMessageLike_JsonNullable

      public void setIncidentMessageLike_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • 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)

    • 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

    • getVariables_JsonNullable

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

    • setVariables_JsonNullable

      public void setVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<VariableQueryParameterDto>> 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

    • getProcessVariables_JsonNullable

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

    • setProcessVariables_JsonNullable

      public void setProcessVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<VariableQueryParameterDto>> 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

    • 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 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

    • 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)

    • sorting

      public ExecutionQueryDto sorting(List<ExecutionQueryDtoSortingInner> sorting)

    • addSortingItem

      public ExecutionQueryDto addSortingItem(ExecutionQueryDtoSortingInner sortingItem)

    • getSorting

      @Nullable public List<ExecutionQueryDtoSortingInner> 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

    • getSorting_JsonNullable

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

    • setSorting_JsonNullable

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

    • setSorting

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