Packages

c

org.apache.spark

ComplexFutureAction

class ComplexFutureAction[T] extends FutureAction[T]

Developer API

A FutureAction for actions that could trigger multiple Spark jobs. Examples include take, takeSample. Cancellation works by setting the cancelled flag to true and cancelling any pending jobs.

Self Type
ComplexFutureAction[T]
Annotations
@DeveloperApi()
Source
FutureAction.scala
Linear Supertypes
FutureAction[T], Future[T], Awaitable[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ComplexFutureAction
  2. FutureAction
  3. Future
  4. Awaitable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ComplexFutureAction(run: (JobSubmitter) ⇒ Future[T])

Value Members

  1. def andThen[U](pf: PartialFunction[Try[T], U])(implicit executor: ExecutionContext): Future[T]
    Definition Classes
    Future
  2. def cancel(): Unit

    Cancels the execution of this action.

    Cancels the execution of this action.

    Definition Classes
    ComplexFutureActionFutureAction
  3. def collect[S](pf: PartialFunction[T, S])(implicit executor: ExecutionContext): Future[S]
    Definition Classes
    Future
  4. def failed: Future[Throwable]
    Definition Classes
    Future
  5. def fallbackTo[U >: T](that: Future[U]): Future[U]
    Definition Classes
    Future
  6. def filter(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[T]
    Definition Classes
    Future
  7. def flatMap[S](f: (T) ⇒ Future[S])(implicit executor: ExecutionContext): Future[S]
    Definition Classes
    Future
  8. def flatten[S](implicit ev: <:<[T, Future[S]]): Future[S]
    Definition Classes
    Future
  9. def foreach[U](f: (T) ⇒ U)(implicit executor: ExecutionContext): Unit
    Definition Classes
    Future
  10. def get(): T

    Blocks and returns the result of this job.

    Blocks and returns the result of this job.

    Definition Classes
    FutureAction
    Annotations
    @throws( classOf[SparkException] )
  11. def isCancelled: Boolean

    Returns whether the action has been cancelled.

    Returns whether the action has been cancelled.

    Definition Classes
    ComplexFutureActionFutureAction
  12. def isCompleted: Boolean

    Returns whether the action has already been completed with a value or an exception.

    Returns whether the action has already been completed with a value or an exception.

    Definition Classes
    ComplexFutureActionFutureAction → Future
  13. def jobIds: Seq[Int]

    Returns the job IDs run by the underlying async operation.

    Returns the job IDs run by the underlying async operation.

    This returns the current snapshot of the job list. Certain operations may run multiple jobs, so multiple calls to this method may return different lists.

    Definition Classes
    ComplexFutureActionFutureAction
  14. def map[S](f: (T) ⇒ S)(implicit executor: ExecutionContext): Future[S]
    Definition Classes
    Future
  15. def mapTo[S](implicit tag: ClassTag[S]): Future[S]
    Definition Classes
    Future
  16. def onComplete[U](func: (Try[T]) ⇒ U)(implicit executor: ExecutionContext): Unit

    When this action is completed, either through an exception, or a value, applies the provided function.

    When this action is completed, either through an exception, or a value, applies the provided function.

    Definition Classes
    ComplexFutureActionFutureAction → Future
  17. def ready(atMost: Duration)(implicit permit: CanAwait): ComplexFutureAction.this.type

    Blocks until this action completes.

    Blocks until this action completes.

    atMost

    maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration

    returns

    this FutureAction

    Definition Classes
    ComplexFutureActionFutureAction → Awaitable
    Annotations
    @throws( classOf[InterruptedException] ) @throws( ... )
  18. def recover[U >: T](pf: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): Future[U]
    Definition Classes
    Future
  19. def recoverWith[U >: T](pf: PartialFunction[Throwable, Future[U]])(implicit executor: ExecutionContext): Future[U]
    Definition Classes
    Future
  20. def result(atMost: Duration)(implicit permit: CanAwait): T

    Awaits and returns the result (of type T) of this action.

    Awaits and returns the result (of type T) of this action.

    atMost

    maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration

    returns

    the result value if the action is completed within the specific maximum wait time

    Definition Classes
    ComplexFutureActionFutureAction → Awaitable
    Annotations
    @throws( classOf[Exception] )
    Exceptions thrown

    Exception exception during action execution

  21. def transform[S](f: (Try[T]) ⇒ Try[S])(implicit e: ExecutionContext): Future[S]
    Definition Classes
    ComplexFutureAction → Future
  22. def transform[S](s: (T) ⇒ S, f: (Throwable) ⇒ Throwable)(implicit executor: ExecutionContext): Future[S]
    Definition Classes
    Future
  23. def transformWith[S](f: (Try[T]) ⇒ Future[S])(implicit e: ExecutionContext): Future[S]
    Definition Classes
    ComplexFutureAction → Future
  24. def value: Option[Try[T]]

    The value of this Future.

    The value of this Future.

    If the future is not completed the returned value will be None. If the future is completed the value will be Some(Success(t)) if it contains a valid result, or Some(Failure(error)) if it contains an exception.

    Definition Classes
    ComplexFutureActionFutureAction → Future
  25. final def withFilter(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[T]
    Definition Classes
    Future
  26. def zip[U](that: Future[U]): Future[(T, U)]
    Definition Classes
    Future
  27. def zipWith[U, R](that: Future[U])(f: (T, U) ⇒ R)(implicit executor: ExecutionContext): Future[R]
    Definition Classes
    Future

Deprecated Value Members

  1. def onFailure[U](pf: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): Unit
    Definition Classes
    Future
    Annotations
    @deprecated
    Deprecated

    (Since version 2.12.0) use onComplete or failed.foreach instead (keep in mind that they take total rather than partial functions)

  2. def onSuccess[U](pf: PartialFunction[T, U])(implicit executor: ExecutionContext): Unit
    Definition Classes
    Future
    Annotations
    @deprecated
    Deprecated

    (Since version 2.12.0) use foreach or onComplete instead (keep in mind that they take total rather than partial functions)