Class

com.krux.hyperion.aws

AdpRecurringSchedule

Related Doc: package aws

Permalink

case class AdpRecurringSchedule(id: String, name: Option[String], period: String, startAt: Option[String], startDateTime: Option[github.nscala_time.time.Imports.DateTime], endDateTime: Option[github.nscala_time.time.Imports.DateTime], occurrences: Option[String]) extends AdpDataPipelineAbstractObject with AdpDataPipelineObject with Product with Serializable

Defines the timing of a scheduled event, such as when an activity runs.

ref: http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-object-schedule.html

period

How often the pipeline should run. The format is "N [minutes|hours|days|weeks|months]", where N is a number followed by one of the time specifiers. For example, "15 minutes", runs the pipeline every 15 minutes. The minimum period is 15 minutes and the maximum period is 3 years.

startAt

The date and time at which to start the scheduled pipeline runs. Valid value is FIRST_ACTIVATION_DATE_TIME. FIRST_ACTIVATION_DATE_TIME is assumed to be the current date and time.

startDateTime

The date and time to start the scheduled runs. You must use either startDateTime or startAt but not both.

endDateTime

The date and time to end the scheduled runs. Must be a date and time later than the value of startDateTime or startAt. The default behavior is to schedule runs until the pipeline is shut down.

occurrences

The number of times to execute the pipeline after it's activated. You can't use occurrences with endDateTime.

Source
AdpSchedule.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AdpDataPipelineObject, AdpDataPipelineAbstractObject, AdpObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AdpRecurringSchedule
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AdpDataPipelineObject
  7. AdpDataPipelineAbstractObject
  8. AdpObject
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AdpRecurringSchedule(id: String, name: Option[String], period: String, startAt: Option[String], startDateTime: Option[github.nscala_time.time.Imports.DateTime], endDateTime: Option[github.nscala_time.time.Imports.DateTime], occurrences: Option[String])

    Permalink

    period

    How often the pipeline should run. The format is "N [minutes|hours|days|weeks|months]", where N is a number followed by one of the time specifiers. For example, "15 minutes", runs the pipeline every 15 minutes. The minimum period is 15 minutes and the maximum period is 3 years.

    startAt

    The date and time at which to start the scheduled pipeline runs. Valid value is FIRST_ACTIVATION_DATE_TIME. FIRST_ACTIVATION_DATE_TIME is assumed to be the current date and time.

    startDateTime

    The date and time to start the scheduled runs. You must use either startDateTime or startAt but not both.

    endDateTime

    The date and time to end the scheduled runs. Must be a date and time later than the value of startDateTime or startAt. The default behavior is to schedule runs until the pipeline is shut down.

    occurrences

    The number of times to execute the pipeline after it's activated. You can't use occurrences with endDateTime.

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. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val endDateTime: Option[github.nscala_time.time.Imports.DateTime]

    Permalink

    The date and time to end the scheduled runs.

    The date and time to end the scheduled runs. Must be a date and time later than the value of startDateTime or startAt. The default behavior is to schedule runs until the pipeline is shut down.

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. 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
    AdpRecurringScheduleAdpDataPipelineObjectAdpObject
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. 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
    AdpRecurringScheduleAdpDataPipelineObjectAdpDataPipelineAbstractObject
  13. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  16. val occurrences: Option[String]

    Permalink

    The number of times to execute the pipeline after it's activated.

    The number of times to execute the pipeline after it's activated. You can't use occurrences with endDateTime.

  17. val period: String

    Permalink

    How often the pipeline should run.

    How often the pipeline should run. The format is "N [minutes|hours|days|weeks|months]", where N is a number followed by one of the time specifiers. For example, "15 minutes", runs the pipeline every 15 minutes. The minimum period is 15 minutes and the maximum period is 3 years.

  18. val startAt: Option[String]

    Permalink

    The date and time at which to start the scheduled pipeline runs.

    The date and time at which to start the scheduled pipeline runs. Valid value is FIRST_ACTIVATION_DATE_TIME. FIRST_ACTIVATION_DATE_TIME is assumed to be the current date and time.

  19. val startDateTime: Option[github.nscala_time.time.Imports.DateTime]

    Permalink

    The date and time to start the scheduled runs.

    The date and time to start the scheduled runs. You must use either startDateTime or startAt but not both.

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

    Permalink
    Definition Classes
    AnyRef
  21. val type: String

    Permalink

    The type of object.

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

    Definition Classes
    AdpRecurringScheduleAdpDataPipelineObject
  22. final def wait(): Unit

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

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

Inherited from AdpObject

Inherited from AnyRef

Inherited from Any

Ungrouped