Package org.openapitools.client.model

Class ExternalTaskQueryDto

  • public class ExternalTaskQueryDto
extends Object
    A JSON object with the following properties:

    • Constructor Detail

      • ExternalTaskQueryDto

        public ExternalTaskQueryDto()

    • Method Detail

      • getExternalTaskId

        public String getExternalTaskId()
        Filter by an external task's id.
        Returns:
        externalTaskId

      • setExternalTaskId

        public void setExternalTaskId​(String externalTaskId)

      • getExternalTaskIdIn

        public List<String> getExternalTaskIdIn()
        Filter by the comma-separated list of external task ids.
        Returns:
        externalTaskIdIn

      • setExternalTaskIdIn

        public void setExternalTaskIdIn​(List<String> externalTaskIdIn)

      • getTopicName

        public String getTopicName()
        Filter by an external task topic.
        Returns:
        topicName

      • setTopicName

        public void setTopicName​(String topicName)

      • getWorkerId

        public String getWorkerId()
        Filter by the id of the worker that the task was most recently locked by.
        Returns:
        workerId

      • setWorkerId

        public void setWorkerId​(String workerId)

      • getLocked

        public Boolean getLocked()
        Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task.
        Returns:
        locked

      • setLocked

        public void setLocked​(Boolean locked)

      • getNotLocked

        public Boolean getNotLocked()
        Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task.
        Returns:
        notLocked

      • setNotLocked

        public void setNotLocked​(Boolean notLocked)

      • getWithRetriesLeft

        public Boolean getWithRetriesLeft()
        Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task.
        Returns:
        withRetriesLeft

      • setWithRetriesLeft

        public void setWithRetriesLeft​(Boolean withRetriesLeft)

      • getNoRetriesLeft

        public Boolean getNoRetriesLeft()
        Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task.
        Returns:
        noRetriesLeft

      • setNoRetriesLeft

        public void setNoRetriesLeft​(Boolean noRetriesLeft)

      • getLockExpirationAfter

        public Date getLockExpirationAfter()
        Restrict to external tasks that have a lock that expires after a given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        lockExpirationAfter

      • setLockExpirationAfter

        public void setLockExpirationAfter​(Date lockExpirationAfter)

      • getLockExpirationBefore

        public Date getLockExpirationBefore()
        Restrict to external tasks that have a lock that expires before a given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        lockExpirationBefore

      • setLockExpirationBefore

        public void setLockExpirationBefore​(Date lockExpirationBefore)

      • getActivityId

        public String getActivityId()
        Filter by the id of the activity that an external task is created for.
        Returns:
        activityId

      • setActivityId

        public void setActivityId​(String activityId)

      • getActivityIdIn

        public List<String> getActivityIdIn()
        Filter by the comma-separated list of ids of the activities that an external task is created for.
        Returns:
        activityIdIn

      • setActivityIdIn

        public void setActivityIdIn​(List<String> activityIdIn)

      • getExecutionId

        public String getExecutionId()
        Filter by the id of the execution that an external task belongs to.
        Returns:
        executionId

      • setExecutionId

        public void setExecutionId​(String executionId)

      • getProcessInstanceId

        public String getProcessInstanceId()
        Filter by the id of the process instance that an external task belongs to.
        Returns:
        processInstanceId

      • setProcessInstanceId

        public void setProcessInstanceId​(String processInstanceId)

      • getProcessInstanceIdIn

        public List<String> getProcessInstanceIdIn()
        Filter by a comma-separated list of process instance ids that an external task may belong to.
        Returns:
        processInstanceIdIn

      • setProcessInstanceIdIn

        public void setProcessInstanceIdIn​(List<String> processInstanceIdIn)

      • getProcessDefinitionId

        public String getProcessDefinitionId()
        Filter by the id of the process definition that an external task belongs to.
        Returns:
        processDefinitionId

      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)

      • getTenantIdIn

        public List<String> getTenantIdIn()
        Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids.
        Returns:
        tenantIdIn

      • setTenantIdIn

        public void setTenantIdIn​(List<String> tenantIdIn)

      • getActive

        public Boolean getActive()
        Only include active tasks. Value may only be `true`, as `false` matches any external task.
        Returns:
        active

      • setActive

        public void setActive​(Boolean active)

      • getSuspended

        public Boolean getSuspended()
        Only include suspended tasks. Value may only be `true`, as `false` matches any external task.
        Returns:
        suspended

      • setSuspended

        public void setSuspended​(Boolean suspended)

      • priorityHigherThanOrEquals

        public ExternalTaskQueryDto priorityHigherThanOrEquals​(Long priorityHigherThanOrEquals)

      • getPriorityHigherThanOrEquals

        public Long getPriorityHigherThanOrEquals()
        Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value.
        Returns:
        priorityHigherThanOrEquals

      • setPriorityHigherThanOrEquals

        public void setPriorityHigherThanOrEquals​(Long priorityHigherThanOrEquals)

      • getPriorityLowerThanOrEquals

        public Long getPriorityLowerThanOrEquals()
        Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value.
        Returns:
        priorityLowerThanOrEquals

      • setPriorityLowerThanOrEquals

        public void setPriorityLowerThanOrEquals​(Long priorityLowerThanOrEquals)

      • getSorting

        public List<ExternalTaskQueryDtoSorting> getSorting()
        A JSON array of criteria to sort the result by. Each element of the array is a JSON object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. The ordering objects have the following properties: **Note:** The `sorting` properties will not be applied to the External Task count query.
        Returns:
        sorting

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object