Package io.camunda.client.impl.command

Class JobUpdatePriorityCommandImpl

java.lang.Object

io.camunda.client.impl.command.JobUpdatePriorityCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<UpdateJobPriorityCommandStep1>, CommandWithOperationReferenceStep<UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2>, FinalCommandStep<UpdateJobPriorityResponse>, UpdateJobPriorityCommandStep1, UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2

public final class JobUpdatePriorityCommandImpl
extends Object
implements UpdateJobPriorityCommandStep1, UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2

Nested Class Summary

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

UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2

Constructor Summary

Constructors

Constructor	Description
JobUpdatePriorityCommandImpl(io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub asyncStub, long jobKey, Duration requestTimeout, Predicate<CredentialsProvider.StatusCode> retryPredicate, HttpClient httpClient, boolean preferRestOverGrpc, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2	operationReference(long operationReference)	Set the Operation Reference.
UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2	priority(int priority)	Set the priority of this job.
FinalCommandStep<UpdateJobPriorityResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<UpdateJobPriorityResponse>	send()	Sends the command to the Camunda gateway.
UpdateJobPriorityCommandStep1	useGrpc()	Sets gRPC as the communication API for this command.
UpdateJobPriorityCommandStep1	useRest()	Sets REST as the communication API for this command.
UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2	withLeaseToken(String leaseToken)	Sets the lease token identifying the job's activation, fencing this command against a superseded activation of the same job.

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.FinalCommandStep

execute

Constructor Details

JobUpdatePriorityCommandImpl

public JobUpdatePriorityCommandImpl(io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub asyncStub,
 long jobKey,
 Duration requestTimeout,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 HttpClient httpClient,
 boolean preferRestOverGrpc,
 JsonMapper jsonMapper)

Method Details

priority

public UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2 priority(int priority)

Description copied from interface: UpdateJobPriorityCommandStep1

Set the priority of this job.

Specified by:

priority in interface UpdateJobPriorityCommandStep1

Parameters:

priority - the priority of this job

Returns:

the builder for this command. Call

invalid reference

#send()

to complete the command and send it to the broker.

requestTimeout

public FinalCommandStep<UpdateJobPriorityResponse> 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<UpdateJobPriorityResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<UpdateJobPriorityResponse> 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<UpdateJobPriorityResponse>

Returns:

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

operationReference

public UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2 operationReference(long operationReference)

Description copied from interface: CommandWithOperationReferenceStep

Set the Operation Reference.

This is a key chosen by the user and will be part of all records resulted from this operation

Specified by:

operationReference in interface CommandWithOperationReferenceStep<UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2>

Parameters:

operationReference - a reference key chosen by the user and will be part of all records resulted from this operation

Returns:

the builder for this command with the operation reference specified

withLeaseToken

public UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2 withLeaseToken(String leaseToken)

Description copied from interface: UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2

Sets the lease token identifying the job's activation, fencing this command against a superseded activation of the same job. Obtain it from ActivatedJob#getLeaseToken().

For a leased job, a supplied token is validated to prove the command comes from the worker that holds the current lease; a command carrying a stale token is rejected, fencing the job against a superseded activation (e.g. after the job timed out or failed and was re-activated by another worker). An update without a token always applies, to support operator and bulk updates of leased jobs; this differs from lifecycle commands like complete, fail, and throw-error, which always require a token for leased jobs. A job that was activated without a lease requires no token.

When this command is created from an activated job (e.g. newUpdateJobPriorityCommand(activatedJob)) the job's lease token is carried automatically, so this method is only needed when building the command from a job key.

Specified by:

withLeaseToken in interface UpdateJobPriorityCommandStep1.UpdateJobPriorityCommandStep2

Parameters:

leaseToken - the opaque lease token the worker received when the job was activated

Returns:

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

useRest

public UpdateJobPriorityCommandStep1 useRest()

Description copied from interface: CommandWithCommunicationApiStep

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<UpdateJobPriorityCommandStep1>

Returns:

the configured command

useGrpc

public UpdateJobPriorityCommandStep1 useGrpc()

Description copied from interface: CommandWithCommunicationApiStep

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<UpdateJobPriorityCommandStep1>

Returns:

the configured command