Class

com.spotify.scio

ScioResult

Related Doc: package scio

Permalink

abstract class ScioResult extends AnyRef

Represent a Scio pipeline result.

Linear Supertypes
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 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 getBeamMetrics: BeamMetrics

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

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

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

    Permalink
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. def isTest: Boolean

    Permalink

    Whether this is the result of a test.

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

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

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

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

    Permalink

    Save metrics of the finished pipeline to a file.

  32. def state: State

    Permalink

    Pipeline's current state.

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

    Permalink
    Definition Classes
    AnyRef
  34. def tap[T](tap: ClosedTap[T]): Tap[T]

    Permalink
  35. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalState: Future[State]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.0) Scio 0.8 does not use Futures anymore. You can simply use the 'state' directly to get a State

  2. def isCompleted: Boolean

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.0) ScioResult is guaranteed to be completed in Scio > 0.8.0

Inherited from AnyRef

Inherited from Any

Ungrouped