Package io.camunda.client.protocol.rest

Class UserTaskResult

java.lang.Object

io.camunda.client.protocol.rest.UserTaskResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-06-04T12:01:10.435788262Z[GMT]",
           comments="Generator version: 7.12.0")
public class UserTaskResult
extends Object

UserTaskResult

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserTaskResult.StateEnum	The state of the user task.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ASSIGNEE
static final String	JSON_PROPERTY_CANDIDATE_GROUPS
static final String	JSON_PROPERTY_CANDIDATE_USERS
static final String	JSON_PROPERTY_COMPLETION_DATE
static final String	JSON_PROPERTY_CREATION_DATE
static final String	JSON_PROPERTY_CUSTOM_HEADERS
static final String	JSON_PROPERTY_DUE_DATE
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_EXTERNAL_FORM_REFERENCE
static final String	JSON_PROPERTY_FOLLOW_UP_DATE
static final String	JSON_PROPERTY_FORM_KEY
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_PRIORITY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_VERSION
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_STATE
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_USER_TASK_KEY

Constructor Summary

Constructors

Constructor	Description
UserTaskResult()

Method Summary

Modifier and Type	Method	Description
UserTaskResult	addCandidateGroupsItem(String candidateGroupsItem)
UserTaskResult	addCandidateUsersItem(String candidateUsersItem)
UserTaskResult	assignee(String assignee)
UserTaskResult	candidateGroups(List<String> candidateGroups)
UserTaskResult	candidateUsers(List<String> candidateUsers)
UserTaskResult	completionDate(String completionDate)
UserTaskResult	creationDate(String creationDate)
UserTaskResult	customHeaders(Map<String,String> customHeaders)
UserTaskResult	dueDate(String dueDate)
UserTaskResult	elementId(String elementId)
UserTaskResult	elementInstanceKey(String elementInstanceKey)
boolean	equals(Object o)
UserTaskResult	externalFormReference(String externalFormReference)
UserTaskResult	followUpDate(String followUpDate)
UserTaskResult	formKey(String formKey)
String	getAssignee()	The assignee of the user task.
List<String>	getCandidateGroups()	The candidate groups for this user task.
List<String>	getCandidateUsers()	The candidate users for this user task.
String	getCompletionDate()	The completion date of a user task.
String	getCreationDate()	The creation date of a user task.
Map<String,String>	getCustomHeaders()	Custom headers for the user task.
String	getDueDate()	The due date of a user task.
String	getElementId()	The element ID of the user task.
String	getElementInstanceKey()	The key of the element instance.
String	getExternalFormReference()	The external form reference.
String	getFollowUpDate()	The follow date of a user task.
String	getFormKey()	The key of the form.
String	getName()	The name for this user task.
Integer	getPriority()	The priority of a user task.
String	getProcessDefinitionId()	The ID of the process definition.
String	getProcessDefinitionKey()	The key of the process definition.
Integer	getProcessDefinitionVersion()	The version of the process definition.
String	getProcessInstanceKey()	The key of the process instance.
UserTaskResult.StateEnum	getState()	The state of the user task.
String	getTenantId()	Tenant ID of this user task.
String	getUserTaskKey()	The key of the user task.
int	hashCode()
UserTaskResult	name(String name)
UserTaskResult	priority(Integer priority)
UserTaskResult	processDefinitionId(String processDefinitionId)
UserTaskResult	processDefinitionKey(String processDefinitionKey)
UserTaskResult	processDefinitionVersion(Integer processDefinitionVersion)
UserTaskResult	processInstanceKey(String processInstanceKey)
UserTaskResult	putCustomHeadersItem(String key, String customHeadersItem)
void	setAssignee(String assignee)
void	setCandidateGroups(List<String> candidateGroups)
void	setCandidateUsers(List<String> candidateUsers)
void	setCompletionDate(String completionDate)
void	setCreationDate(String creationDate)
void	setCustomHeaders(Map<String,String> customHeaders)
void	setDueDate(String dueDate)
void	setElementId(String elementId)
void	setElementInstanceKey(String elementInstanceKey)
void	setExternalFormReference(String externalFormReference)
void	setFollowUpDate(String followUpDate)
void	setFormKey(String formKey)
void	setName(String name)
void	setPriority(Integer priority)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setProcessInstanceKey(String processInstanceKey)
void	setState(UserTaskResult.StateEnum state)
void	setTenantId(String tenantId)
void	setUserTaskKey(String userTaskKey)
UserTaskResult	state(UserTaskResult.StateEnum state)
UserTaskResult	tenantId(String tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
UserTaskResult	userTaskKey(String userTaskKey)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_STATE

public static final String JSON_PROPERTY_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_ASSIGNEE

public static final String JSON_PROPERTY_ASSIGNEE

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_CANDIDATE_GROUPS

public static final String JSON_PROPERTY_CANDIDATE_GROUPS

See Also:

• Constant Field Values

JSON_PROPERTY_CANDIDATE_USERS

public static final String JSON_PROPERTY_CANDIDATE_USERS

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_ID

public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_CREATION_DATE

public static final String JSON_PROPERTY_CREATION_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_COMPLETION_DATE

public static final String JSON_PROPERTY_COMPLETION_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_FOLLOW_UP_DATE

public static final String JSON_PROPERTY_FOLLOW_UP_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_DUE_DATE

public static final String JSON_PROPERTY_DUE_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_EXTERNAL_FORM_REFERENCE

public static final String JSON_PROPERTY_EXTERNAL_FORM_REFERENCE

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_VERSION

public static final String JSON_PROPERTY_PROCESS_DEFINITION_VERSION

See Also:

• Constant Field Values

JSON_PROPERTY_CUSTOM_HEADERS

public static final String JSON_PROPERTY_CUSTOM_HEADERS

See Also:

• Constant Field Values

JSON_PROPERTY_PRIORITY

public static final String JSON_PROPERTY_PRIORITY

See Also:

• Constant Field Values

JSON_PROPERTY_USER_TASK_KEY

public static final String JSON_PROPERTY_USER_TASK_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_FORM_KEY

public static final String JSON_PROPERTY_FORM_KEY

See Also:

• Constant Field Values

Constructor Details

UserTaskResult

public UserTaskResult()

Method Details

name

public UserTaskResult name(@Nullable
 String name)

getName

@Nullable
public String getName()

The name for this user task.

Returns:

name

setName

public void setName(@Nullable
 String name)

state

public UserTaskResult state(@Nullable
 UserTaskResult.StateEnum state)

getState

@Nullable
public UserTaskResult.StateEnum getState()

The state of the user task.

Returns:

state

setState

public void setState(@Nullable
 UserTaskResult.StateEnum state)

assignee

public UserTaskResult assignee(@Nullable
 String assignee)

getAssignee

@Nullable
public String getAssignee()

The assignee of the user task.

Returns:

assignee

setAssignee

public void setAssignee(@Nullable
 String assignee)

elementId

public UserTaskResult elementId(@Nullable
 String elementId)

getElementId

@Nullable
public String getElementId()

The element ID of the user task.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 String elementId)

candidateGroups

public UserTaskResult candidateGroups(@Nullable
 List<String> candidateGroups)

addCandidateGroupsItem

public UserTaskResult addCandidateGroupsItem(String candidateGroupsItem)

getCandidateGroups

@Nullable
public List<String> getCandidateGroups()

The candidate groups for this user task.

Returns:

candidateGroups

setCandidateGroups

public void setCandidateGroups(@Nullable
 List<String> candidateGroups)

candidateUsers

public UserTaskResult candidateUsers(@Nullable
 List<String> candidateUsers)

addCandidateUsersItem

public UserTaskResult addCandidateUsersItem(String candidateUsersItem)

getCandidateUsers

@Nullable
public List<String> getCandidateUsers()

The candidate users for this user task.

Returns:

candidateUsers

setCandidateUsers

public void setCandidateUsers(@Nullable
 List<String> candidateUsers)

processDefinitionId

public UserTaskResult processDefinitionId(@Nullable
 String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

The ID of the process definition.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 String processDefinitionId)

creationDate

public UserTaskResult creationDate(@Nullable
 String creationDate)

getCreationDate

@Nullable
public String getCreationDate()

The creation date of a user task.

Returns:

creationDate

setCreationDate

public void setCreationDate(@Nullable
 String creationDate)

completionDate

public UserTaskResult completionDate(@Nullable
 String completionDate)

getCompletionDate

@Nullable
public String getCompletionDate()

The completion date of a user task.

Returns:

completionDate

setCompletionDate

public void setCompletionDate(@Nullable
 String completionDate)

followUpDate

public UserTaskResult followUpDate(@Nullable
 String followUpDate)

getFollowUpDate

@Nullable
public String getFollowUpDate()

The follow date of a user task.

Returns:

followUpDate

setFollowUpDate

public void setFollowUpDate(@Nullable
 String followUpDate)

dueDate

public UserTaskResult dueDate(@Nullable
 String dueDate)

getDueDate

@Nullable
public String getDueDate()

The due date of a user task.

Returns:

dueDate

setDueDate

public void setDueDate(@Nullable
 String dueDate)

tenantId

public UserTaskResult tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

Tenant ID of this user task.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

externalFormReference

public UserTaskResult externalFormReference(@Nullable
 String externalFormReference)

getExternalFormReference

@Nullable
public String getExternalFormReference()

The external form reference.

Returns:

externalFormReference

setExternalFormReference

public void setExternalFormReference(@Nullable
 String externalFormReference)

processDefinitionVersion

public UserTaskResult processDefinitionVersion(@Nullable
 Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nullable
public Integer getProcessDefinitionVersion()

The version of the process definition.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(@Nullable
 Integer processDefinitionVersion)

customHeaders

public UserTaskResult customHeaders(@Nullable
 Map<String,String> customHeaders)

putCustomHeadersItem

public UserTaskResult putCustomHeadersItem(String key,
 String customHeadersItem)

getCustomHeaders

@Nullable
public Map<String,String> getCustomHeaders()

Custom headers for the user task.

Returns:

customHeaders

setCustomHeaders

public void setCustomHeaders(@Nullable
 Map<String,String> customHeaders)

priority

public UserTaskResult priority(@Nullable
 Integer priority)

getPriority

@Nullable
public Integer getPriority()

The priority of a user task. The higher the value the higher the priority. minimum: 0 maximum: 100

Returns:

priority

setPriority

public void setPriority(@Nullable
 Integer priority)

userTaskKey

public UserTaskResult userTaskKey(@Nullable
 String userTaskKey)

getUserTaskKey

@Nullable
public String getUserTaskKey()

The key of the user task.

Returns:

userTaskKey

setUserTaskKey

public void setUserTaskKey(@Nullable
 String userTaskKey)

elementInstanceKey

public UserTaskResult elementInstanceKey(@Nullable
 String elementInstanceKey)

getElementInstanceKey

@Nullable
public String getElementInstanceKey()

The key of the element instance.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nullable
 String elementInstanceKey)

processDefinitionKey

public UserTaskResult processDefinitionKey(@Nullable
 String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The key of the process definition.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 String processDefinitionKey)

processInstanceKey

public UserTaskResult processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The key of the process instance.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

formKey

public UserTaskResult formKey(@Nullable
 String formKey)

getFormKey

@Nullable
public String getFormKey()

The key of the form.

Returns:

formKey

setFormKey

public void setFormKey(@Nullable
 String formKey)

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