public interface PipelineResult
Pipeline.run()
.
This is often a job handle to an underlying data processing engine.
Modifier and Type | Interface and Description |
---|---|
static class |
PipelineResult.State
Possible job states, for both completed and ongoing jobs.
|
Modifier and Type | Method and Description |
---|---|
PipelineResult.State |
cancel()
Cancels the pipeline execution.
|
PipelineResult.State |
getState()
Retrieves the current state of the pipeline execution.
|
MetricResults |
metrics()
Returns the object to access metrics from the pipeline.
|
PipelineResult.State |
waitUntilFinish()
Waits until the pipeline finishes and returns the final status.
|
PipelineResult.State |
waitUntilFinish(Duration duration)
Waits until the pipeline finishes and returns the final status.
|
PipelineResult.State getState()
PipelineResult.State
representing the state of this pipeline.PipelineResult.State cancel() throws java.io.IOException
java.io.IOException
- if there is a problem executing the cancel request.java.lang.UnsupportedOperationException
- if the runner does not support cancellation.PipelineResult.State waitUntilFinish(Duration duration)
duration
- The time to wait for the pipeline to finish. Provide a value less than 1 ms for
an infinite wait.java.lang.UnsupportedOperationException
- if the runner does not support waiting to finish with a
timeout.PipelineResult.State waitUntilFinish()
java.lang.UnsupportedOperationException
- if the runner does not support waiting to finish.MetricResults metrics()
java.lang.UnsupportedOperationException
- if the runner doesn't support retrieving metrics.