class PipeDoFn extends DoFn[String, String]

A DoFn that pipes elements through an external command via StdIn & StdOut.

Source
PipeDoFn.java
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PipeDoFn
  2. DoFn
  3. HasDisplayData
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PipeDoFn(cmdArray: Array[String], environment: Map[String, String], dir: File, setupCmds: List[Array[String]], teardownCmds: List[Array[String]])

    Create a new PipeDoFn instance.

    Create a new PipeDoFn instance.

    The setup and teardown commands will be executed once per PipeDoFn instance, i.e. on a 4-core Dataflow worker, an instance will be cloned 4 times, one for each CPU core but setup and teardown commands will be executed only once.

    cmdArray

    array containing the command to call and its arguments.

    environment

    environment variables, or null if the subprocess should inherit the environment from the current process.

    dir

    the working directory of the sub process, or null if the subprocess should inherit the working directly of the current process.

    setupCmds

    setup commands to be run before processing.

    teardownCmds

    tear down commands to be run after processing.

  2. new PipeDoFn(command: String, environment: Map[String, String], dir: File, setupCmds: List[String], teardownCmds: List[String])

    Create a new PipeDoFn instance.

    Create a new PipeDoFn instance.

    The setup and teardown commands will be executed once per PipeDoFn instance, i.e. on a 4-core Dataflow worker, an instance will be cloned 4 times, one for each CPU core but setup and teardown commands will be executed only once.

    command

    the command to call.

    environment

    environment variables, or null if the subprocess should inherit the environment from the current process.

    dir

    the working directory of the sub process, or null if the subprocess should inherit the working directly of the current process.

    setupCmds

    setup commands to be run before processing.

    teardownCmds

    tear down commands to be run after processing.

  3. new PipeDoFn(cmdArray: Array[String])

    Create a new PipeDoFn instance.

    Create a new PipeDoFn instance.

    cmdArray

    array containing the command to call and its arguments.

  4. new PipeDoFn(command: String)

Type Members

  1. abstract class FinishBundleContext extends AnyRef
    Definition Classes
    DoFn
  2. abstract class OnTimerContext extends WindowedContext
    Definition Classes
    DoFn
  3. abstract class OnWindowExpirationContext extends WindowedContext
    Definition Classes
    DoFn
  4. abstract class ProcessContext extends WindowedContext
    Definition Classes
    DoFn
  5. abstract class StartBundleContext extends AnyRef
    Definition Classes
    DoFn
  6. abstract class WindowedContext extends AnyRef
    Definition Classes
    DoFn

Abstract Value Members

  1. abstract object FinishBundleContext
    Definition Classes
    DoFn
  2. abstract object ProcessContext
    Definition Classes
    DoFn
  3. abstract object StartBundleContext
    Definition Classes
    DoFn
  4. abstract object WindowedContext
    Definition Classes
    DoFn

Concrete 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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def finishBundle(context: FinishBundleContext): Unit
    Annotations
    @FinishBundle()
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getInputTypeDescriptor(): TypeDescriptor[String]
    Definition Classes
    DoFn
  12. def getOutputTypeDescriptor(): TypeDescriptor[String]
    Definition Classes
    DoFn
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def populateDisplayData(builder: Builder): Unit
    Definition Classes
    PipeDoFn → DoFn → HasDisplayData
    Annotations
    @Override()
  19. def processElement(element: String, out: OutputReceiver[String]): Unit
    Annotations
    @ProcessElement()
  20. def setup(): Unit
    Annotations
    @Setup()
  21. def startBundle(context: StartBundleContext): Unit
    Annotations
    @StartBundle()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def teardown(): Unit
    Annotations
    @Teardown()
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def getAllowedTimestampSkew(): Duration
    Definition Classes
    DoFn
    Annotations
    @Deprecated
    Deprecated
  2. final def prepareForProcessing(): Unit
    Definition Classes
    DoFn
    Annotations
    @Deprecated
    Deprecated

Inherited from DoFn[String, String]

Inherited from HasDisplayData

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped