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

Class JobUpdateTimeoutCommandImpl

java.lang.Object

io.camunda.zeebe.client.impl.command.JobUpdateTimeoutCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<UpdateTimeoutJobCommandStep1>, CommandWithOperationReferenceStep<UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2>, FinalCommandStep<UpdateTimeoutJobResponse>, UpdateTimeoutJobCommandStep1, UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2

public class JobUpdateTimeoutCommandImpl
extends Object
implements UpdateTimeoutJobCommandStep1, UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2

Nested Class Summary

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

UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2	operationReference(long operationReference)	Set the Operation Reference.
FinalCommandStep<UpdateTimeoutJobResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<UpdateTimeoutJobResponse>	send()	Sends the command to the Zeebe broker.
UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2	timeout(long timeout)	Set the timeout of this job.
UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2	timeout(Duration timeout)	Set the timeout of this job.
UpdateTimeoutJobCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
UpdateTimeoutJobCommandStep1	useRest()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.

Methods inherited from class java.lang.Object

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

Constructor Details

JobUpdateTimeoutCommandImpl

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

Method Details

timeout

public UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2 timeout(long timeout)

Description copied from interface: UpdateTimeoutJobCommandStep1

Set the timeout of this job.

Timeout value in millis is used to calculate a new job deadline. This will happen when the command is processed. The timeout value will be added to the current time then.

Specified by:

timeout in interface UpdateTimeoutJobCommandStep1

Parameters:

timeout - the timeout of this job

Returns:

the builder for this command. Call

invalid reference

#send()

to complete the command and send it to the broker.

timeout

public UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2 timeout(Duration timeout)

Description copied from interface: UpdateTimeoutJobCommandStep1

Set the timeout of this job.

Timeout value passed as a duration is used to calculate a new job deadline. This will happen when the command is processed. The timeout value will be added to the current time then.

Specified by:

timeout in interface UpdateTimeoutJobCommandStep1

Parameters:

timeout - the time as duration (e.g. "Duration.ofMinutes(5)")

Returns:

the builder for this command. Call

invalid reference

#send()

to complete the command and send it to the broker.

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<UpdateTimeoutJobResponse> 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<UpdateTimeoutJobResponse>

Returns:

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

operationReference

public UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2 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<UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2>

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

useRest

public UpdateTimeoutJobCommandStep1 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 Zeebe, 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 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 ZeebeClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<UpdateTimeoutJobCommandStep1>

Returns:

the configured command

useGrpc

public UpdateTimeoutJobCommandStep1 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 Zeebe, 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 ZeebeClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<UpdateTimeoutJobCommandStep1>

Returns:

the configured command