|
1 | 1 | # FlowExecution |
2 | 2 |
|
3 | | -`FlowExecution` is...FIXME |
| 3 | +`FlowExecution` is an [abstraction](#contract) of [flow executions](#implementations) (batch or streaming). |
| 4 | + |
| 5 | +`FlowExecution` can be [executed asynchronously](#executeAsync). |
| 6 | + |
| 7 | +## Contract |
| 8 | + |
| 9 | +### TableIdentifier { #identifier } |
| 10 | + |
| 11 | +```scala |
| 12 | +identifier: TableIdentifier |
| 13 | +``` |
| 14 | + |
| 15 | +### Destination { #destination } |
| 16 | + |
| 17 | +```scala |
| 18 | +destination: Output |
| 19 | +``` |
| 20 | + |
| 21 | +### QueryOrigin { #getOrigin } |
| 22 | + |
| 23 | +```scala |
| 24 | +getOrigin: QueryOrigin |
| 25 | +``` |
| 26 | + |
| 27 | +### isStreaming { #isStreaming } |
| 28 | + |
| 29 | +```scala |
| 30 | +isStreaming: Boolean |
| 31 | +``` |
| 32 | + |
| 33 | +### PipelineUpdateContext { #updateContext } |
| 34 | + |
| 35 | +```scala |
| 36 | +updateContext: PipelineUpdateContext |
| 37 | +``` |
| 38 | + |
| 39 | +[PipelineUpdateContext](PipelineUpdateContext.md) of this flow execution |
| 40 | + |
| 41 | +### executeInternal { #executeInternal } |
| 42 | + |
| 43 | +```scala |
| 44 | +executeInternal(): Future[Unit] |
| 45 | +``` |
| 46 | + |
| 47 | +See: |
| 48 | + |
| 49 | +* [BatchTableWrite](BatchTableWrite.md#executeInternal) |
| 50 | +* [StreamingFlowExecution](StreamingFlowExecution.md#executeInternal) |
| 51 | + |
| 52 | +Used when: |
| 53 | + |
| 54 | +* `FlowExecution` is requested to [execute asynchronously](#executeAsync) |
| 55 | + |
| 56 | +## Implementations |
| 57 | + |
| 58 | +* [BatchTableWrite](BatchTableWrite.md) |
| 59 | +* [StreamingFlowExecution](StreamingFlowExecution.md) |
| 60 | + |
| 61 | +## Execute Asynchronously { #executeAsync } |
| 62 | + |
| 63 | +```scala |
| 64 | +executeAsync(): Unit |
| 65 | +``` |
| 66 | + |
| 67 | +`executeAsync` uses the internal [_future](#_future) to control whether this flow has been executed or not. |
| 68 | + |
| 69 | +`executeAsync` [executeInternal](#executeInternal) (and stores the result of this execution in the internal [_future](#_future)). |
| 70 | + |
| 71 | +??? note "Final Method" |
| 72 | + `executeAsync` is a Scala **final method** and may not be overridden in [subclasses](#implementations). |
| 73 | + |
| 74 | + Learn more in the [Scala Language Specification]({{ scala.spec }}/05-classes-and-objects.html#final). |
| 75 | + |
| 76 | +--- |
| 77 | + |
| 78 | +`executeAsync` is used when: |
| 79 | + |
| 80 | +* `GraphExecution` is requested to [planAndStartFlow](GraphExecution.md#planAndStartFlow) |
0 commit comments