org.apache.beam.runners.apex

Class ApexRunnerResult

java.lang.Object

org.apache.beam.runners.apex.ApexRunnerResult

All Implemented Interfaces:

PipelineResult

public class ApexRunnerResult
extends java.lang.Object
implements PipelineResult

Result of executing a Pipeline with Apex in embedded mode.

Nested Class Summary

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

PipelineResult.State

Constructor Summary

Constructors

Constructor and Description
ApexRunnerResult(com.datatorrent.api.DAG dag, org.apache.apex.api.Launcher.AppHandle apexApp)

Method Summary

Modifier and Type	Method and Description
PipelineResult.State	cancel() Cancels the pipeline execution.
protected void	cleanupOnCancelOrFinish() Opportunity for a subclass to perform cleanup, such as removing temporary files.
com.datatorrent.api.DAG	getApexDAG() Return the DAG executed by the pipeline.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApexRunnerResult

public ApexRunnerResult(com.datatorrent.api.DAG dag,
                        org.apache.apex.api.Launcher.AppHandle apexApp)

Method Detail

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.

cancel

public PipelineResult.State cancel()
                            throws java.io.IOException

Description copied from interface: PipelineResult

Cancels the pipeline execution.

Specified by:

cancel in interface PipelineResult

Throws:

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

waitUntilFinish

@Nullable
public PipelineResult.State waitUntilFinish(@Nullable
                                                      Duration duration)

Description copied from interface: PipelineResult

Waits until the pipeline finishes and returns the final status. It times out after the given duration.

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.

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.

metrics

public MetricResults metrics()

Description copied from interface: PipelineResult

Returns the object to access metrics from the pipeline.

Specified by:

metrics in interface PipelineResult

getApexDAG

public com.datatorrent.api.DAG getApexDAG()

Return the DAG executed by the pipeline.

Returns:

DAG from translation.

cleanupOnCancelOrFinish

protected void cleanupOnCancelOrFinish()

Opportunity for a subclass to perform cleanup, such as removing temporary files.