Class/Object

com.spotify.scio

ScioContext

Related Docs: object ScioContext | package scio

Permalink

class ScioContext extends TransformNameable

Main entry point for Scio functionality. A ScioContext represents a pipeline and can be used to create SCollections and distributed caches on that cluster.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScioContext
  2. TransformNameable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def customInput[T, I >: PBegin <: PInput](name: String, transform: PTransform[I, PCollection[T]])(implicit arg0: Coder[T]): SCollection[T]

    Permalink

    Get an SCollection with a custom input transform.

    Get an SCollection with a custom input transform. The transform should have a unique name.

  7. def datastore(projectId: String, query: Query, namespace: String = null): SCollection[Entity]

    Permalink

    Get an SCollection for a Datastore query.

  8. def empty[T]()(implicit arg0: Coder[T]): SCollection[T]

    Permalink

    Form an empty SCollection.

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def initCounter(counters: Counter*): Seq[Counter]

    Permalink

    Initialize a given Counter metric.

  15. def initCounter(namespace: String, name: String): Counter

    Permalink

    Initialize a new Counter metric from namespace and name.

  16. def initCounter[T](name: String)(implicit arg0: ClassTag[T]): Counter

    Permalink

    Initialize a new Counter metric using T as namespace.

    Initialize a new Counter metric using T as namespace. Default is "com.spotify.scio.ScioMetrics" if T is not specified.

  17. def isClosed: Boolean

    Permalink

    Whether the context is closed.

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. def isTest: Boolean

    Permalink

    Whether this is a test context.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  23. val options: PipelineOptions

    Permalink
  24. def optionsAs[T <: PipelineOptions](implicit arg0: ClassTag[T]): T

    Permalink

    Get PipelineOptions as a more specific sub-type.

  25. def parallelize[K, V](elems: Map[K, V])(implicit koder: Coder[K], voder: Coder[V]): SCollection[(K, V)]

    Permalink

    Distribute a local Scala Map to form an SCollection.

  26. def parallelize[T](elems: Iterable[T])(implicit arg0: Coder[T]): SCollection[T]

    Permalink

    Distribute a local Scala Iterable to form an SCollection.

  27. def parallelizeTimestamped[T](elems: Iterable[T], timestamps: Iterable[Instant])(implicit arg0: Coder[T]): SCollection[T]

    Permalink

    Distribute a local Scala Iterable with timestamps to form an SCollection.

  28. def parallelizeTimestamped[T](elems: Iterable[(T, Instant)])(implicit arg0: Coder[T]): SCollection[T]

    Permalink

    Distribute a local Scala Iterable with timestamps to form an SCollection.

  29. def pipeline: Pipeline

    Permalink

    Underlying pipeline.

  30. def pubsubSubscription[T](sub: String, idAttribute: String = null, timestampAttribute: String = null)(implicit arg0: ClassTag[T], arg1: Coder[T]): SCollection[T]

    Permalink

    Get an SCollection for a Pub/Sub subscription.

  31. def pubsubSubscriptionWithAttributes[T](sub: String, idAttribute: String = null, timestampAttribute: String = null)(implicit arg0: ClassTag[T], arg1: Coder[T]): SCollection[(T, Map[String, String])]

    Permalink

    Get an SCollection for a Pub/Sub subscription that includes message attributes.

  32. def pubsubTopic[T](topic: String, idAttribute: String = null, timestampAttribute: String = null)(implicit arg0: ClassTag[T], arg1: Coder[T]): SCollection[T]

    Permalink

    Get an SCollection for a Pub/Sub topic.

  33. def pubsubTopicWithAttributes[T](topic: String, idAttribute: String = null, timestampAttribute: String = null)(implicit arg0: ClassTag[T], arg1: Coder[T]): SCollection[(T, Map[String, String])]

    Permalink

    Get an SCollection for a Pub/Sub topic that includes message attributes.

  34. def read[T](io: ScioIO[T] { type ReadP = Unit })(implicit arg0: Coder[T]): SCollection[T]

    Permalink
  35. def read[T](io: ScioIO[T])(params: ReadP)(implicit arg0: Coder[T]): SCollection[T]

    Permalink

    Generic read method for all ScioIO[T] implementations, which will invoke the provided IO's com.spotify.scio.io.ScioIO[T]#readWithContext method along with read configurations passed in.

    Generic read method for all ScioIO[T] implementations, which will invoke the provided IO's com.spotify.scio.io.ScioIO[T]#readWithContext method along with read configurations passed in. The IO class can delegate test-specific behavior if necessary.

    io

    an implementation of ScioIO[T] trait

    params

    configurations need to pass to perform underline read implementation

  36. def run(): ScioExecutionContext

    Permalink

    Runs the underlying pipeline.

    Runs the underlying pipeline.

    Running closes the context and no further transformations can be applied to the pipeline once the context is closed.

    returns

    the ScioExecutionContext for the underlying job execution.

  37. def setAppName(name: String): Unit

    Permalink

    Set application name for the context.

  38. def setJobName(name: String): Unit

    Permalink

    Set job name for the context.

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

    Permalink
    Definition Classes
    AnyRef
  40. def textFile(path: String, compression: Compression = beam.Compression.AUTO): SCollection[String]

    Permalink

    Get an SCollection for a text file.

  41. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  42. def unionAll[T](scs: Iterable[SCollection[T]])(implicit arg0: Coder[T]): SCollection[T]

    Permalink

    Create a union of multiple SCollections.

    Create a union of multiple SCollections. Supports empty lists.

  43. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. def withName(name: String): ScioContext.this.type

    Permalink

    Set a custom name for the next transform to be applied.

    Set a custom name for the next transform to be applied.

    Definition Classes
    TransformNameable
  47. def wrap[T](p: PCollection[T]): SCollection[T]

    Permalink

    Wrap a PCollection.

Deprecated Value Members

  1. def close(): ScioExecutionContext

    Permalink

    Close the context.

    Close the context. No operation can be performed once the context is closed.

    This method is deprecated and with it the --blocking flag.

    Use ScioContext#run.

    To achieve the same behaviour when --blocking was enabled use:

    val sc: ScioContext = ???
    
    sc.run().waitUntilDone(Duration.Inf)
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.0) this method will be removed in next scio version; use run() instead.

    See also

    ScioContext#run

Inherited from TransformNameable

Inherited from AnyRef

Inherited from Any

In-memory Collections

Input Sources

Other Members