com.marklogic.hub.job

Interface JobMonitor

All Known Implementing Classes:

JobMonitorImpl

public interface JobMonitor

Monitor job / batch status

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getBatchResponse(java.lang.String jobId, java.lang.String batchId) Returns the response (uris or error msgs) of the batch
java.lang.String	getBatchStatus(java.lang.String jobId, java.lang.String batchId) Sets the flow to be used with the flow runner
java.util.Map<java.lang.String,java.lang.String>	getCurrentJobs() Gets the current running jobs
java.lang.String	getJobStatus(java.lang.String jobId) Sets the flow to be used with the flow runner
java.util.Map<java.lang.String,java.lang.String>	getStepBatchStatus(java.lang.String jobId, java.lang.String step) Sets the flow to be used with the flow runner

Method Detail

getCurrentJobs

java.util.Map<java.lang.String,java.lang.String> getCurrentJobs()

Gets the current running jobs

Returns:

A map of the current running job ids and their status

getJobStatus

java.lang.String getJobStatus(java.lang.String jobId)

Sets the flow to be used with the flow runner

Parameters:

jobId - the flow object to be used

Returns:

string denoting the status of the running job, ex: "running step 1"

getBatchStatus

java.lang.String getBatchStatus(java.lang.String jobId,
                                java.lang.String batchId)

Sets the flow to be used with the flow runner

Parameters:

jobId - the id of the job

batchId - the id of the batch

Returns:

string denoting status of the batch

getStepBatchStatus

java.util.Map<java.lang.String,java.lang.String> getStepBatchStatus(java.lang.String jobId,
                                                                    java.lang.String step)

Sets the flow to be used with the flow runner

Parameters:

jobId - the id of the batch

step - the step of the job

Returns:

Map containing batch id and status of the batch

getBatchResponse

java.util.List<java.lang.String> getBatchResponse(java.lang.String jobId,
                                                  java.lang.String batchId)

Returns the response (uris or error msgs) of the batch

Parameters:

jobId - the id of the job

batchId - the id of the batch

Returns:

the flow runner object