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

Class ExternalTaskQueryDto

java.lang.Object
org.camunda.community.rest.client.dto.ExternalTaskQueryDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class ExternalTaskQueryDto extends Object
A JSON object with the following properties:

  • Field Details

  • Constructor Details

    • ExternalTaskQueryDto

      public ExternalTaskQueryDto()

  • Method Details

    • externalTaskId

      public ExternalTaskQueryDto externalTaskId(String externalTaskId)

    • getExternalTaskId

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

    • getExternalTaskId_JsonNullable

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

    • setExternalTaskId_JsonNullable

      public void setExternalTaskId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> externalTaskId)

    • setExternalTaskId

      public void setExternalTaskId(String externalTaskId)

    • externalTaskIdIn

      public ExternalTaskQueryDto externalTaskIdIn(List<String> externalTaskIdIn)

    • addExternalTaskIdInItem

      public ExternalTaskQueryDto addExternalTaskIdInItem(String externalTaskIdInItem)

    • getExternalTaskIdIn

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

    • getExternalTaskIdIn_JsonNullable

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

    • setExternalTaskIdIn_JsonNullable

      public void setExternalTaskIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> externalTaskIdIn)

    • setExternalTaskIdIn

      public void setExternalTaskIdIn(List<String> externalTaskIdIn)

    • topicName

      public ExternalTaskQueryDto topicName(String topicName)

    • getTopicName

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

    • getTopicName_JsonNullable

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

    • setTopicName_JsonNullable

      public void setTopicName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> topicName)

    • setTopicName

      public void setTopicName(String topicName)

    • workerId

      public ExternalTaskQueryDto workerId(String workerId)

    • getWorkerId

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

    • getWorkerId_JsonNullable

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

    • setWorkerId_JsonNullable

      public void setWorkerId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> workerId)

    • setWorkerId

      public void setWorkerId(String workerId)

    • locked

      public ExternalTaskQueryDto locked(Boolean locked)

    • getLocked

      @Nullable 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

    • getLocked_JsonNullable

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

    • setLocked_JsonNullable

      public void setLocked_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> locked)

    • setLocked

      public void setLocked(Boolean locked)

    • notLocked

      public ExternalTaskQueryDto notLocked(Boolean notLocked)

    • getNotLocked

      @Nullable 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

    • getNotLocked_JsonNullable

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

    • setNotLocked_JsonNullable

      public void setNotLocked_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> notLocked)

    • setNotLocked

      public void setNotLocked(Boolean notLocked)

    • withRetriesLeft

      public ExternalTaskQueryDto withRetriesLeft(Boolean withRetriesLeft)

    • getWithRetriesLeft

      @Nullable 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

    • getWithRetriesLeft_JsonNullable

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

    • setWithRetriesLeft_JsonNullable

      public void setWithRetriesLeft_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withRetriesLeft)

    • setWithRetriesLeft

      public void setWithRetriesLeft(Boolean withRetriesLeft)

    • noRetriesLeft

      public ExternalTaskQueryDto noRetriesLeft(Boolean noRetriesLeft)

    • getNoRetriesLeft

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

    • getNoRetriesLeft_JsonNullable

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

    • setNoRetriesLeft_JsonNullable

      public void setNoRetriesLeft_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> noRetriesLeft)

    • setNoRetriesLeft

      public void setNoRetriesLeft(Boolean noRetriesLeft)

    • lockExpirationAfter

      public ExternalTaskQueryDto lockExpirationAfter(OffsetDateTime lockExpirationAfter)

    • getLockExpirationAfter

      @Nullable public OffsetDateTime getLockExpirationAfter()
      Restrict to external tasks that have a lock that expires after a given date. By [default](https://docs.camunda.org/manual/7.21/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

    • getLockExpirationAfter_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getLockExpirationAfter_JsonNullable()

    • setLockExpirationAfter_JsonNullable

      public void setLockExpirationAfter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> lockExpirationAfter)

    • setLockExpirationAfter

      public void setLockExpirationAfter(OffsetDateTime lockExpirationAfter)

    • lockExpirationBefore

      public ExternalTaskQueryDto lockExpirationBefore(OffsetDateTime lockExpirationBefore)

    • getLockExpirationBefore

      @Nullable public OffsetDateTime getLockExpirationBefore()
      Restrict to external tasks that have a lock that expires before a given date. By [default](https://docs.camunda.org/manual/7.21/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

    • getLockExpirationBefore_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getLockExpirationBefore_JsonNullable()

    • setLockExpirationBefore_JsonNullable

      public void setLockExpirationBefore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> lockExpirationBefore)

    • setLockExpirationBefore

      public void setLockExpirationBefore(OffsetDateTime lockExpirationBefore)

    • activityId

      public ExternalTaskQueryDto activityId(String activityId)

    • getActivityId

      @Nullable public String getActivityId()
      Filter by the id of the activity that an external task is created for.
      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)

    • activityIdIn

      public ExternalTaskQueryDto activityIdIn(List<String> activityIdIn)

    • addActivityIdInItem

      public ExternalTaskQueryDto addActivityIdInItem(String activityIdInItem)

    • getActivityIdIn

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

    • getActivityIdIn_JsonNullable

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

    • setActivityIdIn_JsonNullable

      public void setActivityIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> activityIdIn)

    • setActivityIdIn

      public void setActivityIdIn(List<String> activityIdIn)

    • executionId

      public ExternalTaskQueryDto executionId(String executionId)

    • getExecutionId

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

    • getExecutionId_JsonNullable

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

    • setExecutionId_JsonNullable

      public void setExecutionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> executionId)

    • setExecutionId

      public void setExecutionId(String executionId)

    • processInstanceId

      public ExternalTaskQueryDto processInstanceId(String processInstanceId)

    • getProcessInstanceId

      @Nullable public String getProcessInstanceId()
      Filter by the id of the process instance that an external task 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)

    • processInstanceIdIn

      public ExternalTaskQueryDto processInstanceIdIn(List<String> processInstanceIdIn)

    • addProcessInstanceIdInItem

      public ExternalTaskQueryDto addProcessInstanceIdInItem(String processInstanceIdInItem)

    • getProcessInstanceIdIn

      @Nullable public List<String> getProcessInstanceIdIn()
      Filter by a comma-separated list of process instance ids that an external task may belong to.
      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)

    • processDefinitionId

      public ExternalTaskQueryDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      Filter by the id of the process definition that an external task belongs to.
      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)

    • tenantIdIn

      public ExternalTaskQueryDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public ExternalTaskQueryDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

      @Nullable 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

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

    • active

      public ExternalTaskQueryDto active(Boolean active)

    • getActive

      @Nullable public Boolean getActive()
      Only include active tasks. Value may only be `true`, as `false` matches any external task.
      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 ExternalTaskQueryDto suspended(Boolean suspended)

    • getSuspended

      @Nullable public Boolean getSuspended()
      Only include suspended tasks. Value may only be `true`, as `false` matches any external task.
      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)

    • priorityHigherThanOrEquals

      public ExternalTaskQueryDto priorityHigherThanOrEquals(Long priorityHigherThanOrEquals)

    • getPriorityHigherThanOrEquals

      @Nullable 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

    • getPriorityHigherThanOrEquals_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getPriorityHigherThanOrEquals_JsonNullable()

    • setPriorityHigherThanOrEquals_JsonNullable

      public void setPriorityHigherThanOrEquals_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> priorityHigherThanOrEquals)

    • setPriorityHigherThanOrEquals

      public void setPriorityHigherThanOrEquals(Long priorityHigherThanOrEquals)

    • priorityLowerThanOrEquals

      public ExternalTaskQueryDto priorityLowerThanOrEquals(Long priorityLowerThanOrEquals)

    • getPriorityLowerThanOrEquals

      @Nullable 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

    • getPriorityLowerThanOrEquals_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getPriorityLowerThanOrEquals_JsonNullable()

    • setPriorityLowerThanOrEquals_JsonNullable

      public void setPriorityLowerThanOrEquals_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> priorityLowerThanOrEquals)

    • setPriorityLowerThanOrEquals

      public void setPriorityLowerThanOrEquals(Long priorityLowerThanOrEquals)

    • sorting

      public ExternalTaskQueryDto sorting(List<ExternalTaskQueryDtoSortingInner> sorting)

    • addSortingItem

      public ExternalTaskQueryDto addSortingItem(ExternalTaskQueryDtoSortingInner sortingItem)

    • getSorting

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

    • getSorting_JsonNullable

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

    • setSorting_JsonNullable

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

    • setSorting

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