com.marklogic.hub.dataservices

Interface JobService

public interface JobService

Defines endpoints for managing Job documents

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	findStepResponses(com.fasterxml.jackson.databind.JsonNode endpointConstants)
com.fasterxml.jackson.databind.JsonNode	finishJob(java.lang.String jobId, java.lang.String jobStatus) Updated the Job document associated with jobId with the given jobStatus
com.fasterxml.jackson.databind.JsonNode	finishStep(java.lang.String jobId, java.lang.String stepNumber, java.lang.String stepStatus, com.fasterxml.jackson.databind.JsonNode runStepResponse) Updates the associated Job document after all batches have been processed for a step
com.fasterxml.jackson.databind.JsonNode	getJob(java.lang.String jobId) Get the Job document associated with the given job ID
com.fasterxml.jackson.databind.JsonNode	getJobWithDetails(java.lang.String jobId) Get the Job document associated with the given job ID and additional metadata
com.fasterxml.jackson.databind.JsonNode	getMatchingPropertyValues(com.fasterxml.jackson.databind.JsonNode facetValuesSearchQuery) Invokes the getMatchingPropertyValues operation on the database server
static JobService	on(com.marklogic.client.DatabaseClient db) Creates a JobService object for executing operations on the database server.
static JobService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a JobService object for executing operations on the database server.
com.fasterxml.jackson.databind.JsonNode	startJob(java.lang.String jobId, java.lang.String flowName) Start a new job for the given flowName by creating a new Job document
com.fasterxml.jackson.databind.JsonNode	startStep(java.lang.String jobId, java.lang.String stepNumber, java.lang.String flowName, com.fasterxml.jackson.databind.JsonNode runTimeOptions) Updates the Job document associated with the given jobId to note that the step has been started

Method Detail

on

static JobService on(com.marklogic.client.DatabaseClient db)

Creates a JobService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads.

Parameters:

db - provides a client for communicating with the database server

Returns:

an object for executing database operations

on

static JobService on(com.marklogic.client.DatabaseClient db,
                     com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)

Creates a JobService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads. The service declaration uses a custom implementation of the same service instead of the default implementation of the service by specifying an endpoint directory in the modules database with the implementation. A service.json file with the declaration can be read with FileHandle or a string serialization of the JSON declaration with StringHandle.

Parameters:

db - provides a client for communicating with the database server

serviceDeclaration - substitutes a custom implementation of the service

Returns:

an object for executing database operations

startStep

com.fasterxml.jackson.databind.JsonNode startStep(java.lang.String jobId,
                                                  java.lang.String stepNumber,
                                                  java.lang.String flowName,
                                                  com.fasterxml.jackson.databind.JsonNode runTimeOptions)

Updates the Job document associated with the given jobId to note that the step has been started

Parameters:

jobId - provides input

stepNumber - provides input

flowName - provides input

runTimeOptions - provides input

Returns:

The updated Job document

finishStep

com.fasterxml.jackson.databind.JsonNode finishStep(java.lang.String jobId,
                                                   java.lang.String stepNumber,
                                                   java.lang.String stepStatus,
                                                   com.fasterxml.jackson.databind.JsonNode runStepResponse)

Updates the associated Job document after all batches have been processed for a step

Parameters:

jobId - provides input

stepNumber - provides input

stepStatus - provides input

runStepResponse - provides input

Returns:

The updated Job document

getJob

com.fasterxml.jackson.databind.JsonNode getJob(java.lang.String jobId)

Get the Job document associated with the given job ID

Parameters:

jobId - provides input

Returns:

as output

startJob

com.fasterxml.jackson.databind.JsonNode startJob(java.lang.String jobId,
                                                 java.lang.String flowName)

Start a new job for the given flowName by creating a new Job document

Parameters:

jobId - provides input

flowName - provides input

Returns:

The created Job document

getJobWithDetails

com.fasterxml.jackson.databind.JsonNode getJobWithDetails(java.lang.String jobId)

Get the Job document associated with the given job ID and additional metadata

Parameters:

jobId - provides input

Returns:

as output

getMatchingPropertyValues

com.fasterxml.jackson.databind.JsonNode getMatchingPropertyValues(com.fasterxml.jackson.databind.JsonNode facetValuesSearchQuery)

Invokes the getMatchingPropertyValues operation on the database server

Parameters:

facetValuesSearchQuery - provides input

Returns:

as output

finishJob

com.fasterxml.jackson.databind.JsonNode finishJob(java.lang.String jobId,
                                                  java.lang.String jobStatus)

Updated the Job document associated with jobId with the given jobStatus

Parameters:

jobId - provides input

jobStatus - provides input

Returns:

The finished Job document

findStepResponses

com.fasterxml.jackson.databind.JsonNode findStepResponses(com.fasterxml.jackson.databind.JsonNode endpointConstants)

Parameters:

endpointConstants - provides input

Returns:

as output