class SessionApi extends AnyRef

Provides access to methods for interacting with a wizard session.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SessionApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SessionApi(state: LiveSessionState)

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 await(secondsBetweenCheck: Int)(test: => Boolean): Unit

    Wait for a specific criteria to be satisfied.

    Wait for a specific criteria to be satisfied. An example is when waiting for a job to reach its completed state.

    secondsBetweenCheck

    How many seconds to pass between checking the criteria.

    test

    A function implementing the check.

  6. def awaitBatchJob(job: BatchJobInfo, secondsBetweenCheck: Int, scheduler: SchedulerFacade, expectedEndStates: Set[String] = Set(JobStates.succeeded)): Unit

    Wait for a specific batch job to complete.

    Wait for a specific batch job to complete.

    job

    The job to wait for.

    secondsBetweenCheck

    How many seconds to pass between checking the criteria.

    scheduler

    A scheduler facade to use for API calls.

    expectedEndStates

    The set of accepted end states for the job (default is 

    Jobstates.succeeded

    ).

  7. def awaitSparkJob(job: JobInfo, secondsBetweenCheck: Int, scheduler: SchedulerFacade, expectedEndStates: Set[String] = Set(JobStates.succeeded)): Unit

    Wait for a specific spark job to complete.

    Wait for a specific spark job to complete.

    job

    The job to wait for.

    secondsBetweenCheck

    How many seconds to pass between checking the criteria.

    scheduler

    A scheduler facade to use for API calls.

    expectedEndStates

    The set of accepted end states for the job (default is 

    Jobstates.succeeded

    ).

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. def id: UUID

    The unique id of the session.

  14. def isCancelled: Boolean

    Whether the session has been cancelled.

  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. def progress(message: String, progress: Int): Unit

    Display a progress message to the user, and update the progress value, during asynchronous actions.

    Display a progress message to the user, and update the progress value, during asynchronous actions.

    message

    The message to display.

    progress

    The new progress value in percent (0-100).

  20. def progress(message: String): Unit

    Display a progress message to the user during asynchronous actions.

    Display a progress message to the user during asynchronous actions.

    message

    The message to display.

  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def token: UUID

    The session token of the user controlling the session.

  24. def user: String

    The unique id of the user controlling the session.

  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped