Package io.camunda.zeebe.client.api.search.filter

Interface UserTaskFilter

All Superinterfaces:
TypedSearchQueryRequest.SearchRequestFilter
All Known Implementing Classes:
UserTaskFilterImpl
public interface UserTaskFilter extends TypedSearchQueryRequest.SearchRequestFilter
Interface for defining user task filters in search queries.

  • Method Details

    • key

      UserTaskFilter key(Long value)
      Filters user tasks by the specified key.
      Parameters:
      value - the key of the user task
      Returns:
      the updated filter

    • state

      UserTaskFilter state(String state)
      Filters user tasks by the specified state.
      Parameters:
      state - the state of the user task
      Returns:
      the updated filter

    • assignee

      UserTaskFilter assignee(String assignee)
      Filters user tasks by the specified assignee.
      Parameters:
      assignee - the assignee of the user task
      Returns:
      the updated filter

    • elementId

      UserTaskFilter elementId(String taskDefinitionId)
      Filters user tasks by the specified task definition ID.
      Parameters:
      taskDefinitionId - the task definition ID of the user task
      Returns:
      the updated filter

    • candidateGroup

      UserTaskFilter candidateGroup(String candidateGroup)
      Filters user tasks by the specified candidate group.
      Parameters:
      candidateGroup - the candidate group of the user task
      Returns:
      the updated filter

    • candidateUser

      UserTaskFilter candidateUser(String candidateUser)
      Filters user tasks by the specified candidate user.
      Parameters:
      candidateUser - the candidate user of the user task
      Returns:
      the updated filter

    • processDefinitionKey

      UserTaskFilter processDefinitionKey(Long processDefinitionKey)
      Filters user tasks by the specified process definition key.
      Parameters:
      processDefinitionKey - the process definition key of the user task
      Returns:
      the updated filter

    • processInstanceKey

      UserTaskFilter processInstanceKey(Long processInstanceKey)
      Filters user tasks by the specified process instance key.
      Parameters:
      processInstanceKey - the process instance key of the user task
      Returns:
      the updated filter

    • tentantId

      UserTaskFilter tentantId(String tenantId)
      Filters user tasks by the specified tenant ID.
      Parameters:
      tenantId - the tenant ID of the user task
      Returns:
      the updated filter

    • bpmnProcessId

      UserTaskFilter bpmnProcessId(String bpmnProcessId)
      Filters user tasks by the specified Process Definition Id.
      Parameters:
      bpmnProcessId - from the task
      Returns:
      the updated filter

    • variables

      UserTaskFilter variables(List<UserTaskVariableFilterRequest> variableValueFilters)
      Filters user tasks by the specified Process Definition Id.
      Parameters:
      variableValueFilters - from the task
      Returns:
      the updated filter