com.marklogic.hub.dataservices

Interface StepService

public interface StepService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
void	deleteStep(java.lang.String stepDefinitionType, java.lang.String stepName) Invokes the deleteStep operation on the database server
com.fasterxml.jackson.databind.JsonNode	getStep(java.lang.String stepDefinitionType, java.lang.String stepName) Invokes the getStep operation on the database server
com.fasterxml.jackson.databind.JsonNode	getStepsByType(java.util.stream.Stream<java.lang.String> propertiesToReturn) Invokes the getStepsByType operation on the database server
static StepService	on(com.marklogic.client.DatabaseClient db) Creates a StepService object for executing operations on the database server.
static StepService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a StepService object for executing operations on the database server.
com.fasterxml.jackson.databind.JsonNode	saveStep(java.lang.String stepDefinitionType, com.fasterxml.jackson.databind.JsonNode stepProperties, java.lang.Boolean overwrite, java.lang.Boolean throwErrorIfStepIsPresent) Invokes the saveStep operation on the database server

Method Detail

on

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

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

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

getStepsByType

com.fasterxml.jackson.databind.JsonNode getStepsByType(java.util.stream.Stream<java.lang.String> propertiesToReturn)

Invokes the getStepsByType operation on the database server

Parameters:

propertiesToReturn - List of properties to return. Default behavior returns all properties

Returns:

as output

saveStep

com.fasterxml.jackson.databind.JsonNode saveStep(java.lang.String stepDefinitionType,
                                                 com.fasterxml.jackson.databind.JsonNode stepProperties,
                                                 java.lang.Boolean overwrite,
                                                 java.lang.Boolean throwErrorIfStepIsPresent)

Invokes the saveStep operation on the database server

Parameters:

stepDefinitionType - provides input

stepProperties - provides input

overwrite - provides input

throwErrorIfStepIsPresent - provides input

Returns:

Return the created/updated step document

deleteStep

void deleteStep(java.lang.String stepDefinitionType,
                java.lang.String stepName)

Invokes the deleteStep operation on the database server

Parameters:

stepDefinitionType - provides input

stepName - provides input

getStep

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

Invokes the getStep operation on the database server

Parameters:

stepDefinitionType - provides input

stepName - provides input

Returns:

Return the step document