com.yahoo.bard.webservice.async.workflows

Interface AsynchronousWorkflowsBuilder

All Known Implementing Classes:

DefaultAsynchronousWorkflowsBuilder

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AsynchronousWorkflowsBuilder

A SAM that sets up the workflow for shipping query results back to the user, and saving query results for later querying if necessary.

Method Summary

Modifier and Type	Method and Description
AsynchronousWorkflows	buildAsynchronousWorkflows(rx.Observable<PreResponse> preResponseEmitter, rx.Observable<Either<PreResponse,JobRow>> payloadEmitter, JobRow jobMetadata, Function<JobRow,String> jobMetadataSerializer) Builds the asynchronous workflows.

Method Detail

buildAsynchronousWorkflows

AsynchronousWorkflows buildAsynchronousWorkflows(rx.Observable<PreResponse> preResponseEmitter,
                                                 rx.Observable<Either<PreResponse,JobRow>> payloadEmitter,
                                                 JobRow jobMetadata,
                                                 Function<JobRow,String> jobMetadataSerializer)

Builds the asynchronous workflows.

There are four workflows:

1. One that emits the results of the query if the query is synchronous.
2. One that emits the (serialized) job metadata if the query is asynchronous.
3. One that emits notifications that the PreResponse is ready to be accessed.
4. One that emits notifications that the Job has been marked complete.

WARNING: Some implementations (i.e. DefaultAsynchronousWorkflowsBuilder) may communicate with external resources, or do other potentially expensive operations. If you wish to guarantee that the asynchronous workflows are executed at most once (as opposed to once per subscription), then make sure to pass in instances of ConnectableObservable.

Parameters:

preResponseEmitter - The Observable that will eventually emit the results of the backend query

payloadEmitter - The Observable that will emit the results of the query if the query is synchronous, and the job metadata if the query is asynchronous

jobMetadata - The query's metadata

jobMetadataSerializer - A function that serializes a given JobRow into the payload to return to the user

Returns:

A bean containing all the asynchronous workflows