PipelineResult (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

Warning: Dataflow SDK 1.x for Java is unsupported as of October 16, 2018. See Migrating from Dataflow SDK 1.x for Java for migration guidance.

Note: If you are using Cloud Dataflow SDK version 2.x, see the Apache Beam API reference documentation.

com.google.cloud.dataflow.sdk

Interface PipelineResult

• All Known Subinterfaces:

  DirectPipelineRunner.EvaluationContext, DirectPipelineRunner.EvaluationResults

  All Known Implementing Classes:

  DataflowPipelineJob, InProcessPipelineRunner.InProcessPipelineResult

  ---

  
  

  public interface PipelineResult

  Result of Pipeline.run().

• • Nested Class Summary

    Nested Classes 

    Modifier and Type	Interface and Description
    static class	PipelineResult.State Named constants for common values for the job state.

  • Method Summary

    All Methods Instance Methods Abstract Methods 

    Modifier and Type	Method and Description
    <T> AggregatorValues<T>	getAggregatorValues(Aggregator<?,T> aggregator) Retrieves the current value of the provided Aggregator.
    PipelineResult.State	getState() Retrieves the current state of the pipeline execution.

• • Method Detail

    • getState

      PipelineResult.State getState()

      Retrieves the current state of the pipeline execution.

      Returns:

      the PipelineResult.State representing the state of this pipeline.

    • getAggregatorValues

      <T> AggregatorValues<T> getAggregatorValues(Aggregator<?,T> aggregator)
                                           throws AggregatorRetrievalException

      Retrieves the current value of the provided Aggregator.

      Parameters:

      aggregator - the Aggregator to retrieve values for.

      Returns:

      the current values of the Aggregator, which may be empty if there are no values yet.

      Throws:

      AggregatorRetrievalException - if the Aggregator values could not be retrieved.