Class

com.spotify.scio

ScioResult

Related Doc: package scio

Permalink

abstract class ScioResult extends AnyRef

Represent a Scio pipeline result.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScioResult
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val finalState: Future[State]

    Permalink

    Future for pipeline's final state.

    Future for pipeline's final state. The Future will be completed once the pipeline completes successfully.

  2. abstract def getMetrics: Metrics

    Permalink

    Get metrics of the finished pipeline.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. lazy val allCounters: Map[MetricName, MetricValue[Long]]

    Permalink

    Retrieve aggregated values of all counters from the pipeline.

  5. lazy val allCountersAtSteps: Map[MetricName, Map[String, MetricValue[Long]]]

    Permalink

    Retrieve per step values of all counters from the pipeline.

  6. lazy val allDistributions: Map[MetricName, MetricValue[DistributionResult]]

    Permalink

    Retrieve aggregated values of all distributions from the pipeline.

  7. lazy val allDistributionsAtSteps: Map[MetricName, Map[String, MetricValue[DistributionResult]]]

    Permalink

    Retrieve per step values of all distributions from the pipeline.

  8. lazy val allGauges: Map[MetricName, MetricValue[GaugeResult]]

    Permalink

    Retrieve latest values of all gauges from the pipeline.

  9. lazy val allGaugesAtSteps: Map[MetricName, Map[String, MetricValue[GaugeResult]]]

    Permalink

    Retrieve aggregated values of all gauges from the pipeline.

  10. def as[T <: RunnerResult](implicit arg0: ClassTag[T]): T

    Permalink

    Get a Beam runner specific result.

  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def counter(c: Counter): MetricValue[Long]

    Permalink

    Retrieve aggregated value of a single counter from the pipeline.

  14. def counterAtSteps(c: Counter): Map[String, MetricValue[Long]]

    Permalink

    Retrieve per step values of a single counter from the pipeline.

  15. def distribution(d: Distribution): MetricValue[DistributionResult]

    Permalink

    Retrieve aggregated value of a single distribution from the pipeline.

  16. def distributionAtSteps(d: Distribution): Map[String, MetricValue[DistributionResult]]

    Permalink

    Retrieve per step values of a single distribution from the pipeline.

  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def gauge(g: Gauge): MetricValue[GaugeResult]

    Permalink

    Retrieve latest value of a single gauge from the pipeline.

  21. def gaugeAtSteps(g: Gauge): Map[String, MetricValue[GaugeResult]]

    Permalink

    Retrieve per step values of a single gauge from the pipeline.

  22. def getAwaitDuration: Duration

    Permalink

    Get the timeout period of the Scio job.

    Get the timeout period of the Scio job. Default to Duration.Inf.

  23. def getBeamMetrics: BeamMetrics

    Permalink
    Attributes
    protected
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  26. val internal: PipelineResult

    Permalink
  27. def isCompleted: Boolean

    Permalink

    Whether the pipeline is completed.

  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def isTest: Boolean

    Permalink

    Whether this is the result of a test.

  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. def saveMetrics(filename: String): Unit

    Permalink

    Save metrics of the finished pipeline to a file.

  34. def state: State

    Permalink

    Pipeline's current state.

  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  36. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def waitUntilDone(duration: Duration = getAwaitDuration, cancelJob: Boolean = true): ScioResult

    Permalink

    Wait until the pipeline finishes with the State DONE (as opposed to CANCELLED or FAILED).

    Wait until the pipeline finishes with the State DONE (as opposed to CANCELLED or FAILED). Throw exception otherwise.

  41. def waitUntilFinish(duration: Duration = getAwaitDuration, cancelJob: Boolean = true): ScioResult

    Permalink

    Wait until the pipeline finishes.

    Wait until the pipeline finishes. If timeout duration is exceeded and cancelJob is set, cancel the internal PipelineResult.

Inherited from AnyRef

Inherited from Any

Ungrouped