Package io.camunda.tasklist.generated.model

Class TaskSearchResponse

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

  • Field Details

  • Constructor Details

    • TaskSearchResponse

      public TaskSearchResponse()

  • Method Details

    • id

      public TaskSearchResponse id(String id)

    • getId

      @Nullable public String getId()
      The unique identifier of the task.
      Returns:
      id

    • setId

      public void setId(String id)

    • name

      public TaskSearchResponse name(String name)

    • getName

      @Nullable public String getName()
      The name of the task.
      Returns:
      name

    • setName

      public void setName(String name)

    • taskDefinitionId

      public TaskSearchResponse taskDefinitionId(String taskDefinitionId)

    • getTaskDefinitionId

      @Nullable public String getTaskDefinitionId()
      User Task ID from the BPMN definition.
      Returns:
      taskDefinitionId

    • setTaskDefinitionId

      public void setTaskDefinitionId(String taskDefinitionId)

    • processName

      public TaskSearchResponse processName(String processName)

    • getProcessName

      @Nullable public String getProcessName()
      The name of the process.
      Returns:
      processName

    • setProcessName

      public void setProcessName(String processName)

    • creationDate

      public TaskSearchResponse creationDate(String creationDate)

    • getCreationDate

      @Nullable public String getCreationDate()
      When was the task created (renamed equivalent of `Task.creationTime` field).
      Returns:
      creationDate

    • setCreationDate

      public void setCreationDate(String creationDate)

    • completionDate

      public TaskSearchResponse completionDate(String completionDate)

    • getCompletionDate

      @Nullable public String getCompletionDate()
      When was the task completed (renamed equivalent of `Task.completionTime` field).
      Returns:
      completionDate

    • setCompletionDate

      public void setCompletionDate(String completionDate)

    • assignee

      public TaskSearchResponse assignee(String assignee)

    • getAssignee

      @Nullable public String getAssignee()
      The username/id of who is assigned to the task.
      Returns:
      assignee

    • setAssignee

      public void setAssignee(String assignee)

    • taskState

      public TaskSearchResponse taskState(TaskSearchResponse.TaskStateEnum taskState)

    • getTaskState

      @Nullable public TaskSearchResponse.TaskStateEnum getTaskState()
      The state of the task.
      Returns:
      taskState

    • setTaskState

      public void setTaskState(TaskSearchResponse.TaskStateEnum taskState)

    • sortValues

      public TaskSearchResponse sortValues(List<String> sortValues)

    • addSortValuesItem

      public TaskSearchResponse addSortValuesItem(String sortValuesItem)

    • getSortValues

      @Nullable public List<String> getSortValues()
      Array of values to be copied into `TaskSearchRequest` to request for next or previous page of tasks.
      Returns:
      sortValues

    • setSortValues

      public void setSortValues(List<String> sortValues)

    • isFirst

      public TaskSearchResponse isFirst(Boolean isFirst)

    • getIsFirst

      @Nullable public Boolean getIsFirst()
      A flag to show that the task is first in the current filter.
      Returns:
      isFirst

    • setIsFirst

      public void setIsFirst(Boolean isFirst)

    • formKey

      public TaskSearchResponse formKey(String formKey)

    • getFormKey

      @Nullable public String getFormKey()
      Reference to the task form.
      Returns:
      formKey

    • setFormKey

      public void setFormKey(String formKey)

    • formId

      public TaskSearchResponse formId(String formId)

    • getFormId

      @Nullable public String getFormId()
      Reference to the ID of a deployed form. If the form is not deployed, this property is null.
      Returns:
      formId

    • setFormId

      public void setFormId(String formId)

    • formVersion

      public TaskSearchResponse formVersion(Long formVersion)

    • getFormVersion

      @Nullable public Long getFormVersion()
      Reference to the version of a deployed form. If the form is not deployed, this property is null.
      Returns:
      formVersion

    • setFormVersion

      public void setFormVersion(Long formVersion)

    • isFormEmbedded

      public TaskSearchResponse isFormEmbedded(Boolean isFormEmbedded)

    • getIsFormEmbedded

      @Nullable public Boolean getIsFormEmbedded()
      Is the form embedded for this task? If there is no form, this property is null.
      Returns:
      isFormEmbedded

    • setIsFormEmbedded

      public void setIsFormEmbedded(Boolean isFormEmbedded)

    • processDefinitionKey

      public TaskSearchResponse processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

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

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)

    • processInstanceKey

      public TaskSearchResponse processInstanceKey(String processInstanceKey)

    • getProcessInstanceKey

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

    • setProcessInstanceKey

      public void setProcessInstanceKey(String processInstanceKey)

    • tenantId

      public TaskSearchResponse tenantId(String tenantId)

    • getTenantId

      @Nullable public String getTenantId()
      The tenant ID associated with the task.
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(String tenantId)

    • dueDate

      public TaskSearchResponse dueDate(OffsetDateTime dueDate)

    • getDueDate

      @Nullable public OffsetDateTime getDueDate()
      The due date for the task.
      Returns:
      dueDate

    • setDueDate

      public void setDueDate(OffsetDateTime dueDate)

    • followUpDate

      public TaskSearchResponse followUpDate(OffsetDateTime followUpDate)

    • getFollowUpDate

      @Nullable public OffsetDateTime getFollowUpDate()
      The follow-up date for the task.
      Returns:
      followUpDate

    • setFollowUpDate

      public void setFollowUpDate(OffsetDateTime followUpDate)

    • candidateGroups

      public TaskSearchResponse candidateGroups(List<String> candidateGroups)

    • addCandidateGroupsItem

      public TaskSearchResponse addCandidateGroupsItem(String candidateGroupsItem)

    • getCandidateGroups

      @Nullable public List<String> getCandidateGroups()
      The candidate groups for the task.
      Returns:
      candidateGroups

    • setCandidateGroups

      public void setCandidateGroups(List<String> candidateGroups)

    • candidateUsers

      public TaskSearchResponse candidateUsers(List<String> candidateUsers)

    • addCandidateUsersItem

      public TaskSearchResponse addCandidateUsersItem(String candidateUsersItem)

    • getCandidateUsers

      @Nullable public List<String> getCandidateUsers()
      The candidate users for the task.
      Returns:
      candidateUsers

    • setCandidateUsers

      public void setCandidateUsers(List<String> candidateUsers)

    • variables

      public TaskSearchResponse variables(List<VariableSearchResponse> variables)

    • addVariablesItem

      public TaskSearchResponse addVariablesItem(VariableSearchResponse variablesItem)

    • getVariables

      @Nullable public List<VariableSearchResponse> getVariables()
      An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. Note that a variable's draft value is not returned in `TaskSearchResponse`.
      Returns:
      variables

    • setVariables

      public void setVariables(List<VariableSearchResponse> variables)

    • context

      public TaskSearchResponse context(String context)

    • getContext

      @Nullable public String getContext()
      The context variable (from modeler) of the task.
      Returns:
      context

    • setContext

      public void setContext(String context)

    • implementation

      public TaskSearchResponse implementation(TaskSearchResponse.ImplementationEnum implementation)

    • getImplementation

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

    • setImplementation

      public void setImplementation(TaskSearchResponse.ImplementationEnum implementation)

    • priority

      public TaskSearchResponse priority(Integer priority)

    • getPriority

      @Nullable public Integer getPriority()
      The assigned priority of the task. Only for Zeebe User Tasks.
      Returns:
      priority

    • setPriority

      public void setPriority(Integer 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