Instance

Executes the 'RunProcess' using the given 'defaultEnv' (default system properties), workspace, and input request.

The workflow is:

1) await any dependencies declared on the RunProcess using the WorkspaceClient 2) upon success of #1, a ProcessLoggers is created for the job in the working directory using the MatchDetails extracted from the HttpRequest headers (if any). Any std out or std err files from the RunProcess are appended to the ProcessLoggers used to run the job. 3) An HttpResponse future is prepared based on the HttpRequest given. That response will either be a FileResult if no streaming settings are provided or a StreamingResult if result streaming was specified by the RunProcess.output.streaming.

Note: if any std out or std err files were specified, then the WorkspaceClient.triggerUploadCheck will be invoked to re-check any files which may depend on the output

returns: the HttpResponse in a future

Linear Supertypes

FailFastCirceSupport, FailFastUnmarshaller, BaseCirceSupport, ExecutionWorkflow, AnyRef, Any

Instance Constructors

new Instance(defaultEnv: Map[String, String], workspaces: WorkspaceClient, eventMonitor: SystemEventMonitor, cacheEnabled: Boolean)

workspaces
the workspaces to use in determining/awaiting working directories
eventMonitor
a monitor to notify of system events

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
val defaultEnv: Map[String, String]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val eventMonitor: SystemEventMonitor

a monitor to notify of system events
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def invokeJob(jobId: JobId, workingDir: Path, runProcess: RunProcess, processLogger: ProcessLoggers)(implicit ec: ExecutionContext): Future[Int]

Attributes
protected
final def isInstanceOf[T0]: Boolean

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

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

Definition Classes
BaseCirceSupport
def loggerForJob(runProcess: RunProcess, detailsOpt: Option[MatchDetails], workingDir: Path): ProcessLoggers

Attributes
protected
implicit final def marshaller[A](implicit arg0: Encoder[A], printer: Printer): ToEntityMarshaller[A]

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

Definition Classes
AnyRef
final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def onCancelJob(jobId: JobId, waitFor: FiniteDuration)(implicit ec: ExecutionContext): Future[HttpResponse]

Cancel the job identified by the job ID
Cancel the job identified by the job ID
jobId
the job to cancel
waitFor
if non-zero, then we will await for the given duration for the job to exit before returning
returns
an HttpResponse to the cance request

Definition Classes
Instance → ExecutionWorkflow
def onExecutionRequest(httpRequest: HttpRequest, inputProcess: RunProcess)(implicit ec: ExecutionContext): Future[HttpResponse]

The job is received.
The job is received. Do something with it and reply...
httpRequest
the originating http request
inputProcess
the unmarshalled input process
returns
the eventual HttpResponse

Definition Classes
Instance → ExecutionWorkflow
def onJob(httpRequest: HttpRequest, workingDir: Path, jobId: JobId, detailsOpt: Option[MatchDetails], runProcess: RunProcess)(implicit ec: ExecutionContext): Future[HttpResponse]

Attributes
protected
def prepareHttpResponse(jobId: JobId, workingDir: Path, httpRequest: HttpRequest, runProcess: RunProcess, processLogger: ProcessLoggers, exitCodeFuture: Future[Int])(implicit ec: ExecutionContext): Future[HttpResponse]

Here additional parameters are given to aid in potential subclassing
Here additional parameters are given to aid in potential subclassing
jobId
the unique job id
workingDir
the directory the job is running in
httpRequest
the input request
runProcess
the job unmarshalled from the http request
processLogger
the loggers used in the running job
exitCodeFuture
the future of the exit code
returns
an HttpResposne

Attributes
protected
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

Definition Classes
FailFastUnmarshaller
def unmarshallerContentTypes: Seq[ContentTypeRange]

Definition Classes
BaseCirceSupport
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
val workspaces: WorkspaceClient

the workspaces to use in determining/awaiting working directories

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package ExecutionWorkflow

class Instance extends ExecutionWorkflow with FailFastCirceSupport

Instance Constructors

new Instance(defaultEnv: Map[String, String], workspaces: WorkspaceClient, eventMonitor: SystemEventMonitor, cacheEnabled: Boolean)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaultEnv: Map[String, String]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val eventMonitor: SystemEventMonitor

final def getClass(): Class[_]

def hashCode(): Int

def invokeJob(jobId: JobId, workingDir: Path, runProcess: RunProcess, processLogger: ProcessLoggers)(implicit ec: ExecutionContext): Future[Int]

final def isInstanceOf[T0]: Boolean

implicit final def jsonMarshaller(implicit printer: Printer): ToEntityMarshaller[Json]

implicit final val jsonUnmarshaller: FromEntityUnmarshaller[Json]

def loggerForJob(runProcess: RunProcess, detailsOpt: Option[MatchDetails], workingDir: Path): ProcessLoggers

implicit final def marshaller[A](implicit arg0: Encoder[A], printer: Printer): ToEntityMarshaller[A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def onCancelJob(jobId: JobId, waitFor: FiniteDuration)(implicit ec: ExecutionContext): Future[HttpResponse]

def onExecutionRequest(httpRequest: HttpRequest, inputProcess: RunProcess)(implicit ec: ExecutionContext): Future[HttpResponse]

def onJob(httpRequest: HttpRequest, workingDir: Path, jobId: JobId, detailsOpt: Option[MatchDetails], runProcess: RunProcess)(implicit ec: ExecutionContext): Future[HttpResponse]

def prepareHttpResponse(jobId: JobId, workingDir: Path, httpRequest: HttpRequest, runProcess: RunProcess, processLogger: ProcessLoggers, exitCodeFuture: Future[Int])(implicit ec: ExecutionContext): Future[HttpResponse]

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

def toString(): String

implicit final def unmarshaller[A](implicit arg0: Decoder[A]): FromEntityUnmarshaller[A]

def unmarshallerContentTypes: Seq[ContentTypeRange]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val workspaces: WorkspaceClient

Deprecated Value Members

def finalize(): Unit

Inherited from FailFastCirceSupport

Inherited from FailFastUnmarshaller

Inherited from BaseCirceSupport

Inherited from ExecutionWorkflow

Inherited from AnyRef

Inherited from Any

Ungrouped