Spark Pipeline Framework|DocsComponentsHooks

Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package github
    Definition Classes
    io
  • package dwsmith1983
    Definition Classes
    github
  • package spark
    Definition Classes
    dwsmith1983
  • package pipeline
    Definition Classes
    spark
  • package runner

    Runner package for spark-pipeline-framework.

    Runner package for spark-pipeline-framework.

    This package provides the entry point for executing pipelines:

    - runner.PipelineRunner - Trait defining the pipeline execution interface - runner.SimplePipelineRunner - Main class for spark-submit (sequential execution)

    Lifecycle Hooks

    Use PipelineHooks from the config package to monitor or customize pipeline execution:

    import io.github.dwsmith1983.spark.pipeline.config._
    
    val hooks = new PipelineHooks {
      override def afterComponent(config: ComponentConfig, index: Int, total: Int, durationMs: Long): Unit =
        println(s"Component $${config.instanceName} completed in $${durationMs}ms")
    }
    
    SimplePipelineRunner.run(config, hooks)

    Deployment

    The runner JAR should be used as the main artifact for spark-submit, with user pipeline JARs added via --jars:

    spark-submit \
      --class io.github.dwsmith1983.spark.pipeline.runner.SimplePipelineRunner \
      --jars /path/to/user-pipeline.jar \
      /path/to/spark-pipeline-runner-spark3_2.12.jar \
      -Dconfig.file=/path/to/pipeline.conf

    Configuration Loading

    Configuration is loaded via Typesafe Config in this order: 1. System properties (-Dconfig.file, -Dconfig.resource, -Dconfig.url) 2. application.conf in classpath 3. reference.conf in classpath

    Definition Classes
    pipeline
  • PipelineRunner
  • SchemaContractViolationException
  • SimplePipelineRunner
c

io.github.dwsmith1983.spark.pipeline.runner

SchemaContractViolationException

class SchemaContractViolationException extends RuntimeException

Exception thrown when schema validation fails between components.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SchemaContractViolationException
  2. RuntimeException
  3. Exception
  4. Throwable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SchemaContractViolationException(producerName: String, consumerName: String, errors: List[SchemaValidationError], warnings: List[SchemaValidationWarning])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. val consumerName: String
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. val errors: List[SchemaValidationError]
  11. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  12. def getCause(): Throwable
    Definition Classes
    Throwable
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  15. def getMessage(): String
    Definition Classes
    Throwable
  16. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  17. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  19. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  24. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  25. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  26. def printStackTrace(): Unit
    Definition Classes
    Throwable
  27. val producerName: String
  28. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. val warnings: List[SchemaValidationWarning]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from RuntimeException

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped