CmdScript

Execute a command. Command can be different for windows and linux operating systems, but it must be defined for at least one of them. If return value is not zero an exception is thrown. The last line of the scripts standard output is parsed as key-value and passed on as parameters in the output subfeed. Key-value format: k1=v1 k2=v2

name: name of the transformer
description: Optional description of the transformer
winCmd: Cmd to execute on windows operating systems - note that it is executed with "cmd /C" prefixed
linuxCmd: Cmd to execute on linux operating systems - note that it is executed with "sh -c" prefixed.

Linear Supertypes

Serializable, Serializable, Product, Equals, SmartDataLakeLogger, ParsableScriptDef, ParsableFromConfig[ParsableScriptDef], ScriptDef, AnyRef, Any

Instance Constructors

new CmdScript(name: String = "cmd", description: Option[String] = None, winCmd: Option[String] = None, linuxCmd: Option[String] = None)

name
name of the transformer
description
Optional description of the transformer
winCmd
Cmd to execute on windows operating systems - note that it is executed with "cmd /C" prefixed
linuxCmd
Cmd to execute on linux operating systems - note that it is executed with "sh -c" prefixed.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val description: Option[String]

Optional description of the transformer
Optional description of the transformer

Definition Classes
CmdScript → ScriptDef
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def execStdOut(actionId: ActionId, partitionValues: Seq[PartitionValues], parameters: Map[String, String])(implicit session: SparkSession, context: ActionPipelineContext): String

Function to be implemented to execute command
Function to be implemented to execute command
actionId
id of the action which executes this transformation. This is mainly used to prefix error messages.
partitionValues
partition values to transform
parameters
key-value parameters
returns
standard output of script

Definition Classes
CmdScript → ScriptDef
def factory: FromConfigFactory[ParsableScriptDef]

Returns the factory that can parse this type (that is, type CO).
Returns the factory that can parse this type (that is, type CO).
Typically, implementations of this method should return the companion object of the implementing class. The companion object in turn should implement FromConfigFactory.
returns
the factory (object) for this class.

Definition Classes
CmdScript → ParsableFromConfig
def finalize(): Unit

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

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val linuxCmd: Option[String]

Cmd to execute on linux operating systems - note that it is executed with "sh -c" prefixed.
lazy val logger: Logger

Attributes
protected
Definition Classes
SmartDataLakeLogger
val name: String

name of the transformer
name of the transformer

Definition Classes
CmdScript → ScriptDef
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
val winCmd: Option[String]

Cmd to execute on windows operating systems - note that it is executed with "cmd /C" prefixed

Related Docs: object CmdScript | package script

case class CmdScript(name: String = "cmd", description: Option[String] = None, winCmd: Option[String] = None, linuxCmd: Option[String] = None) extends ParsableScriptDef with SmartDataLakeLogger with Product with Serializable

Instance Constructors

new CmdScript(name: String = "cmd", description: Option[String] = None, winCmd: Option[String] = None, linuxCmd: Option[String] = None)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val description: Option[String]

final def eq(arg0: AnyRef): Boolean

def execStdOut(actionId: ActionId, partitionValues: Seq[PartitionValues], parameters: Map[String, String])(implicit session: SparkSession, context: ActionPipelineContext): String

def factory: FromConfigFactory[ParsableScriptDef]

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val linuxCmd: Option[String]

lazy val logger: Logger

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val winCmd: Option[String]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SmartDataLakeLogger

Inherited from ParsableScriptDef

Inherited from ParsableFromConfig[ParsableScriptDef]

Inherited from ScriptDef

Inherited from AnyRef

Inherited from Any

Ungrouped