public interface JobReport
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.
Modifier and Type | Method | Description |
---|---|---|
long |
getFailureBatchesCount() |
WriteBatcher
: gets the number of batches that the job failed to writeQueryBatcher
: 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
writeQueryBatcher
: gets the number of batches that the job failed to retrieve (same
as getFailureBatchesCount) |
java.util.Calendar |
getJobEndTime() |
Gets the timestamp at which
WriteBatcher
or QueryBatcher
finished the job |
java.util.Calendar |
getJobStartTime() |
Gets the timestamp at which
WriteBatcher
or QueryBatcher
started the job |
java.util.Calendar |
getReportTimestamp() |
Gets the timestamp at which this instance of
JobReport was created
|
long |
getSuccessBatchesCount() |
WriteBatcher
: gets the number of batches written to the databaseQueryBatcher
: gets the number of batches retrieved from the database |
long |
getSuccessEventsCount() |
WriteBatcher
: gets the number of documents written to the databaseQueryBatcher
: gets the number of items retrieved from the database |
long getSuccessEventsCount()
WriteBatcher
: gets the number of documents written to the databaseQueryBatcher
: gets the number of items retrieved from the databaselong getFailureEventsCount()
WriteBatcher
: gets the number of documents that were sent but failed to
writeQueryBatcher
: gets the number of batches that the job failed to retrieve (same
as getFailureBatchesCount)long getSuccessBatchesCount()
WriteBatcher
: gets the number of batches written to the databaseQueryBatcher
: gets the number of batches retrieved from the databaselong getFailureBatchesCount()
WriteBatcher
: gets the number of batches that the job failed to writeQueryBatcher
: gets the number of batches that the job failed to retrieve (same
as getFailureEventsCount)java.util.Calendar getReportTimestamp()
java.util.Calendar getJobStartTime()
WriteBatcher
or QueryBatcher
started the jobjava.util.Calendar getJobEndTime()
WriteBatcher
or QueryBatcher
finished the jobCopyright © 2022 MarkLogic Corporation