Packages

case class OozieSLA(nominalTime: String, shouldStart: Option[String] = None, shouldEnd: Option[String] = None, maxDuration: Option[String] = None, alertEvents: Seq[SLAAlert] = Seq.empty[SLAAlert], alertContacts: Seq[String] = Seq.empty[String], notificationMsg: Option[String] = None, upstreamApps: Seq[String] = Seq.empty[String], name: String = "_sla") extends XmlSerializable with OozieProperties with Nameable with Product with Serializable

nominalTime

This is the time relative to which your jobs' SLAs will be calculated. Generally since Oozie workflows are aligned with synchronous data dependencies, this nominal time can be parameterized to be passed the value of your coordinator nominal time. Nominal time is also required in case of independent workflows and you can specify the time in which you expect the workflow to be run if you don't have a synchronous dataset associated with it.

shouldStart

Relative to nominal-time this is the amount of time (along with time-unit - MINUTES, HOURS, DAYS) within which your job should start running to meet SLA. This is optional.

shouldEnd

Relative to nominal-time this is the amount of time (along with time-unit - MINUTES, HOURS, DAYS) within which your job should finish to meet SLA.

maxDuration

This is the maximum amount of time (along with time-unit - MINUTES, HOURS, DAYS) your job is expected to run. This is optional.

alertEvents

Specify the types of events for which Email alerts should be sent. Allowable values in this comma-separated list are start_miss, end_miss and duration_miss. *_met events can generally be deemed low priority and hence email alerting for these is not neccessary. However, note that this setting is only for alerts via email alerts and not via JMS messages, where all events send out notifications, and user can filter them using desired selectors. This is optional and only applicable when alert-contact is configured.

alertContacts

Specify a comma separated list of email addresses where you wish your alerts to be sent. This is optional and need not be configured if you just want to view your job SLA history in the UI and do not want to receive email alerts.

notificationMsg

The message to use when an SLA has not been met

upstreamApps

List of upstream applications affected by SLA being missed.

Linear Supertypes
Serializable, Serializable, Product, Equals, Nameable, OozieProperties, PropertyFormatter, XmlSerializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OozieSLA
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Nameable
  7. OozieProperties
  8. PropertyFormatter
  9. XmlSerializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OozieSLA(nominalTime: String, shouldStart: Option[String] = None, shouldEnd: Option[String] = None, maxDuration: Option[String] = None, alertEvents: Seq[SLAAlert] = Seq.empty[SLAAlert], alertContacts: Seq[String] = Seq.empty[String], notificationMsg: Option[String] = None, upstreamApps: Seq[String] = Seq.empty[String], name: String = "_sla")

    nominalTime

    This is the time relative to which your jobs' SLAs will be calculated. Generally since Oozie workflows are aligned with synchronous data dependencies, this nominal time can be parameterized to be passed the value of your coordinator nominal time. Nominal time is also required in case of independent workflows and you can specify the time in which you expect the workflow to be run if you don't have a synchronous dataset associated with it.

    shouldStart

    Relative to nominal-time this is the amount of time (along with time-unit - MINUTES, HOURS, DAYS) within which your job should start running to meet SLA. This is optional.

    shouldEnd

    Relative to nominal-time this is the amount of time (along with time-unit - MINUTES, HOURS, DAYS) within which your job should finish to meet SLA.

    maxDuration

    This is the maximum amount of time (along with time-unit - MINUTES, HOURS, DAYS) your job is expected to run. This is optional.

    alertEvents

    Specify the types of events for which Email alerts should be sent. Allowable values in this comma-separated list are start_miss, end_miss and duration_miss. *_met events can generally be deemed low priority and hence email alerting for these is not neccessary. However, note that this setting is only for alerts via email alerts and not via JMS messages, where all events send out notifications, and user can filter them using desired selectors. This is optional and only applicable when alert-contact is configured.

    alertContacts

    Specify a comma separated list of email addresses where you wish your alerts to be sent. This is optional and need not be configured if you just want to view your job SLA history in the UI and do not want to receive email alerts.

    notificationMsg

    The message to use when an SLA has not been met

    upstreamApps

    List of upstream applications affected by SLA being missed.

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. val alertContacts: Seq[String]
  5. val alertEvents: Seq[SLAAlert]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def buildSequenceProperties(actionName: String, propName: String, valueSequence: Seq[String]): Map[String, String]

    Convert a sequence of property values to a map of KV pairs

    Convert a sequence of property values to a map of KV pairs

    actionName

    The name of the action to insert into the property name

    valueSequence

    The property values

    Attributes
    protected
    Definition Classes
    OozieProperties
  8. def buildSequenceToSingleValueProperty(actionName: String, propName: String, valueSequence: Seq[String]): Map[String, String]

    Convert a sequence of properties to a single (comma separated) value and map to a KV pair

    Convert a sequence of properties to a single (comma separated) value and map to a KV pair

    actionName

    The name of the action to insert into the property name

    propName

    The name of the property

    valueSequence

    The property values

    Attributes
    protected
    Definition Classes
    OozieProperties
  9. def buildStringOptionProperty(actionName: String, propName: String, option: Option[String]): Map[String, String]

    Convert an optional property to a map of KV pairs

    Convert an optional property to a map of KV pairs

    actionName

    The name of the action to insert into the property name

    propName

    The name of the property

    option

    the optional value to convert

    Attributes
    protected
    Definition Classes
    OozieProperties
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def formatProperty(property: String): String

    format predicates to expected pattern

    format predicates to expected pattern

    Attributes
    protected
    Definition Classes
    PropertyFormatter
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val maxDuration: Option[String]
  17. val name: String

    The name of the object

    The name of the object

    Definition Classes
    OozieSLA → Nameable
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val nominalTime: String
  20. val notificationMsg: Option[String]
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def properties: Map[String, String]

    Get the Oozie properties for this object

    Get the Oozie properties for this object

    Definition Classes
    OozieSLA → OozieProperties
  24. val shouldEnd: Option[String]
  25. val shouldStart: Option[String]
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toXML: Elem

    The XML for this node

    The XML for this node

    Definition Classes
    OozieSLA → XmlSerializable
  28. val upstreamApps: Seq[String]
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  32. def withActionName(actionName: String): ActionProperties[OozieSLA]

    Add the owning node name to this SLA object

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Nameable

Inherited from OozieProperties

Inherited from PropertyFormatter

Inherited from XmlSerializable

Inherited from AnyRef

Inherited from Any

Ungrouped