Package io.camunda.tasklist.generated.model

Class TaskSearchRequest

java.lang.Object
io.camunda.tasklist.generated.model.TaskSearchRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-10-29T10:52:23.981575172Z[Etc/UTC]", comments="Generator version: 7.8.0") public class TaskSearchRequest extends Object
Request object to search tasks by provided params.

  • Field Details

  • Constructor Details

    • TaskSearchRequest

      public TaskSearchRequest()

  • Method Details

    • state

      public TaskSearchRequest state(TaskSearchRequest.StateEnum state)

    • getState

      @Nullable public TaskSearchRequest.StateEnum getState()
      The state of the tasks.
      Returns:
      state

    • setState

      public void setState(TaskSearchRequest.StateEnum state)

    • assigned

      public TaskSearchRequest assigned(Boolean assigned)

    • getAssigned

      @Nullable public Boolean getAssigned()
      Are the tasks assigned?
      Returns:
      assigned

    • setAssigned

      public void setAssigned(Boolean assigned)

    • assignee

      public TaskSearchRequest assignee(String assignee)

    • getAssignee

      @Nullable public String getAssignee()
      Who is assigned to the tasks?
      Returns:
      assignee

    • setAssignee

      public void setAssignee(String assignee)

    • assignees

      public TaskSearchRequest assignees(List<String> assignees)

    • addAssigneesItem

      public TaskSearchRequest addAssigneesItem(String assigneesItem)

    • getAssignees

      @Nullable public List<String> getAssignees()
      The assignee is one of the given assignees.
      Returns:
      assignees

    • setAssignees

      public void setAssignees(List<String> assignees)

    • taskDefinitionId

      public TaskSearchRequest taskDefinitionId(String taskDefinitionId)

    • getTaskDefinitionId

      @Nullable public String getTaskDefinitionId()
      What's the BPMN flow node?
      Returns:
      taskDefinitionId

    • setTaskDefinitionId

      public void setTaskDefinitionId(String taskDefinitionId)

    • candidateGroup

      public TaskSearchRequest candidateGroup(String candidateGroup)

    • getCandidateGroup

      @Nullable public String getCandidateGroup()
      Given group is in candidate groups list.
      Returns:
      candidateGroup

    • setCandidateGroup

      public void setCandidateGroup(String candidateGroup)

    • candidateGroups

      public TaskSearchRequest candidateGroups(List<String> candidateGroups)

    • addCandidateGroupsItem

      public TaskSearchRequest addCandidateGroupsItem(String candidateGroupsItem)

    • getCandidateGroups

      @Nullable public List<String> getCandidateGroups()
      At least one of the given groups is in candidate groups list.
      Returns:
      candidateGroups

    • setCandidateGroups

      public void setCandidateGroups(List<String> candidateGroups)

    • candidateUser

      public TaskSearchRequest candidateUser(String candidateUser)

    • getCandidateUser

      @Nullable public String getCandidateUser()
      Given user is in candidate user list.
      Returns:
      candidateUser

    • setCandidateUser

      public void setCandidateUser(String candidateUser)

    • candidateUsers

      public TaskSearchRequest candidateUsers(List<String> candidateUsers)

    • addCandidateUsersItem

      public TaskSearchRequest addCandidateUsersItem(String candidateUsersItem)

    • getCandidateUsers

      @Nullable public List<String> getCandidateUsers()
      At least one of the given users is in candidate user list.
      Returns:
      candidateUsers

    • setCandidateUsers

      public void setCandidateUsers(List<String> candidateUsers)

    • processDefinitionKey

      public TaskSearchRequest processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      Reference to process definition (renamed equivalent of TaskQuery.processDefinitionId field).
      Returns:
      processDefinitionKey

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)

    • processInstanceKey

      public TaskSearchRequest processInstanceKey(String processInstanceKey)

    • getProcessInstanceKey

      @Nullable public String getProcessInstanceKey()
      Reference to process instance (renamed equivalent of TaskQuery.processInstanceId field)
      Returns:
      processInstanceKey

    • setProcessInstanceKey

      public void setProcessInstanceKey(String processInstanceKey)

    • pageSize

      public TaskSearchRequest pageSize(Integer pageSize)

    • getPageSize

      @Nullable public Integer getPageSize()
      Size of tasks page (default = 50).
      Returns:
      pageSize

    • setPageSize

      public void setPageSize(Integer pageSize)

    • followUpDate

      public TaskSearchRequest followUpDate(DateFilter followUpDate)

    • getFollowUpDate

      @Nullable public DateFilter getFollowUpDate()
      Get followUpDate
      Returns:
      followUpDate

    • setFollowUpDate

      public void setFollowUpDate(DateFilter followUpDate)

    • dueDate

      public TaskSearchRequest dueDate(DateFilter dueDate)

    • getDueDate

      @Nullable public DateFilter getDueDate()
      Get dueDate
      Returns:
      dueDate

    • setDueDate

      public void setDueDate(DateFilter dueDate)

    • taskVariables

      public TaskSearchRequest taskVariables(List<TaskByVariables> taskVariables)

    • addTaskVariablesItem

      public TaskSearchRequest addTaskVariablesItem(TaskByVariables taskVariablesItem)

    • getTaskVariables

      @Nullable public List<TaskByVariables> getTaskVariables()
      An array of filter clauses specifying the variables to filter for.<br>If defined, the query returns only tasks to which all clauses apply.<br>However, it's important to note that this filtering mechanism is<br>designed to work exclusively with truncated variables. This means<br>variables of a larger size are not compatible with this filter, and<br>attempts to use them may result in inaccurate or incomplete query results.
      Returns:
      taskVariables

    • setTaskVariables

      public void setTaskVariables(List<TaskByVariables> taskVariables)

    • tenantIds

      public TaskSearchRequest tenantIds(List<String> tenantIds)

    • addTenantIdsItem

      public TaskSearchRequest addTenantIdsItem(String tenantIdsItem)

    • getTenantIds

      @Nullable public List<String> getTenantIds()
      An array of Tenant IDs to filter tasks. When multi-tenancy is<br>enabled, tasks associated with the specified tenant IDs are returned;<br>if disabled, this parameter is ignored.
      Returns:
      tenantIds

    • setTenantIds

      public void setTenantIds(List<String> tenantIds)

    • sort

      public TaskSearchRequest sort(List<TaskOrderBy> sort)

    • addSortItem

      public TaskSearchRequest addSortItem(TaskOrderBy sortItem)

    • getSort

      @Nullable public List<TaskOrderBy> getSort()
      An array of objects specifying the fields to sort the results by.
      Returns:
      sort

    • setSort

      public void setSort(List<TaskOrderBy> sort)

    • searchAfter

      public TaskSearchRequest searchAfter(List<String> searchAfter)

    • addSearchAfterItem

      public TaskSearchRequest addSearchAfterItem(String searchAfterItem)

    • getSearchAfter

      @Nullable public List<String> getSearchAfter()
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.<br>It enables the API to return a page of tasks that directly follow the task identified by the provided values, with respect to the sorting order.
      Returns:
      searchAfter

    • setSearchAfter

      public void setSearchAfter(List<String> searchAfter)

    • searchAfterOrEqual

      public TaskSearchRequest searchAfterOrEqual(List<String> searchAfterOrEqual)

    • addSearchAfterOrEqualItem

      public TaskSearchRequest addSearchAfterOrEqualItem(String searchAfterOrEqualItem)

    • getSearchAfterOrEqual

      @Nullable public List<String> getSearchAfterOrEqual()
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.<br>It enables the API to return a page of tasks that directly follow or are equal to the task identified by the provided values, with respect to the sorting order.
      Returns:
      searchAfterOrEqual

    • setSearchAfterOrEqual

      public void setSearchAfterOrEqual(List<String> searchAfterOrEqual)

    • searchBefore

      public TaskSearchRequest searchBefore(List<String> searchBefore)

    • addSearchBeforeItem

      public TaskSearchRequest addSearchBeforeItem(String searchBeforeItem)

    • getSearchBefore

      @Nullable public List<String> getSearchBefore()
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.<br>It enables the API to return a page of tasks that directly precede the task identified by the provided values, with respect to the sorting order.
      Returns:
      searchBefore

    • setSearchBefore

      public void setSearchBefore(List<String> searchBefore)

    • searchBeforeOrEqual

      public TaskSearchRequest searchBeforeOrEqual(List<String> searchBeforeOrEqual)

    • addSearchBeforeOrEqualItem

      public TaskSearchRequest addSearchBeforeOrEqualItem(String searchBeforeOrEqualItem)

    • getSearchBeforeOrEqual

      @Nullable public List<String> getSearchBeforeOrEqual()
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.<br>It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.
      Returns:
      searchBeforeOrEqual

    • setSearchBeforeOrEqual

      public void setSearchBeforeOrEqual(List<String> searchBeforeOrEqual)

    • includeVariables

      public TaskSearchRequest includeVariables(List<IncludeVariable> includeVariables)

    • addIncludeVariablesItem

      public TaskSearchRequest addIncludeVariablesItem(IncludeVariable includeVariablesItem)

    • getIncludeVariables

      @Nullable public List<IncludeVariable> getIncludeVariables()
      An array used to specify a list of variable names that should be included in the response when querying tasks.<br>This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
      Returns:
      includeVariables

    • setIncludeVariables

      public void setIncludeVariables(List<IncludeVariable> includeVariables)

    • implementation

      public TaskSearchRequest implementation(TaskSearchRequest.ImplementationEnum implementation)

    • getImplementation

      @Nullable public TaskSearchRequest.ImplementationEnum getImplementation()
      Get implementation
      Returns:
      implementation

    • setImplementation

      public void setImplementation(TaskSearchRequest.ImplementationEnum implementation)

    • priority

      public TaskSearchRequest priority(RangeValueFilter priority)

    • getPriority

      @Nullable public RangeValueFilter getPriority()
      Get priority
      Returns:
      priority

    • setPriority

      public void setPriority(RangeValueFilter priority)

    • 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