Package org.apache.beam.runners.spark.structuredstreaming

Class SparkStructuredStreamingPipelineResult

java.lang.Object

org.apache.beam.runners.spark.structuredstreaming.SparkStructuredStreamingPipelineResult

All Implemented Interfaces:

PipelineResult

public class SparkStructuredStreamingPipelineResult
extends Object
implements PipelineResult

Result of a pipeline submitted to the SparkStructuredStreamingRunner. The pipeline runs asynchronously on a dedicated thread.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.PipelineResult

PipelineResult.State

Method Summary

Modifier and Type	Method	Description
PipelineResult.State	cancel()	Requests cancellation of the pipeline and returns immediately.
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 up to duration for the execution thread.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.beam.sdk.PipelineResult

drain

Method Details

getState

public PipelineResult.State getState()

Description copied from interface: PipelineResult

Retrieves the current state of the pipeline execution.

Specified by:

getState in interface PipelineResult

Returns:

the PipelineResult.State representing the state of this pipeline.

waitUntilFinish

public PipelineResult.State waitUntilFinish()

Description copied from interface: PipelineResult

Waits until the pipeline finishes and returns the final status.

Specified by:

waitUntilFinish in interface PipelineResult

Returns:

The final state of the pipeline.

waitUntilFinish

public PipelineResult.State waitUntilFinish(Duration duration)

Waits up to duration for the execution thread. A pipeline that ends after cancel() is CANCELLED, any other failure is rethrown and the pipeline is FAILED.

Specified by:

waitUntilFinish in interface PipelineResult

Parameters:

duration - The time to wait for the pipeline to finish. Provide a value less than 1 ms for an infinite wait.

Returns:

The final state of the pipeline or null on timeout.

metrics

public MetricResults metrics()

Description copied from interface: PipelineResult

Returns the object to access metrics from the pipeline.

Specified by:

metrics in interface PipelineResult

cancel

public PipelineResult.State cancel()
                            throws IOException

Requests cancellation of the pipeline and returns immediately.

Specified by:

cancel in interface PipelineResult

Throws:

IOException - if there is a problem executing the cancel request.