package temporal.api.testservice.v1

Get desktop application:
View/edit binary Protocol Buffers messages

TestService API defines an interface supported only by the Temporal Test Server. It provides functionality needed or supported for testing purposes only. This is an EXPERIMENTAL API.

• rpc LockTimeSkipping (LockTimeSkippingRequest, LockTimeSkippingResponse)

  service.proto:49

  LockTimeSkipping increments Time Locking Counter by one. If Time Locking Counter is positive, time skipping is locked (disabled). When time skipping is disabled, the time in test server is moving normally, with a real time pace. Test Server is typically started with locked time skipping and Time Locking Counter = 1. LockTimeSkipping and UnlockTimeSkipping calls are counted.

  message LockTimeSkippingRequest

  request_response.proto:37

  (message has no fields)

  message LockTimeSkippingResponse

  request_response.proto:40

  (message has no fields)

• rpc UnlockTimeSkipping (UnlockTimeSkippingRequest, UnlockTimeSkippingResponse)

  service.proto:59

  UnlockTimeSkipping decrements Time Locking Counter by one. If the counter reaches 0, it unlocks time skipping and fast forwards time. LockTimeSkipping and UnlockTimeSkipping calls are counted. Calling UnlockTimeSkipping does not guarantee that time is going to be fast forwarded as another lock can be holding it. Time Locking Counter can't be negative, unbalanced calls to UnlockTimeSkipping will lead to rpc call failure

  message UnlockTimeSkippingRequest

  request_response.proto:43

  (message has no fields)

  message UnlockTimeSkippingResponse

  request_response.proto:46

  (message has no fields)

• rpc Sleep (SleepRequest, SleepResponse)

  service.proto:64

  This call returns only when the Test Server Time advances by the specified duration. This is an EXPERIMENTAL API.

• rpc SleepUntil (SleepUntilRequest, SleepResponse)

  service.proto:70

  This call returns only when the Test Server Time advances to the specified timestamp. If the current Test Server Time is beyond the specified timestamp, returns immediately. This is an EXPERIMENTAL API.

  message SleepUntilRequest

  request_response.proto:49

  • optional google.protobuf.Timestamp timestamp = 1

• rpc UnlockTimeSkippingWithSleep (SleepRequest, SleepResponse)

  service.proto:82

  UnlockTimeSkippingWhileSleep decreases time locking counter by one and increases it back once the Test Server Time advances by the duration specified in the request. This call returns only when the Test Server Time advances by the specified duration. If it is called when Time Locking Counter is - more than 1 and no other unlocks are coming in, rpc call will block for the specified duration, time will not be fast forwarded. - 1, it will lead to fast forwarding of the time by the duration specified in the request and quick return of this rpc call. - 0 will lead to rpc call failure same way as an unbalanced UnlockTimeSkipping.

• rpc GetCurrentTime (google.protobuf.Empty, GetCurrentTimeResponse)

  service.proto:88

  GetCurrentTime returns the current Temporal Test Server time This time might not be equal to {@link System#currentTimeMillis()} due to time skipping.

  message GetCurrentTimeResponse

  request_response.proto:60

  • optional google.protobuf.Timestamp time = 1

Used as request type in: TestService.Sleep, TestService.UnlockTimeSkippingWithSleep

• optional google.protobuf.Duration duration = 1

Used as response type in: TestService.Sleep, TestService.SleepUntil, TestService.UnlockTimeSkippingWithSleep

(message has no fields)