Package io.camunda.client.impl.command

Class CompleteJobCommandImpl

java.lang.Object

io.camunda.client.impl.command.CommandWithVariables<CompleteJobCommandStep1>

io.camunda.client.impl.command.CompleteJobCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<CompleteJobCommandStep1>, CommandWithVariables<CompleteJobCommandStep1>, CompleteJobCommandStep1, CompleteJobCommandStep1.CompleteJobCommandStep2, FinalCommandStep<CompleteJobResponse>

public final class CompleteJobCommandImpl
extends CommandWithVariables<CompleteJobCommandStep1>
implements CompleteJobCommandStep1, CompleteJobCommandStep1.CompleteJobCommandStep2

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.command.CompleteJobCommandStep1

CompleteJobCommandStep1.CompleteJobCommandStep2

Field Summary

Fields inherited from class io.camunda.client.impl.command.CommandWithVariables

objectMapper

Constructor Summary

Constructors

Constructor	Description
CompleteJobCommandImpl(GatewayGrpc.GatewayStub asyncStub, JsonMapper jsonMapper, long key, Duration requestTimeout, Predicate<CredentialsProvider.StatusCode> retryPredicate, HttpClient httpClient, boolean preferRestOverGrpc)

Method Summary

Modifier and Type	Method	Description
CompleteJobCommandStep1.CompleteJobCommandStep2	correct(JobResultCorrections corrections)	Applies corrections to the user task attributes.
CompleteJobCommandStep1.CompleteJobCommandStep2	correct(UnaryOperator<JobResultCorrections> corrections)	Dynamically applies corrections to the user task attributes using a lambda expression.
CompleteJobCommandStep1.CompleteJobCommandStep2	correctAssignee(String assignee)	Correct the assignee of the task.
CompleteJobCommandStep1.CompleteJobCommandStep2	correctCandidateGroups(List<String> candidateGroups)	Correct the candidate groups of the task.
CompleteJobCommandStep1.CompleteJobCommandStep2	correctCandidateUsers(List<String> candidateUsers)	Correct the candidate users of the task.
CompleteJobCommandStep1.CompleteJobCommandStep2	correctDueDate(String dueDate)	Correct the due date of the task.
CompleteJobCommandStep1.CompleteJobCommandStep2	correctFollowUpDate(String followUpDate)	Correct the follow up date of the task.
CompleteJobCommandStep1.CompleteJobCommandStep2	correctPriority(Integer priority)	Correct the priority of the task.
CompleteJobCommandStep1.CompleteJobCommandStep2	deniedReason(String deniedReason)	Indicates the reason why the worker denied the work.
CompleteJobCommandStep1.CompleteJobCommandStep2	deny(boolean isDenied)	Indicates whether the worker denies the work, i.e. explicitly doesn't approve it.
CompleteJobCommandStep1.CompleteJobCommandStep2	deny(boolean isDenied, String deniedReason)	Indicates whether the worker denies the work, i.e. explicitly doesn't approve it and provides the reason to deny.
FinalCommandStep<CompleteJobResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CompleteJobCommandStep1	resultDone()	Marks the completion of configuring the result of the job.
CamundaFuture<CompleteJobResponse>	send()	Sends the command to the Camunda gateway.
protected CompleteJobCommandStep1	setVariablesInternal(String variables)
CompleteJobCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
CompleteJobCommandStep1	useRest()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
CompleteJobCommandStep1.CompleteJobCommandStep2	withResult()	Initializes the job result to allow corrections or a denial to be configured.
CompleteJobCommandStep1	withResult(CompleteJobResult jobResult)	Sets the result of the completed job, allowing the worker to apply corrections to user task attributes or explicitly deny the user task lifecycle transition.
CompleteJobCommandStep1	withResult(UnaryOperator<CompleteJobResult> jobResultModifier)	Modifies the result of the completed job using a lambda expression, allowing the worker to dynamically apply corrections to user task attributes or explicitly deny the user task lifecycle transition.

Methods inherited from class io.camunda.client.impl.command.CommandWithVariables

variable, variables, variables, variables, variables

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.client.api.command.CompleteJobCommandStep1

variable, variables, variables, variables, variables

Constructor Details

CompleteJobCommandImpl

public CompleteJobCommandImpl(GatewayGrpc.GatewayStub asyncStub,
 JsonMapper jsonMapper,
 long key,
 Duration requestTimeout,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 HttpClient httpClient,
 boolean preferRestOverGrpc)

Method Details

requestTimeout

public FinalCommandStep<CompleteJobResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

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

Specified by:

requestTimeout in interface FinalCommandStep<CompleteJobResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<CompleteJobResponse> send()

Description copied from interface: FinalCommandStep

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

Call CamundaFuture.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<CompleteJobResponse>

Returns:

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

withResult

public CompleteJobCommandStep1.CompleteJobCommandStep2 withResult()

Description copied from interface: CompleteJobCommandStep1

Initializes the job result to allow corrections or a denial to be configured.

This method is used to apply changes to user task attributes (such as assignee, priority, dueDate, and so on) or explicitly deny a user task lifecycle transition.

Example usage:

 client.newCompleteJobCommand(jobKey)
     .withResult()
     .correctAssignee("john_doe")                 // dynamically reassigns the task to 'john_doe'
     .correctPriority(84)                         // adjusts the priority of the task
     .correctDueDate("2024-11-22T11:44:55.0000Z") // sets a new due date
     .send();
 

Specified by:

withResult in interface CompleteJobCommandStep1

Returns:

the builder for this command.

withResult

public CompleteJobCommandStep1 withResult(CompleteJobResult jobResult)

Description copied from interface: CompleteJobCommandStep1

Sets the result of the completed job, allowing the worker to apply corrections to user task attributes or explicitly deny the user task lifecycle transition.

The CompleteJobResult object provides a flexible way to:

• Correct user task attributes such as assignee, dueDate, priority, and more.
• Deny the lifecycle transition associated with the user task.

 final CompleteJobResult jobResult =
     new CompleteJobResult()
         .correctAssignee("newAssignee") // dynamically assigns the task
         .correctPriority(42);           // updates the task priority

 client.newCompleteJobCommand(jobKey)
     .withResult(jobResult)
     .send();
 

Specified by:

withResult in interface CompleteJobCommandStep1

Parameters:

jobResult - the result of the job, containing corrections and/or a denial flag.

Returns:

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

withResult

public CompleteJobCommandStep1 withResult(UnaryOperator<CompleteJobResult> jobResultModifier)

Description copied from interface: CompleteJobCommandStep1

Modifies the result of the completed job using a lambda expression, allowing the worker to dynamically apply corrections to user task attributes or explicitly deny the user task lifecycle transition.

This is a convenience method for CompleteJobCommandStep1.withResult(CompleteJobResult), allowing modifications to be applied directly via a functional interface rather than constructing the CompleteJobResult manually, enabling:

• Correcting user task attributes such as assignee, dueDate, priority, and more.
• Denying the lifecycle transition associated with the user task.

The lambda expression receives the current CompleteJobResult, which can be modified as needed. If no result has been set yet, a default CompleteJobResult is provided for modification.

 client.newCompleteJobCommand(jobKey)
     .withResult(r -> r.deny(true))
     .send();
 

Specified by:

withResult in interface CompleteJobCommandStep1

Parameters:

jobResultModifier - a function to modify the CompleteJobResult.

Returns:

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

deny

public CompleteJobCommandStep1.CompleteJobCommandStep2 deny(boolean isDenied)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Indicates whether the worker denies the work, i.e. explicitly doesn't approve it. For example, a user task listener can deny the completion of a task by setting this flag to true. In this example, the completion of a task is represented by a job that the worker can complete as denied. As a result, the completion request is rejected and the task remains active. Defaults to false.

Example usage:

 client.newCompleteJobCommand(jobKey)
     .withResult()
     .deny(true)
     .send();
 

Specified by:

deny in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

isDenied - indicates if the worker has denied the reason for the job

Returns:

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

deny

public CompleteJobCommandStep1.CompleteJobCommandStep2 deny(boolean isDenied,
 String deniedReason)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Indicates whether the worker denies the work, i.e. explicitly doesn't approve it and provides the reason to deny. As a result, the completion request is rejected and the task remains active.

Example usage:

 client.newCompleteJobCommand(jobKey)
     .withResult()
     .deny(true, "Reason to deny lifecycle transition")
     .send();
 

Specified by:

deny in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

isDenied - indicates if the worker has denied the reason for the job

deniedReason - indicates the reason why the worker denied the job

Returns:

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

deniedReason

public CompleteJobCommandStep1.CompleteJobCommandStep2 deniedReason(String deniedReason)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Indicates the reason why the worker denied the work. For example, a user task listener can deny the completion of a task by setting the deny flag to true and specifying the reason to deny. In this example, the completion of a task is represented by a job that the worker can complete as denied and provided the reason to deny. As a result, the completion request is rejected and the task remains active. Defaults to an empty string.

Example usage:

 client.newCompleteJobCommand(jobKey)
     .withResult()
     .deny(true)
     .deniedReason("Reason to deny lifecycle transition")
     .send();
 

Specified by:

deniedReason in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

deniedReason - indicates the reason why the worker denied the job

Returns:

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

correct

public CompleteJobCommandStep1.CompleteJobCommandStep2 correct(JobResultCorrections corrections)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Applies corrections to the user task attributes.

This method allows the worker to modify key attributes of the user task (such as assignee, candidateGroups, and so on)

Example usage:

 final JobResultCorrections corrections = new JobResultCorrections()
     .assignee("john_doe")               // reassigns the task to 'john_doe'
     .priority(80)                       // sets a high priority
     .dueDate("2024-01-01T12:00:00Z")    // updates the due date
     .candidateGroups(List.of("sales"))  // allows the 'sales' group to claim the task
     .candidateUsers(List.of("alice"));  // allows 'alice' to claim the task

 client.newCompleteJobCommand(jobKey)
     .withResult()
     .correct(corrections)
     .send();
 

Specified by:

correct in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

corrections - the corrections to apply to the user task.

Returns:

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

correct

public CompleteJobCommandStep1.CompleteJobCommandStep2 correct(UnaryOperator<JobResultCorrections> corrections)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Dynamically applies corrections to the user task attributes using a lambda expression.

This method is a functional alternative to CompleteJobCommandStep1.CompleteJobCommandStep2.correct(JobResultCorrections). It allows the worker to modify key user task attributes (such as assignee, dueDate, priority, and so on) directly via a lambda expression. The lambda receives the current JobResultCorrections instance, which can be updated as needed. If no corrections have been set yet, a default JobResultCorrections instance is provided.

Example usage:

 client.newCompleteJobCommand(jobKey)
     .withResult()
     .correct(corrections -> corrections
         .assignee("john_doe")               // dynamically reassigns the task to 'john_doe'
         .priority(80)                       // adjusts the priority of the task
         .dueDate("2024-01-01T12:00:00Z")    // updates the due date
         .candidateGroups(List.of("sales"))  // allows the 'sales' group to claim the task
         .candidateUsers(List.of("alice")))  // allows 'alice' to claim the task
     .send();
 

Specified by:

correct in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

corrections - a lambda expression to modify the JobResultCorrections.

Returns:

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

correctAssignee

public CompleteJobCommandStep1.CompleteJobCommandStep2 correctAssignee(String assignee)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Correct the assignee of the task.

Specified by:

correctAssignee in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

assignee - assignee of the task

Returns:

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

correctDueDate

public CompleteJobCommandStep1.CompleteJobCommandStep2 correctDueDate(String dueDate)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Correct the due date of the task.

Specified by:

correctDueDate in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

dueDate - due date of the task

Returns:

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

correctFollowUpDate

public CompleteJobCommandStep1.CompleteJobCommandStep2 correctFollowUpDate(String followUpDate)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Correct the follow up date of the task.

Specified by:

correctFollowUpDate in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

followUpDate - follow up date of the task

Returns:

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

correctCandidateUsers

public CompleteJobCommandStep1.CompleteJobCommandStep2 correctCandidateUsers(List<String> candidateUsers)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Correct the candidate users of the task.

Specified by:

correctCandidateUsers in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

candidateUsers - candidate users of the task

Returns:

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

correctCandidateGroups

public CompleteJobCommandStep1.CompleteJobCommandStep2 correctCandidateGroups(List<String> candidateGroups)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Correct the candidate groups of the task.

Specified by:

correctCandidateGroups in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

candidateGroups - candidate groups of the task

Returns:

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

correctPriority

public CompleteJobCommandStep1.CompleteJobCommandStep2 correctPriority(Integer priority)

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Correct the priority of the task.

Specified by:

correctPriority in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Parameters:

priority - priority of the task

Returns:

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

resultDone

public CompleteJobCommandStep1 resultDone()

Description copied from interface: CompleteJobCommandStep1.CompleteJobCommandStep2

Marks the completion of configuring the result of the job.

This method is optional and can be used to indicate that the result configuration (such as corrections or denial) is complete. It allows calling methods unrelated to the job result.

Calling this method has no effect on the final command sent to the broker. It is provided for readability and organizational clarity in method chaining.

Example usage:

 client.newCompleteJobCommand(jobKey)
     .withResult()
     .correctAssignee("john_doe")
     .resultDone() // explicitly marks the end of result configuration
     .variable("we_can", "still_set_vars")
     .send();
 

Specified by:

resultDone in interface CompleteJobCommandStep1.CompleteJobCommandStep2

Returns:

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

useRest

public CompleteJobCommandStep1 useRest()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Camunda, and already wants to use this API during its development. As support for REST is added to Camunda, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets REST as the communication API for this command. If this command doesn't support communication over REST, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<CompleteJobCommandStep1>

Returns:

the configured command

useGrpc

public CompleteJobCommandStep1 useGrpc()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Camunda, and already wants to use this API during its development. As support for REST is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets gRPC as the communication API for this command. If this command doesn't support communication over gRPC, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<CompleteJobCommandStep1>

Returns:

the configured command

setVariablesInternal

protected CompleteJobCommandStep1 setVariablesInternal(String variables)

Specified by:

setVariablesInternal in class CommandWithVariables<CompleteJobCommandStep1>