Package io.camunda.client.impl.command

Class JobUpdateRetriesCommandImpl

java.lang.Object

io.camunda.client.impl.command.JobUpdateRetriesCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<UpdateRetriesJobCommandStep1>, CommandWithOperationReferenceStep<UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2>, FinalCommandStep<UpdateRetriesJobResponse>, UpdateRetriesJobCommandStep1, UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2

public final class JobUpdateRetriesCommandImpl
extends Object
implements UpdateRetriesJobCommandStep1, UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2

Nested Class Summary

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

UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2	operationReference(long operationReference)	Set the Operation Reference.
FinalCommandStep<UpdateRetriesJobResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2	retries(int retries)	Set the retries of this job.
CamundaFuture<UpdateRetriesJobResponse>	send()	Sends the command to the Camunda gateway.
UpdateRetriesJobCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
UpdateRetriesJobCommandStep1	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

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

execute

Constructor Details

JobUpdateRetriesCommandImpl

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

Method Details

retries

public UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2 retries(int retries)

Description copied from interface: UpdateRetriesJobCommandStep1

Set the retries of this job.

If the given retries are greater than zero then this job will be picked up again by a job subscription and a related incident will be marked as resolved.

Specified by:

retries in interface UpdateRetriesJobCommandStep1

Parameters:

retries - the retries 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<UpdateRetriesJobResponse> 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<UpdateRetriesJobResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

operationReference

public UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2 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<UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2>

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

Returns:

the configured command

useGrpc

public UpdateRetriesJobCommandStep1 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<UpdateRetriesJobCommandStep1>

Returns:

the configured command