com.marklogic.hub.dataservices

Interface FlowService

public interface FlowService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	addStepToFlow(java.lang.String flowName, java.lang.String stepName, java.lang.String stepDefinitionType) Invokes the addStepToFlow operation on the database server
com.fasterxml.jackson.databind.JsonNode	createFlow(java.lang.String name, java.lang.String description) Invokes the createFlow operation on the database server
void	deleteFlow(java.lang.String name) Invokes the deleteFlow operation on the database server
com.fasterxml.jackson.databind.JsonNode	getFlow(java.lang.String name) Invokes the getFlow operation on the database server
com.fasterxml.jackson.databind.JsonNode	getFlowsWithStepDetails() Invokes the getFlowsWithStepDetails operation on the database server
com.fasterxml.jackson.databind.JsonNode	getFlowWithLatestJobInfo(java.lang.String name) Invokes the getFlowWithLatestJobInfo operation on the database server
com.fasterxml.jackson.databind.JsonNode	getFullFlow(java.lang.String flowName) Invokes the getFullFlow operation on the database server
static FlowService	on(com.marklogic.client.DatabaseClient db) Creates a FlowService object for executing operations on the database server.
static FlowService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a FlowService object for executing operations on the database server.
com.fasterxml.jackson.databind.JsonNode	removeStepFromFlow(java.lang.String flowName, java.lang.String stepNumber) Invokes the removeStepFromFlow operation on the database server
com.fasterxml.jackson.databind.JsonNode	updateFlow(java.lang.String name, java.lang.String description, com.fasterxml.jackson.databind.node.ArrayNode stepIds) Invokes the updateFlow operation on the database server

Method Detail

on

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

Creates a FlowService 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 FlowService on(com.marklogic.client.DatabaseClient db,
                      com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)

Creates a FlowService 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

addStepToFlow

com.fasterxml.jackson.databind.JsonNode addStepToFlow(java.lang.String flowName,
                                                      java.lang.String stepName,
                                                      java.lang.String stepDefinitionType)

Invokes the addStepToFlow operation on the database server

Parameters:

flowName - provides input

stepName - provides input

stepDefinitionType - provides input

Returns:

Return the updated flow document

createFlow

com.fasterxml.jackson.databind.JsonNode createFlow(java.lang.String name,
                                                   java.lang.String description)

Invokes the createFlow operation on the database server

Parameters:

name - provides input

description - provides input

Returns:

Return the created flow document

deleteFlow

void deleteFlow(java.lang.String name)

Invokes the deleteFlow operation on the database server

Parameters:

name - provides input

getFlow

com.fasterxml.jackson.databind.JsonNode getFlow(java.lang.String name)

Invokes the getFlow operation on the database server

Parameters:

name - provides input

Returns:

as output

getFlowsWithStepDetails

com.fasterxml.jackson.databind.JsonNode getFlowsWithStepDetails()

Invokes the getFlowsWithStepDetails operation on the database server

Returns:

Return an array of flow documents, where each step has a few identifying data points and abstracts whether it's inline or referenced

getFlowWithLatestJobInfo

com.fasterxml.jackson.databind.JsonNode getFlowWithLatestJobInfo(java.lang.String name)

Invokes the getFlowWithLatestJobInfo operation on the database server

Parameters:

name - provides input

Returns:

as output

getFullFlow

com.fasterxml.jackson.databind.JsonNode getFullFlow(java.lang.String flowName)

Invokes the getFullFlow operation on the database server

Parameters:

flowName - provides input

Returns:

as output

removeStepFromFlow

com.fasterxml.jackson.databind.JsonNode removeStepFromFlow(java.lang.String flowName,
                                                           java.lang.String stepNumber)

Invokes the removeStepFromFlow operation on the database server

Parameters:

flowName - provides input

stepNumber - provides input

Returns:

Return the updated flow document

updateFlow

com.fasterxml.jackson.databind.JsonNode updateFlow(java.lang.String name,
                                                   java.lang.String description,
                                                   com.fasterxml.jackson.databind.node.ArrayNode stepIds)

Invokes the updateFlow operation on the database server

Parameters:

name - provides input

description - The description of the flow can be updated.

stepIds - The order of stepIds can be updated.

Returns:

Return the updated flow document