Package io.camunda.zeebe.client.impl.command

Class UpdateUserTaskCommandImpl

java.lang.Object

io.camunda.zeebe.client.impl.command.UpdateUserTaskCommandImpl

All Implemented Interfaces:

FinalCommandStep<UpdateUserTaskResponse>, UpdateUserTaskCommandStep1

public final class UpdateUserTaskCommandImpl
extends Object
implements UpdateUserTaskCommandStep1

Constructor Summary

Constructors

Constructor	Description
UpdateUserTaskCommandImpl(HttpClient httpClient, JsonMapper jsonMapper, long userTaskKey)

Method Summary

Modifier and Type	Method	Description
UpdateUserTaskCommandStep1	action(String action)	Set the custom action to update the user task with.
UpdateUserTaskCommandStep1	candidateGroups(String... candidateGroups)	Set the candidate groups to set in the user task.
UpdateUserTaskCommandStep1	candidateGroups(List<String> candidateGroups)	Set the candidate groups to set in the user task.
UpdateUserTaskCommandStep1	candidateUsers(String... candidateUsers)	Set the candidate users to set in the user task.
UpdateUserTaskCommandStep1	candidateUsers(List<String> candidateUsers)	Set the candidate users to set in the user task.
UpdateUserTaskCommandStep1	clearCandidateGroups()	Remove the candidate groups from the user task.
UpdateUserTaskCommandStep1	clearCandidateUsers()	Remove the candidate users from the user task.
UpdateUserTaskCommandStep1	clearDueDate()	Clear the due date in the user task.
UpdateUserTaskCommandStep1	clearFollowUpDate()	Clear the follow-up date in the user task.
UpdateUserTaskCommandStep1	dueDate(String dueDate)	Set the due date to set in the user task.
UpdateUserTaskCommandStep1	followUpDate(String followUpDate)	Set the follow-up date to set in the user task.
UpdateUserTaskCommandStep1	priority(Integer priority)	Set the priority of the User Task.
FinalCommandStep<UpdateUserTaskResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<UpdateUserTaskResponse>	send()	Sends the command to the Zeebe broker.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UpdateUserTaskCommandImpl

public UpdateUserTaskCommandImpl(HttpClient httpClient,
 JsonMapper jsonMapper,
 long userTaskKey)

Method Details

requestTimeout

public FinalCommandStep<UpdateUserTaskResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using ZeebeClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<UpdateUserTaskResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<UpdateUserTaskResponse> send()

Description copied from interface: FinalCommandStep

Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.

Call ZeebeFuture.join() to wait until the response is available.

 Future<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<UpdateUserTaskResponse>

Returns:

a future tracking state of success/failure of the command.

action

public UpdateUserTaskCommandStep1 action(String action)

Description copied from interface: UpdateUserTaskCommandStep1

Set the custom action to update the user task with.

Specified by:

action in interface UpdateUserTaskCommandStep1

Parameters:

action - the action value

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

dueDate

public UpdateUserTaskCommandStep1 dueDate(String dueDate)

Description copied from interface: UpdateUserTaskCommandStep1

Set the due date to set in the user task. Use UpdateUserTaskCommandStep1.clearDueDate() to remove the due date from the task.

Specified by:

dueDate in interface UpdateUserTaskCommandStep1

Parameters:

dueDate - the due date to set

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

clearDueDate

public UpdateUserTaskCommandStep1 clearDueDate()

Description copied from interface: UpdateUserTaskCommandStep1

Clear the due date in the user task.

Specified by:

clearDueDate in interface UpdateUserTaskCommandStep1

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

followUpDate

public UpdateUserTaskCommandStep1 followUpDate(String followUpDate)

Description copied from interface: UpdateUserTaskCommandStep1

Set the follow-up date to set in the user task. Use UpdateUserTaskCommandStep1.clearFollowUpDate() to remove the follow-up date from the task.

Specified by:

followUpDate in interface UpdateUserTaskCommandStep1

Parameters:

followUpDate - the follow-up date to set

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

clearFollowUpDate

public UpdateUserTaskCommandStep1 clearFollowUpDate()

Description copied from interface: UpdateUserTaskCommandStep1

Clear the follow-up date in the user task.

Specified by:

clearFollowUpDate in interface UpdateUserTaskCommandStep1

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

candidateGroups

public UpdateUserTaskCommandStep1 candidateGroups(List<String> candidateGroups)

Description copied from interface: UpdateUserTaskCommandStep1

Set the candidate groups to set in the user task. This replaces the candidate groups in the task. Use UpdateUserTaskCommandStep1.clearCandidateGroups() to remove the candidate groups from the task.

Specified by:

candidateGroups in interface UpdateUserTaskCommandStep1

Parameters:

candidateGroups - the candidate groups to set

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

candidateGroups

public UpdateUserTaskCommandStep1 candidateGroups(String... candidateGroups)

Description copied from interface: UpdateUserTaskCommandStep1

Set the candidate groups to set in the user task. This replaces the candidate groups in the task. Use UpdateUserTaskCommandStep1.clearCandidateGroups() to remove the candidate groups from the task.

Specified by:

candidateGroups in interface UpdateUserTaskCommandStep1

Parameters:

candidateGroups - the candidate groups to set

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

clearCandidateGroups

public UpdateUserTaskCommandStep1 clearCandidateGroups()

Description copied from interface: UpdateUserTaskCommandStep1

Remove the candidate groups from the user task.

Specified by:

clearCandidateGroups in interface UpdateUserTaskCommandStep1

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

candidateUsers

public UpdateUserTaskCommandStep1 candidateUsers(List<String> candidateUsers)

Description copied from interface: UpdateUserTaskCommandStep1

Set the candidate users to set in the user task. This replaces the candidate users in the task. Use UpdateUserTaskCommandStep1.clearCandidateUsers() to remove the candidate users from the task.

Specified by:

candidateUsers in interface UpdateUserTaskCommandStep1

Parameters:

candidateUsers - the candidate users to set

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

candidateUsers

public UpdateUserTaskCommandStep1 candidateUsers(String... candidateUsers)

Description copied from interface: UpdateUserTaskCommandStep1

Set the candidate users to set in the user task. This replaces the candidate users in the task. Use UpdateUserTaskCommandStep1.clearCandidateUsers() to remove the candidate users from the task.

Specified by:

candidateUsers in interface UpdateUserTaskCommandStep1

Parameters:

candidateUsers - the candidate users to set

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

clearCandidateUsers

public UpdateUserTaskCommandStep1 clearCandidateUsers()

Description copied from interface: UpdateUserTaskCommandStep1

Remove the candidate users from the user task.

Specified by:

clearCandidateUsers in interface UpdateUserTaskCommandStep1

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

priority

public UpdateUserTaskCommandStep1 priority(Integer priority)

Description copied from interface: UpdateUserTaskCommandStep1

Set the priority of the User Task. The priority must be an integer between 0 and 100, default 50.

Specified by:

priority in interface UpdateUserTaskCommandStep1

Parameters:

priority - the priority to set

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.