PushJobHeartbeatSender (venice API)

All Superinterfaces:: Runnable

All Known Implementing Classes:: NoOpPushJobHeartbeatSender

public interface PushJobHeartbeatSender extends Runnable

This interface provides methods to send push job heartbeats

Method Summary

Modifier and Type

Method

Description

Optional<Exception>

getFirstSendHeartbeatException()

Get first exception encountered while it is sending heartbeats.

Duration

getHeartbeatInitialDelay()

Duration

getHeartbeatSendInterval()

void

start(String storeName, int storeVersion)

void

stop()

Methods inherited from interface java.lang.Runnable
run

Method Details
- getHeartbeatSendInterval
  
  Duration getHeartbeatSendInterval()
- getHeartbeatInitialDelay
  
  Duration getHeartbeatInitialDelay()
- start
  
  void start(@Nonnull String storeName, int storeVersion)
- stop
  
  void stop()
- getFirstSendHeartbeatException
  
  Optional<Exception> getFirstSendHeartbeatException()
  
  Get first exception encountered while it is sending heartbeats. If there are multiple exceptions encountered during the process of sending heartbeats, only the first one is recorded and returned here.
  
  Returns:
  
  Empty optional if no exception