JobReport (MarkLogic Java Client API 8.1.0)

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

SEARCH:

public interface JobReport

A Job report is used to report status on a WriteBatcher or a QueryBatcher job at any point of time after it is started and provide a snapshot of the job's status at that time.

Note that for a query job, the counts of successful and failed events and batches only account for the process of retrieving items from the database. They do not account for the processing of batches of items via user-provided instances of QueryBatchListener. Such instances are responsible for determining their own definitions of "success" and "failure". See ApplyTransformListener for an example of how this can be done.

Method Summary

Modifier and Type

Method

Description

long

getFailureBatchesCount()

WriteBatcher : gets the number of batches that the job failed to write
QueryBatcher : gets the number of batches that the job failed to retrieve (same as getFailureEventsCount)

long

getFailureEventsCount()

WriteBatcher : gets the number of documents that were sent but failed to write
QueryBatcher : gets the number of batches that the job failed to retrieve (same as getFailureBatchesCount)

Calendar

getJobEndTime()

Gets the timestamp at which WriteBatcher or QueryBatcher finished the job

Calendar

getJobStartTime()

Gets the timestamp at which WriteBatcher or QueryBatcher started the job

Calendar

getReportTimestamp()

Gets the timestamp at which this instance of JobReport was created

long

getSuccessBatchesCount()

WriteBatcher : gets the number of batches written to the database
QueryBatcher : gets the number of batches retrieved from the database

long

getSuccessEventsCount()

WriteBatcher : gets the number of documents written to the database
QueryBatcher : gets the number of items retrieved from the database

Method Details
- getSuccessEventsCount
  
  long getSuccessEventsCount()
  
  WriteBatcher : gets the number of documents written to the database
  QueryBatcher : gets the number of items retrieved from the database
  
  Returns:
  
  the number of events that succeeded
- getFailureEventsCount
  
  long getFailureEventsCount()
  
  WriteBatcher : gets the number of documents that were sent but failed to write
  QueryBatcher : gets the number of batches that the job failed to retrieve (same as getFailureBatchesCount)
  
  Returns:
  
  the number of events that failed
- getSuccessBatchesCount
  
  long getSuccessBatchesCount()
  
  WriteBatcher : gets the number of batches written to the database
  QueryBatcher : gets the number of batches retrieved from the database
  
  Returns:
  
  the number of batches that succeeded
- getFailureBatchesCount
  
  long getFailureBatchesCount()
  
  WriteBatcher : gets the number of batches that the job failed to write
  QueryBatcher : gets the number of batches that the job failed to retrieve (same as getFailureEventsCount)
  
  Returns:
  
  the number of batches that failed
- getReportTimestamp
  
  Calendar getReportTimestamp()
  
  Gets the timestamp at which this instance of JobReport was created
  
  Returns:
  
  the timestamp of the JobReport
- getJobStartTime
  
  Calendar getJobStartTime()
  
  Gets the timestamp at which WriteBatcher or QueryBatcher started the job
  
  Returns:
  
  the job start time or null if the job hasn't started yet
- getJobEndTime
  
  Calendar getJobEndTime()
  
  Gets the timestamp at which WriteBatcher or QueryBatcher finished the job
  
  Returns:
  
  the job end time or null if the job hasn't ended yet

Interface JobReport

Method Summary

Method Details

getSuccessEventsCount

getFailureEventsCount

getSuccessBatchesCount

getFailureBatchesCount

getReportTimestamp

getJobStartTime

getJobEndTime