Class JobHistoryService

java.lang.Object

org.opensearch.jobscheduler.utils.JobHistoryService

public class JobHistoryService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_HISTORY_INDEX_NAME

Constructor Summary

Constructors

Constructor	Description
JobHistoryService(org.opensearch.transport.client.Client client, org.opensearch.cluster.service.ClusterService clusterService)

Method Summary

Modifier and Type	Method	Description
void	findHistoryRecord(String jobIndexName, String jobId, Instant startTime, org.opensearch.core.action.ActionListener<org.opensearch.jobscheduler.spi.StatusHistoryModel> listener)
boolean	historyIndexExist()
void	recordJobHistory(String jobIndexName, String jobId, Instant startTime, Instant endTime, Integer status, org.opensearch.core.action.ActionListener<Boolean> listener)	Records job execution history to the history index.
void	updateHistoryRecord(org.opensearch.jobscheduler.spi.StatusHistoryModel historyModelupdate, org.opensearch.core.action.ActionListener<org.opensearch.jobscheduler.spi.StatusHistoryModel> listener)

Methods inherited from class java.lang.Object

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

Field Details

JOB_HISTORY_INDEX_NAME

public static final String JOB_HISTORY_INDEX_NAME

See Also:

• Constant Field Values

Constructor Details

JobHistoryService

public JobHistoryService(org.opensearch.transport.client.Client client,
 org.opensearch.cluster.service.ClusterService clusterService)

Method Details

historyIndexExist

public boolean historyIndexExist()

recordJobHistory

public void recordJobHistory(String jobIndexName,
 String jobId,
 Instant startTime,
 Instant endTime,
 Integer status,
 org.opensearch.core.action.ActionListener<Boolean> listener)

Records job execution history to the history index.

Parameters:

startTime - the time when job execution started

endTime - the time when job execution ended (can be null for ongoing jobs)

status - the execution status (e.g., "RUNNING", "SUCCESS", "FAILED")

listener - callback for handling the response

updateHistoryRecord

public void updateHistoryRecord(org.opensearch.jobscheduler.spi.StatusHistoryModel historyModelupdate,
 org.opensearch.core.action.ActionListener<org.opensearch.jobscheduler.spi.StatusHistoryModel> listener)

findHistoryRecord

public void findHistoryRecord(String jobIndexName,
 String jobId,
 Instant startTime,
 org.opensearch.core.action.ActionListener<org.opensearch.jobscheduler.spi.StatusHistoryModel> listener)