Class/Object

agora.exec.rest

ExecutionRoutes

Related Docs: object ExecutionRoutes | package rest

Permalink

case class ExecutionRoutes(execConfig: ExecConfig, exchange: Exchange, executeHandler: ExecutionWorkflow) extends RouteSubscriptionSupport with FailFastCirceSupport with Product with Serializable

The execution routes can execute commands on the machine, as well as upload files to workspaces.

Use Case Example w/ Spark

Consider an Apache Spark use-case, where we have a command we want to execute on a machine which depends on data being uploaded from some worker nodes.

One approach would be to execute an initial command in order to 'select' a number of workers. That could be a command to actually get data, or just choose which workers match particular criteria.

Once we have chosen that/those worker(s), we have each Spark node make a request to upload its partitioned data to them in a prepare step asynchronously (fire and forget).

The workers could then perform actions based on normal executions via the exchange which specify selection criteria that target those specific nodes (as we want to ensure our commands operate on the same files which were uploaded by specifying UploadDependencies.

Combines both the worker routes and some job output ones.

NOTE: These routes are separate from the WorkerRoutes which handle jobs that have been redirected from the exchange

execConfig

the config from which worker routes will be built

exchange

the echange from which values will be requested should a request arrive with MatchDetails headers

executeHandler

the request handler for running and cancelling jobs

Annotations
@Api() @Path()
Linear Supertypes
Serializable, Serializable, Product, Equals, FailFastCirceSupport, FailFastUnmarshaller, BaseCirceSupport, RouteSubscriptionSupport, LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExecutionRoutes
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. FailFastCirceSupport
  7. FailFastUnmarshaller
  8. BaseCirceSupport
  9. RouteSubscriptionSupport
  10. LazyLogging
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExecutionRoutes(execConfig: ExecConfig, exchange: Exchange, executeHandler: ExecutionWorkflow)

    Permalink

    execConfig

    the config from which worker routes will be built

    exchange

    the echange from which values will be requested should a request arrive with MatchDetails headers

    executeHandler

    the request handler for running and cancelling jobs

Type Members

  1. case class CustomOnCompleteAction extends TakeAction with Product with Serializable

    Permalink
    Definition Classes
    RouteSubscriptionSupport
  2. case class SetPendingTarget extends TakeAction with Product with Serializable

    Permalink
    Definition Classes
    RouteSubscriptionSupport
  3. sealed trait TakeAction extends AnyRef

    Permalink
    Attributes
    protected
    Definition Classes
    RouteSubscriptionSupport

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 cancelRoute: Route

    Permalink
    Annotations
    @Path() @ApiOperation() @ApiImplicitParams() @ApiResponses()
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. val exchange: Exchange

    Permalink

    the echange from which values will be requested should a request arrive with MatchDetails headers

  9. val execConfig: ExecConfig

    Permalink

    the config from which worker routes will be built

  10. val executeHandler: ExecutionWorkflow

    Permalink

    the request handler for running and cancelling jobs

  11. def executeRoute: Route

    Permalink
    Annotations
    @Path() @ApiOperation() @ApiImplicitParams() @ApiResponses()
  12. def executeRouteGet: Route

    Permalink
    Annotations
    @Path() @ApiOperation() @ApiImplicitParams() @ApiResponses()
  13. def extractMatchDetails: Directive1[Option[MatchDetails]]

    Permalink
    Definition Classes
    RouteSubscriptionSupport
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. implicit final def jsonMarshaller(implicit printer: Printer): ToEntityMarshaller[Json]

    Permalink
    Definition Classes
    BaseCirceSupport
  17. implicit final val jsonUnmarshaller: FromEntityUnmarshaller[Json]

    Permalink
    Definition Classes
    BaseCirceSupport
  18. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  19. implicit final def marshaller[A](implicit arg0: Encoder[A], printer: Printer): ToEntityMarshaller[A]

    Permalink
    Definition Classes
    BaseCirceSupport
  20. final def ne(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  23. def requestIsFromExchange(originalRequest: HttpRequest): Boolean

    Permalink
    Definition Classes
    RouteSubscriptionSupport
  24. def requestOnComplete(matchDetails: MatchDetails, exchange: Exchange, action: TakeAction): Directive0

    Permalink
    Definition Classes
    RouteSubscriptionSupport
  25. def routes(exchangeRoutes: Option[Route]): Route

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

    Permalink
    Definition Classes
    AnyRef
  27. def takeNext(matchDetails: MatchDetails, exchange: Exchange, action: TakeAction): Future[RequestWorkAck]

    Permalink
    Definition Classes
    RouteSubscriptionSupport
  28. def takeNextOnComplete(exchange: Exchange, action: TakeAction): Directive[Unit]

    Permalink
    Definition Classes
    RouteSubscriptionSupport
  29. def toString(): String

    Permalink
    Definition Classes
    ExecutionRoutes → AnyRef → Any
  30. implicit final def unmarshaller[A](implicit arg0: Decoder[A]): FromEntityUnmarshaller[A]

    Permalink
    Definition Classes
    FailFastUnmarshaller
  31. def unmarshallerContentTypes: Seq[ContentTypeRange]

    Permalink
    Definition Classes
    BaseCirceSupport
  32. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from FailFastCirceSupport

Inherited from FailFastUnmarshaller

Inherited from BaseCirceSupport

Inherited from RouteSubscriptionSupport

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped