com.marklogic.hub.flow

Interface FlowRunner

All Known Implementing Classes:

FlowRunnerImpl

public interface FlowRunner

Method Summary

Modifier and Type	Method and Description
void	awaitCompletion() Blocks until the job is complete.
void	awaitCompletion(long timeout, java.util.concurrent.TimeUnit unit) Blocks until the job is complete.
FlowRunner	onFinished(FlowFinishedListener listener)
FlowRunner	onItemComplete(FlowItemCompleteListener listener)
FlowRunner	onItemFailed(FlowItemFailureListener listener)
FlowRunner	onStatusChanged(FlowStatusListener listener)
com.marklogic.client.datamovement.JobTicket	run()
FlowRunner	withBatchSize(int batchSize)
FlowRunner	withDestinationDatabase(java.lang.String destinationDatabase)
FlowRunner	withFlow(Flow flow)
FlowRunner	withOptions(java.util.Map<java.lang.String,java.lang.Object> options)
FlowRunner	withSourceClient(com.marklogic.client.DatabaseClient sourceClient)
FlowRunner	withStopOnFailure(boolean stopOnFailure)
FlowRunner	withThreadCount(int threadCount)

Method Detail

withFlow

FlowRunner withFlow(Flow flow)

withBatchSize

FlowRunner withBatchSize(int batchSize)

withThreadCount

FlowRunner withThreadCount(int threadCount)

withSourceClient

FlowRunner withSourceClient(com.marklogic.client.DatabaseClient sourceClient)

withDestinationDatabase

FlowRunner withDestinationDatabase(java.lang.String destinationDatabase)

withOptions

FlowRunner withOptions(java.util.Map<java.lang.String,java.lang.Object> options)

withStopOnFailure

FlowRunner withStopOnFailure(boolean stopOnFailure)

onItemComplete

FlowRunner onItemComplete(FlowItemCompleteListener listener)

onItemFailed

FlowRunner onItemFailed(FlowItemFailureListener listener)

onStatusChanged

FlowRunner onStatusChanged(FlowStatusListener listener)

onFinished

FlowRunner onFinished(FlowFinishedListener listener)

awaitCompletion

void awaitCompletion()

Blocks until the job is complete.

awaitCompletion

void awaitCompletion(long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException

Blocks until the job is complete.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

java.lang.InterruptedException - if interrupted while waiting

run

com.marklogic.client.datamovement.JobTicket run()