Class

com.krux.hyperion.aws

AdpShellCommandActivity

Related Doc: package aws

Permalink

case class AdpShellCommandActivity(id: String, name: Option[String], command: Option[String], scriptUri: Option[String], scriptArgument: Option[Seq[String]], stdout: Option[String], stderr: Option[String], stage: Option[String], input: Option[Seq[AdpRef[AdpDataNode]]], output: Option[Seq[AdpRef[AdpDataNode]]], workerGroup: Option[String], runsOn: Option[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]]], attemptTimeout: Option[String], lateAfterTimeout: Option[String], maximumRetries: Option[String], retryDelay: Option[String], failureAndRerunMode: Option[String]) 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.

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.

stage

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

$\{INPUT1_STAGING_DIR\
input

The input data source.

output

The location for the output.

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
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]], stdout: Option[String], stderr: Option[String], stage: Option[String], input: Option[Seq[AdpRef[AdpDataNode]]], output: Option[Seq[AdpRef[AdpDataNode]]], workerGroup: Option[String], runsOn: Option[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]]], attemptTimeout: Option[String], lateAfterTimeout: Option[String], maximumRetries: Option[String], retryDelay: Option[String], failureAndRerunMode: Option[String])

    Permalink

    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.

    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.

    stage

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

    $\{INPUT1_STAGING_DIR\
    input

    The input data source.

    output

    The location for the output.

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val attemptTimeout: Option[String]

    Permalink

    The timeout time interval for an object attempt.

    The timeout time interval for an object attempt. If an attempt does not complete within the start time plus this time interval, AWS Data Pipeline marks the attempt as failed and your retry settings determine the next steps taken.

    Definition Classes
    AdpShellCommandActivityAdpActivity
  6. def clone(): AnyRef

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

    Permalink

    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.

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

    Permalink

    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
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. val failureAndRerunMode: Option[String]

    Permalink

    Determines whether pipeline object failures and rerun commands cascade through pipeline object dependencies

    Determines whether pipeline object failures and rerun commands cascade through pipeline object dependencies

    Possible values include cascade and none.

    Definition Classes
    AdpShellCommandActivityAdpActivity
  11. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. val id: String

    Permalink

    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
    AdpShellCommandActivityAdpDataPipelineObjectAdpObject
  14. val input: Option[Seq[AdpRef[AdpDataNode]]]

    Permalink

    The input data source.

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. val lateAfterTimeout: Option[String]

    Permalink

    The time period in which the object run must start.

    The time period in which the object run must start. If the object does not start within the scheduled start time plus this time interval, it is considered late

    Definition Classes
    AdpShellCommandActivityAdpActivity
  17. val maximumRetries: Option[String]

    Permalink

    The maximum number of times to retry the action.

    The maximum number of times to retry the action. The default value is 2, which results in 3 tries total (1 original attempt plus 2 retries). The maximum value is 5 (6 total attempts).

    Definition Classes
    AdpShellCommandActivityAdpActivity
  18. val name: Option[String]

    Permalink

    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
  19. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    The SNS alarm to raise when the activity fails.

    The SNS alarm to raise when the activity fails.

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

    Permalink

    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
  24. val onSuccess: Option[Seq[AdpRef[AdpSnsAlarm]]]

    Permalink

    The SNS alarm to raise when the activity succeeds.

    The SNS alarm to raise when the activity succeeds.

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

    Permalink

    The location for the output.

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

    Permalink

    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
  27. val retryDelay: Option[String]

    Permalink

    The timeout duration between two retry attempts.

    The timeout duration between two retry attempts. The default is 10 minutes.

    Definition Classes
    AdpShellCommandActivityAdpActivity
  28. val runsOn: Option[AdpRef[AdpEc2Resource]]

    Permalink
  29. val scriptArgument: Option[Seq[String]]

    Permalink

    A list of arguments to pass to the shell script.

  30. val scriptUri: Option[String]

    Permalink

    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.

  31. val stage: Option[String]

    Permalink

    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\
  32. val stderr: Option[String]

    Permalink

    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.

  33. val stdout: Option[String]

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef
  35. val type: String

    Permalink

    The type of object.

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. val workerGroup: Option[String]

    Permalink

    The worker group.

    The worker group. This is used for routing tasks. If you provide a runsOn value and workerGroup exists, workerGroup is ignored.

    Definition Classes
    AdpShellCommandActivityAdpActivity

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