com.krux.hyperion.objects.aws

AdpShellCommandActivity

Related Doc: package aws

case class AdpShellCommandActivity(id: String, name: Option[String], command: Option[String], scriptUri: Option[String], scriptArgument: Option[Seq[String]], input: Option[Seq[AdpRef[AdpDataNode]]], output: Option[Seq[AdpRef[AdpDataNode]]], stage: String, stdout: Option[String], stderr: Option[String], runsOn: AdpRef[AdpEc2Resource], dependsOn: Option[Seq[AdpRef[AdpActivity]]], precondition: Option[Seq[AdpRef[AdpPrecondition]]], onFail: Option[Seq[AdpRef[AdpSnsAlarm]]], onSuccess: Option[Seq[AdpRef[AdpSnsAlarm]]], onLateAction: Option[Seq[AdpRef[AdpSnsAlarm]]]) extends AdpDataPipelineAbstractObject with AdpActivity with Product with Serializable

Runs a command on an EC2 node. You specify the input S3 location, output S3 location and the script/command.

command

The command to run. This value and any associated parameters must function in the environment from which you are running the Task Runner.

scriptUri

An Amazon S3 URI path for a file to download and run as a shell command. Only one scriptUri or command field should be present. scriptUri cannot use parameters, use command instead.

scriptArgument

A list of arguments to pass to the shell script.

input

The input data source.

output

The location for the output.

stage

Determines whether staging is enabled and allows your shell commands to have access to the staged-data variables, such as

$\{INPUT1_STAGING_DIR\
stdout

The Amazon S3 path that receives redirected output from the command. If you use the runsOn field, this must be an Amazon S3 path because of the transitory nature of the resource running your activity. However if you specify the workerGroup field, a local file path is permitted.

stderr

The path that receives redirected system error messages from the command. If you use the runsOn field, this must be an Amazon S3 path because of the transitory nature of the resource running your activity. However if you specify the workerGroup field, a local file path is permitted.

Source
AdpActivities.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AdpActivity, AdpDataPipelineObject, AdpDataPipelineAbstractObject, AdpObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AdpShellCommandActivity
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AdpActivity
  7. AdpDataPipelineObject
  8. AdpDataPipelineAbstractObject
  9. AdpObject
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AdpShellCommandActivity(id: String, name: Option[String], command: Option[String], scriptUri: Option[String], scriptArgument: Option[Seq[String]], input: Option[Seq[AdpRef[AdpDataNode]]], output: Option[Seq[AdpRef[AdpDataNode]]], stage: String, stdout: Option[String], stderr: Option[String], runsOn: AdpRef[AdpEc2Resource], dependsOn: Option[Seq[AdpRef[AdpActivity]]], precondition: Option[Seq[AdpRef[AdpPrecondition]]], onFail: Option[Seq[AdpRef[AdpSnsAlarm]]], onSuccess: Option[Seq[AdpRef[AdpSnsAlarm]]], onLateAction: Option[Seq[AdpRef[AdpSnsAlarm]]])

    command

    The command to run. This value and any associated parameters must function in the environment from which you are running the Task Runner.

    scriptUri

    An Amazon S3 URI path for a file to download and run as a shell command. Only one scriptUri or command field should be present. scriptUri cannot use parameters, use command instead.

    scriptArgument

    A list of arguments to pass to the shell script.

    input

    The input data source.

    output

    The location for the output.

    stage

    Determines whether staging is enabled and allows your shell commands to have access to the staged-data variables, such as

    $\{INPUT1_STAGING_DIR\
    stdout

    The Amazon S3 path that receives redirected output from the command. If you use the runsOn field, this must be an Amazon S3 path because of the transitory nature of the resource running your activity. However if you specify the workerGroup field, a local file path is permitted.

    stderr

    The path that receives redirected system error messages from the command. If you use the runsOn field, this must be an Amazon S3 path because of the transitory nature of the resource running your activity. However if you specify the workerGroup field, a local file path is permitted.

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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val command: Option[String]

    The command to run.

    The command to run. This value and any associated parameters must function in the environment from which you are running the Task Runner.

  7. val dependsOn: Option[Seq[AdpRef[AdpActivity]]]

    One or more references to other Activities that must reach the FINISHED state before this activity will start.

    One or more references to other Activities that must reach the FINISHED state before this activity will start.

    Definition Classes
    AdpShellCommandActivityAdpActivity
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  11. val id: String

    The ID of the object, IDs must be unique within a pipeline definition

    The ID of the object, IDs must be unique within a pipeline definition

    Definition Classes
    AdpShellCommandActivityAdpDataPipelineObjectAdpDataPipelineAbstractObject
  12. val input: Option[Seq[AdpRef[AdpDataNode]]]

    The input data source.

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  14. val name: Option[String]

    The optional, user-defined label of the object.

    The optional, user-defined label of the object. If you do not provide a name for an object in a pipeline definition, AWS Data Pipeline automatically duplicates the value of id.

    Definition Classes
    AdpShellCommandActivityAdpDataPipelineObjectAdpDataPipelineAbstractObject
  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. val onFail: Option[Seq[AdpRef[AdpSnsAlarm]]]

    The SNS alarm to raise when the activity fails.

    The SNS alarm to raise when the activity fails.

    Definition Classes
    AdpShellCommandActivityAdpActivity
  19. val onLateAction: Option[Seq[AdpRef[AdpSnsAlarm]]]

    The SNS alarm to raise when the activity fails to start on time.

    The SNS alarm to raise when the activity fails to start on time.

    Definition Classes
    AdpShellCommandActivityAdpActivity
  20. val onSuccess: Option[Seq[AdpRef[AdpSnsAlarm]]]

    The SNS alarm to raise when the activity succeeds.

    The SNS alarm to raise when the activity succeeds.

    Definition Classes
    AdpShellCommandActivityAdpActivity
  21. val output: Option[Seq[AdpRef[AdpDataNode]]]

    The location for the output.

  22. val precondition: Option[Seq[AdpRef[AdpPrecondition]]]

    A condition that must be met before the object can run.

    A condition that must be met before the object can run. To specify multiple conditions, add multiple precondition fields. The activity cannot run until all its conditions are met.

    Definition Classes
    AdpShellCommandActivityAdpActivity
  23. val runsOn: AdpRef[AdpEc2Resource]

    The computational resource to run the activity or command.

    The computational resource to run the activity or command. For example, an Amazon EC2 instance or Amazon EMR cluster.

    Definition Classes
    AdpShellCommandActivityAdpActivity
  24. val scriptArgument: Option[Seq[String]]

    A list of arguments to pass to the shell script.

  25. val scriptUri: Option[String]

    An Amazon S3 URI path for a file to download and run as a shell command.

    An Amazon S3 URI path for a file to download and run as a shell command. Only one scriptUri or command field should be present. scriptUri cannot use parameters, use command instead.

  26. val stage: String

    Determines whether staging is enabled and allows your shell commands to have access to the staged-data variables, such as

    Determines whether staging is enabled and allows your shell commands to have access to the staged-data variables, such as

    $\{INPUT1_STAGING_DIR\
  27. val stderr: Option[String]

    The path that receives redirected system error messages from the command.

    The path that receives redirected system error messages from the command. If you use the runsOn field, this must be an Amazon S3 path because of the transitory nature of the resource running your activity. However if you specify the workerGroup field, a local file path is permitted.

  28. val stdout: Option[String]

    The Amazon S3 path that receives redirected output from the command.

    The Amazon S3 path that receives redirected output from the command. If you use the runsOn field, this must be an Amazon S3 path because of the transitory nature of the resource running your activity. However if you specify the workerGroup field, a local file path is permitted.

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

    Definition Classes
    AnyRef
  30. val type: String

    The type of object.

    The type of object. Use one of the predefined AWS Data Pipeline object types.

    Definition Classes
    AdpShellCommandActivityAdpDataPipelineObject
  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AdpActivity

Inherited from AdpDataPipelineObject

Inherited from AdpObject

Inherited from AnyRef

Inherited from Any

Ungrouped