Class/Object

com.coxautodata.waimak.dataflow.spark

WriteAsNamedFilesAction

Related Docs: object WriteAsNamedFilesAction | package spark

Permalink

case class WriteAsNamedFilesAction(label: String, tempBasePath: Path, destBasePath: Path, numberOfFiles: Int, filenamePrefix: String, format: String, options: Map[String, String]) extends SparkDataFlowAction with Product with Serializable

Write a file or files with a specific filename to a folder. Allows you to control the final output filename without the Spark-generated part UUIDs. Filename will be $filenamePrefix.extension if number of files is 1, otherwise $filenamePrefix.$fileNumber.extension where file number is incremental and zero-padded.

label

Label to write

tempBasePath

Base location of temporary folder

destBasePath

Destination path to put files in

numberOfFiles

Number of files to generate

filenamePrefix

Prefix of name of the file up to the filenumber and extension

format

Format to write (e.g. parquet, csv)

options

Options to pass to the DataFrameWriter

Linear Supertypes
Serializable, Serializable, Product, Equals, SparkDataFlowAction, DataFlowAction, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WriteAsNamedFilesAction
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SparkDataFlowAction
  7. DataFlowAction
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WriteAsNamedFilesAction(label: String, tempBasePath: Path, destBasePath: Path, numberOfFiles: Int, filenamePrefix: String, format: String, options: Map[String, String])

    Permalink

    label

    Label to write

    tempBasePath

    Base location of temporary folder

    destBasePath

    Destination path to put files in

    numberOfFiles

    Number of files to generate

    filenamePrefix

    Prefix of name of the file up to the filenumber and extension

    format

    Format to write (e.g. parquet, csv)

    options

    Options to pass to the DataFrameWriter

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. def actionName: String

    Permalink

    For representing the action

    For representing the action

    Definition Classes
    DataFlowAction
  5. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def description: String

    Permalink
    Definition Classes
    DataFlowAction
  8. val destBasePath: Path

    Permalink

    Destination path to put files in

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

    Permalink
    Definition Classes
    AnyRef
  10. val filenamePrefix: String

    Permalink

    Prefix of name of the file up to the filenumber and extension

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def flowState(inputs: DataFlowEntities): DataFlowActionState

    Permalink

    Action has the responsibility of assessing itself and produce DataFlowActionState, that will be used by the executors to determine if they can call performAction or not.

    Action has the responsibility of assessing itself and produce DataFlowActionState, that will be used by the executors to determine if they can call performAction or not. Also can be used for progress monitoring. This will allow for more custom actions without modifying the executors

    inputs

    - action will study the state of the inputs in order to generate self assessment

    returns

    - an instance of the DataFlowActionState

    Definition Classes
    DataFlowAction
  13. val format: String

    Permalink

    Format to write (e.g.

    Format to write (e.g. parquet, csv)

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. val guid: String

    Permalink

    Unique id of the action, but using it for adding behaviours can be problematic due to Interceptors that are defined at a much later stage.

    Unique id of the action, but using it for adding behaviours can be problematic due to Interceptors that are defined at a much later stage. Because of that ActionSchedulers must NOT use this guid.

    Definition Classes
    DataFlowAction
  16. val inputLabels: List[String]

    Permalink

    The unique identifiers for the inputs to this action

    The unique identifiers for the inputs to this action

    Definition Classes
    WriteAsNamedFilesActionDataFlowAction
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. val label: String

    Permalink

    Label to write

  19. def logLabel: String

    Permalink
    Definition Classes
    DataFlowAction
  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 numberOfFiles: Int

    Permalink

    Number of files to generate

  24. val options: Map[String, String]

    Permalink

    Options to pass to the DataFrameWriter

  25. val outputLabels: List[String]

    Permalink

    The unique identifiers for the outputs to this action

    The unique identifiers for the outputs to this action

    Definition Classes
    WriteAsNamedFilesActionDataFlowAction
  26. def performAction(inputs: DataFlowEntities, flowContext: SparkFlowContext): Try[ActionResult]

    Permalink
  27. def performAction[C <: FlowContext](inputs: DataFlowEntities, flowContext: C): Try[ActionResult]

    Permalink

    Perform the action

    Perform the action

    inputs

    the DataFlowEntities corresponding to the inputLabels

    flowContext

    context of the flow in which this action runs

    returns

    the action outputs (these must be declared in the same order as their labels in outputLabels)

    Definition Classes
    SparkDataFlowActionDataFlowAction
  28. def requiresAllInputs: Boolean

    Permalink

    This action can only be executed if all of the inputs are not empty.

    This action can only be executed if all of the inputs are not empty. An input can be explicitly marked as empty. If false, than one or more inputs can be empty to start execution.

    Definition Classes
    DataFlowAction
  29. def schedulingGuid: String

    Permalink

    Interceptors must not override this property, as certain behaviours of the data flow (Ex, execution pools) will be associated with this scheduling guid.

    Interceptors must not override this property, as certain behaviours of the data flow (Ex, execution pools) will be associated with this scheduling guid. Also ActionScheduler will use this guid to track scheduled actions.

    Definition Classes
    DataFlowAction
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. val tempBasePath: Path

    Permalink

    Base location of temporary folder

  32. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SparkDataFlowAction

Inherited from DataFlowAction

Inherited from AnyRef

Inherited from Any

Ungrouped