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

Class FetchExternalTasksDto

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

  • Field Details

  • Constructor Details

    • FetchExternalTasksDto

      public FetchExternalTasksDto()

  • Method Details

    • workerId

      public FetchExternalTasksDto workerId(String workerId)

    • getWorkerId

      @Nonnull public String getWorkerId()
      **Mandatory.** The id of the worker on which behalf tasks are fetched. The returned tasks are locked for that worker and can only be completed when providing the same worker id.
      Returns:
      workerId

    • setWorkerId

      public void setWorkerId(String workerId)

    • maxTasks

      public FetchExternalTasksDto maxTasks(Integer maxTasks)

    • getMaxTasks

      @Nullable public Integer getMaxTasks()
      **Mandatory.** The maximum number of tasks to return.
      Returns:
      maxTasks

    • setMaxTasks

      public void setMaxTasks(Integer maxTasks)

    • usePriority

      public FetchExternalTasksDto usePriority(Boolean usePriority)

    • getUsePriority

      @Nullable public Boolean getUsePriority()
      A `boolean` value, which indicates whether the task should be fetched based on its priority or arbitrarily.
      Returns:
      usePriority

    • getUsePriority_JsonNullable

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

    • setUsePriority_JsonNullable

      public void setUsePriority_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> usePriority)

    • setUsePriority

      public void setUsePriority(Boolean usePriority)

    • asyncResponseTimeout

      public FetchExternalTasksDto asyncResponseTimeout(Long asyncResponseTimeout)

    • getAsyncResponseTimeout

      @Nullable public Long getAsyncResponseTimeout()
      The [Long Polling](https://docs.camunda.org/manual/7.21/user-guide/process-engine/external-tasks/#long-polling-to-fetch-and-lock-external-tasks) timeout in milliseconds. **Note:** The value cannot be set larger than 1.800.000 milliseconds (corresponds to 30 minutes).
      Returns:
      asyncResponseTimeout

    • getAsyncResponseTimeout_JsonNullable

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

    • setAsyncResponseTimeout_JsonNullable

      public void setAsyncResponseTimeout_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> asyncResponseTimeout)

    • setAsyncResponseTimeout

      public void setAsyncResponseTimeout(Long asyncResponseTimeout)

    • topics

      public FetchExternalTasksDto topics(List<FetchExternalTaskTopicDto> topics)

    • addTopicsItem

      public FetchExternalTasksDto addTopicsItem(FetchExternalTaskTopicDto topicsItem)

    • getTopics

      @Nullable public List<FetchExternalTaskTopicDto> getTopics()
      A JSON array of topic objects for which external tasks should be fetched. The returned tasks may be arbitrarily distributed among these topics. Each topic object has the following properties:
      Returns:
      topics

    • getTopics_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<FetchExternalTaskTopicDto>> getTopics_JsonNullable()

    • setTopics_JsonNullable

      public void setTopics_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<FetchExternalTaskTopicDto>> topics)

    • setTopics

      public void setTopics(List<FetchExternalTaskTopicDto> topics)

    • sorting

      public FetchExternalTasksDto sorting(List<FetchExternalTasksDtoSortingInner> sorting)

    • addSortingItem

      public FetchExternalTasksDto addSortingItem(FetchExternalTasksDtoSortingInner sortingItem)

    • getSorting

      @Nullable public List<FetchExternalTasksDtoSortingInner> getSorting()
      Apply sorting of the result
      Returns:
      sorting

    • getSorting_JsonNullable

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

    • setSorting_JsonNullable

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

    • setSorting

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