Class

com.coxautodata.waimak.dataflow.spark

FSCleanUp

Related Doc: package spark

Permalink

case class FSCleanUp(baseFolder: String, toRemove: CleanUpStrategy[FileStatus], labelsToClean: Seq[String]) extends SparkDataFlowAction with Logging with Product with Serializable

Action that deletes snapshots based on the cleanup strategy. It can cleanup one or more labels.

baseFolder

root folder that contains label folders

toRemove

returns list of snapshot/folder to remove

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

Instance Constructors

  1. new FSCleanUp(baseFolder: String, toRemove: CleanUpStrategy[FileStatus], labelsToClean: Seq[String])

    Permalink

    baseFolder

    root folder that contains label folders

    toRemove

    returns list of snapshot/folder to remove

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

    Permalink

    For representing the action

    For representing the action

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

    Permalink
    Definition Classes
    Any
  6. val baseFolder: String

    Permalink

    root folder that contains label folders

  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    DataFlowAction
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. 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
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. 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
  14. 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
    FSCleanUpDataFlowAction
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  17. val labelsToClean: Seq[String]

    Permalink
  18. def logAndReturn[A](a: A, msg: String, level: Level): A

    Permalink

    Takes a value of type A and a msg to log, returning a and logging the message at the desired level

    Takes a value of type A and a msg to log, returning a and logging the message at the desired level

    returns

    a

    Definition Classes
    Logging
  19. def logAndReturn[A](a: A, message: (A) ⇒ String, level: Level): A

    Permalink

    Takes a value of type A and a function message from A to String, logs the value of invoking message(a) at the level described by the level parameter

    Takes a value of type A and a function message from A to String, logs the value of invoking message(a) at the level described by the level parameter

    returns

    a

    Definition Classes
    Logging
    Example:
    1. logAndReturn(1, (num: Int) => s"number: $num", Info)
      // In the log we would see a log corresponding to "number 1"
  20. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  21. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  22. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  23. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  24. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  25. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  26. def logLabel: String

    Permalink
    Definition Classes
    DataFlowAction
  27. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  28. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  29. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  30. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  31. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  32. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  35. 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
    FSCleanUpDataFlowAction
  36. def performAction(inputs: DataFlowEntities, flowContext: SparkFlowContext): 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
    FSCleanUpSparkDataFlowAction
  37. 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
  38. 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
  39. 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
  40. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  41. val toRemove: CleanUpStrategy[FileStatus]

    Permalink

    returns list of snapshot/folder to remove

  42. final def wait(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. 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 Logging

Inherited from SparkDataFlowAction

Inherited from DataFlowAction

Inherited from AnyRef

Inherited from Any

Ungrouped