Package io.camunda.client.protocol.rest

Class UserTaskProperties

java.lang.Object

io.camunda.client.protocol.rest.UserTaskProperties

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class UserTaskProperties
extends Object

Contains properties of a user task.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ACTION
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_CHANGED_ATTRIBUTES
static final String	JSON_PROPERTY_DUE_DATE
static final String	JSON_PROPERTY_FOLLOW_UP_DATE
static final String	JSON_PROPERTY_FORM_KEY
static final String	JSON_PROPERTY_PRIORITY
static final String	JSON_PROPERTY_USER_TASK_KEY

Constructor Summary

Constructors

Constructor	Description
UserTaskProperties()

Method Summary

Modifier and Type	Method	Description
UserTaskProperties	action(String action)
UserTaskProperties	addCandidateGroupsItem(String candidateGroupsItem)
UserTaskProperties	addCandidateUsersItem(String candidateUsersItem)
UserTaskProperties	addChangedAttributesItem(String changedAttributesItem)
UserTaskProperties	assignee(String assignee)
UserTaskProperties	candidateGroups(List<String> candidateGroups)
UserTaskProperties	candidateUsers(List<String> candidateUsers)
UserTaskProperties	changedAttributes(List<String> changedAttributes)
UserTaskProperties	dueDate(String dueDate)
boolean	equals(Object o)
UserTaskProperties	followUpDate(String followUpDate)
UserTaskProperties	formKey(String formKey)
String	getAction()	The action performed on the user task.
String	getAssignee()	The user assigned to the task.
List<String>	getCandidateGroups()	The groups eligible to claim the task.
List<String>	getCandidateUsers()	The users eligible to claim the task.
List<String>	getChangedAttributes()	The attributes that were changed in the task.
String	getDueDate()	The due date of the user task in ISO 8601 format.
String	getFollowUpDate()	The follow-up date of the user task in ISO 8601 format.
String	getFormKey()	The key of the form associated with the user task.
Integer	getPriority()	The priority of the user task.
String	getUserTaskKey()	The unique key identifying the user task.
int	hashCode()
UserTaskProperties	priority(Integer priority)
void	setAction(String action)
void	setAssignee(String assignee)
void	setCandidateGroups(List<String> candidateGroups)
void	setCandidateUsers(List<String> candidateUsers)
void	setChangedAttributes(List<String> changedAttributes)
void	setDueDate(String dueDate)
void	setFollowUpDate(String followUpDate)
void	setFormKey(String formKey)
void	setPriority(Integer priority)
void	setUserTaskKey(String userTaskKey)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
UserTaskProperties	userTaskKey(String userTaskKey)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_ACTION

public static final String JSON_PROPERTY_ACTION

See Also:

• Constant Field Values

JSON_PROPERTY_ASSIGNEE

public static final String JSON_PROPERTY_ASSIGNEE

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_CHANGED_ATTRIBUTES

public static final String JSON_PROPERTY_CHANGED_ATTRIBUTES

See Also:

• Constant Field Values

JSON_PROPERTY_DUE_DATE

public static final String JSON_PROPERTY_DUE_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_FORM_KEY

public static final String JSON_PROPERTY_FORM_KEY

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

Constructor Details

UserTaskProperties

public UserTaskProperties()

Method Details

action

public UserTaskProperties action(@Nullable
 String action)

getAction

@Nullable
public String getAction()

The action performed on the user task.

Returns:

action

setAction

public void setAction(@Nullable
 String action)

assignee

public UserTaskProperties assignee(@Nullable
 String assignee)

getAssignee

@Nullable
public String getAssignee()

The user assigned to the task.

Returns:

assignee

setAssignee

public void setAssignee(@Nullable
 String assignee)

candidateGroups

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

addCandidateGroupsItem

public UserTaskProperties addCandidateGroupsItem(String candidateGroupsItem)

getCandidateGroups

@Nullable
public List<String> getCandidateGroups()

The groups eligible to claim the task.

Returns:

candidateGroups

setCandidateGroups

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

candidateUsers

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

addCandidateUsersItem

public UserTaskProperties addCandidateUsersItem(String candidateUsersItem)

getCandidateUsers

@Nullable
public List<String> getCandidateUsers()

The users eligible to claim the task.

Returns:

candidateUsers

setCandidateUsers

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

changedAttributes

public UserTaskProperties changedAttributes(@Nullable
 List<String> changedAttributes)

addChangedAttributesItem

public UserTaskProperties addChangedAttributesItem(String changedAttributesItem)

getChangedAttributes

@Nullable
public List<String> getChangedAttributes()

The attributes that were changed in the task.

Returns:

changedAttributes

setChangedAttributes

public void setChangedAttributes(@Nullable
 List<String> changedAttributes)

dueDate

public UserTaskProperties dueDate(@Nullable
 String dueDate)

getDueDate

@Nullable
public String getDueDate()

The due date of the user task in ISO 8601 format.

Returns:

dueDate

setDueDate

public void setDueDate(@Nullable
 String dueDate)

followUpDate

public UserTaskProperties followUpDate(@Nullable
 String followUpDate)

getFollowUpDate

@Nullable
public String getFollowUpDate()

The follow-up date of the user task in ISO 8601 format.

Returns:

followUpDate

setFollowUpDate

public void setFollowUpDate(@Nullable
 String followUpDate)

formKey

public UserTaskProperties formKey(@Nullable
 String formKey)

getFormKey

@Nullable
public String getFormKey()

The key of the form associated with the user task.

Returns:

formKey

setFormKey

public void setFormKey(@Nullable
 String formKey)

priority

public UserTaskProperties priority(@Nullable
 Integer priority)

getPriority

@Nullable
public Integer getPriority()

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

Returns:

priority

setPriority

public void setPriority(@Nullable
 Integer priority)

userTaskKey

public UserTaskProperties userTaskKey(@Nullable
 String userTaskKey)

getUserTaskKey

@Nullable
public String getUserTaskKey()

The unique key identifying the user task.

Returns:

userTaskKey

setUserTaskKey

public void setUserTaskKey(@Nullable
 String userTaskKey)

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