public interface FlowManager
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
FLOW_FILE_EXTENSION
String value for the flow file extension
|
Modifier and Type | Method and Description |
---|---|
Flow |
createFlow(java.lang.String flowName)
Creates a flow
|
Flow |
createFlowFromJSON(com.fasterxml.jackson.databind.JsonNode json)
Creates a flow from a given JsonNode
|
Flow |
createFlowFromJSON(java.lang.String json)
Creates a flow from a given JSON string
|
void |
deleteFlow(java.lang.String flowName)
Deletes a flow
|
void |
deleteStep(Flow flow,
java.lang.String stepKey) |
Flow |
getFlow(java.lang.String flowName)
Retrieves a named flow on the MarkLogic server
|
java.lang.String |
getFlowAsJSON(java.lang.String flowName)
Returns a flow based on the provided name as JSON string
|
java.util.List<java.lang.String> |
getFlowNames()
Retrieves a list of names of flows installed on the MarkLogic server
|
java.util.List<Flow> |
getFlows()
Retrieves a list of flows installed on the MarkLogic server
|
Flow |
getFullFlow(java.lang.String flowName)
Retrieves the expanded flow document with properties from artifact and settings
|
Flow |
getLocalFlow(java.lang.String flowName)
Retrieves a named flow from the Data Hub project
|
java.util.List<java.lang.String> |
getLocalFlowNames()
Retrieves a list of names of flows in the local project
|
java.util.List<Flow> |
getLocalFlows()
Retrieves a list of flows in a Data Hub project
|
java.util.List<com.fasterxml.jackson.databind.node.ObjectNode> |
getLocalFlowsAsJSON()
Retrieves a list of flows in a Data Hub project
|
Step |
getStep(Flow flow,
java.lang.String stepNum)
Deprecated.
|
java.util.Map<java.lang.String,Step> |
getSteps(Flow flow)
Deprecated.
|
boolean |
isFlowExisted(java.lang.String flowName)
Check if a flow has existed
|
void |
saveFlow(Flow flow)
Saves a flow to project structure and MarkLogic instance
|
void |
saveLocalFlow(Flow flow)
Saves a flow to project structure
|
void |
setHubConfig(HubConfig hubConfig)
Set the HubConfig
|
void |
setSteps(Flow flow,
java.util.Map<java.lang.String,Step> stepMap)
Deprecated.
|
static final java.lang.String FLOW_FILE_EXTENSION
void setHubConfig(HubConfig hubConfig)
hubConfig
- - the hubConfig to useFlow getFlow(java.lang.String flowName)
flowName
- - name of the flowFlow getLocalFlow(java.lang.String flowName)
flowName
- - name of the flowFlow getFullFlow(java.lang.String flowName)
flowName
- - name of the flowjava.lang.String getFlowAsJSON(java.lang.String flowName)
flowName
- - name of the flowjava.util.List<Flow> getFlows()
java.util.List<Flow> getLocalFlows()
java.util.List<com.fasterxml.jackson.databind.node.ObjectNode> getLocalFlowsAsJSON()
java.util.List<java.lang.String> getLocalFlowNames()
java.util.List<java.lang.String> getFlowNames()
Flow createFlow(java.lang.String flowName)
flowName
- - name of the flowFlow createFlowFromJSON(java.lang.String json)
json
- - string representation of the flowFlow createFlowFromJSON(com.fasterxml.jackson.databind.JsonNode json)
json
- - JsonNode representation of the flowvoid deleteFlow(java.lang.String flowName)
flowName
- - name of the flowvoid saveLocalFlow(Flow flow)
flow
- - the flow object to be savedvoid saveFlow(Flow flow)
flow
- - the flow object to be savedvoid deleteStep(Flow flow, java.lang.String stepKey)
flow
- stepKey
- the step map key corresponding to the step to deleteboolean isFlowExisted(java.lang.String flowName)
flowName
- a flow name@Deprecated java.util.Map<java.lang.String,Step> getSteps(Flow flow)
flow
- a flow object@Deprecated void setSteps(Flow flow, java.util.Map<java.lang.String,Step> stepMap)
flow
- a flow objectstepMap
- a map of steps