Package io.camunda.client.impl.command

Class PinClockCommandImpl

java.lang.Object

io.camunda.client.impl.command.PinClockCommandImpl

All Implemented Interfaces:

FinalCommandStep<PinClockResponse>, PinClockCommandStep1

public class PinClockCommandImpl
extends Object
implements PinClockCommandStep1

Constructor Summary

Constructors

Constructor	Description
PinClockCommandImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
FinalCommandStep<PinClockResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<PinClockResponse>	send()	Sends the command to the Camunda gateway.
PinClockCommandStep1	time(long timestamp)	Specifies the exact time to which the Zeebe engine's internal clock should be pinned using an epoch timestamp in milliseconds.
PinClockCommandStep1	time(Instant instant)	Specifies the exact time to which the Zeebe engine's internal clock should be pinned using an Instant object.

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

PinClockCommandImpl

public PinClockCommandImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

time

public PinClockCommandStep1 time(long timestamp)

Description copied from interface: PinClockCommandStep1

Specifies the exact time to which the Zeebe engine's internal clock should be pinned using an epoch timestamp in milliseconds.

Specified by:

time in interface PinClockCommandStep1

Parameters:

timestamp - the epoch time in milliseconds to which the clock should be pinned

Returns:

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

time

public PinClockCommandStep1 time(Instant instant)

Description copied from interface: PinClockCommandStep1

Specifies the exact time to which the Zeebe engine's internal clock should be pinned using an Instant object.

Specified by:

time in interface PinClockCommandStep1

Parameters:

instant - the Instant to which the clock should be pinned

Returns:

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

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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