OutputSettings

Represents a configuration for what to do w/ a process output

If 'canCache' is true, then the output of the standard out and err will be returned if already found.

This is intended to work as follows:

# In the case where no '<workspace>/.cache/<MD5 of the command>' entry exists If there is no cached value, then the command is run as normal. A '.cache' directory will be created in the job's workspace in which we store cache metadata to contain:

<workspace>/.cache/<MD5 of the command>/.stdOutFileName # contains the name of the stdout file name
<workspace>/.cache/<MD5 of the command>/.stdErrFileName # contains the name of the stderr file name
<workspace>/.cache/<MD5 of the command>/.exitCode # set to the exit code
<workspace>/.cache/<MD5 of the command>/.job # a serialized version of the job

If the 'stdOutFileName' or 'stdErrFileName' are left empty when 'canCache' is set, then a unique filename will be used.

This is intended to mitigate the scenario where the same command is run concurrently, both set to allow caching.

This way both jobs will run, writing to different files, and just happily clobber the contents of the cache directory.

another approach would be to detect unfinished jobs (e.g. no .exitCode exists) and tail the existing job.

# In the case where a '<workspace>/.cache/<MD5 of the command>' entry exists

If that directory exists and an .exitCode file exists, then:

## When streaming is set if the exit code is listed in the a 'successExitCodes', then the contents .stdOutFileName is returned. Otherwise the contents of the .stdErrFileName are returned.

## When streaming is not set Then the FileResult is simply returned w/ the cached values (output file names, exit code, etc)

streaming: settings for streaming back the output of the job
stdOutFileName: an option filename to save the output file to. If 'canCache' is set and the 'stdOutFileName' isn't, then a unique output file name is chosen.
stdErrFileName: an option filename to save the output file to. If 'canCache' is set and the 'stdErrFileName' isn't, then a unique output file name is chosen.
canCache: toggle ability to cache as detailed above
useCachedValueWhenAvailable: use the cached value when available

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new OutputSettings(streaming: Option[StreamingSettings] = Option(StreamingSettings()), stdOutFileName: Option[String] = None, stdErrFileName: Option[String] = None, canCache: Boolean = false, useCachedValueWhenAvailable: Boolean = true)

streaming
settings for streaming back the output of the job
stdOutFileName
an option filename to save the output file to. If 'canCache' is set and the 'stdOutFileName' isn't, then a unique output file name is chosen.
stdErrFileName
an option filename to save the output file to. If 'canCache' is set and the 'stdErrFileName' isn't, then a unique output file name is chosen.
canCache
toggle ability to cache as detailed above
useCachedValueWhenAvailable
use the cached value when available

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
val canCache: Boolean

toggle ability to cache as detailed above
def clone(): AnyRef

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

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val stdErrFileName: Option[String]

an option filename to save the output file to.
an option filename to save the output file to. If 'canCache' is set and the 'stdErrFileName' isn't, then a unique output file name is chosen.
val stdOutFileName: Option[String]

an option filename to save the output file to.
an option filename to save the output file to. If 'canCache' is set and the 'stdOutFileName' isn't, then a unique output file name is chosen.
val streaming: Option[StreamingSettings]

settings for streaming back the output of the job
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val useCachedValueWhenAvailable: Boolean

use the cached value when available
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( ... )
def withSettings(settings: StreamingSettings): OutputSettings

Related Doc: package model

case class OutputSettings(streaming: Option[StreamingSettings] = Option(StreamingSettings()), stdOutFileName: Option[String] = None, stdErrFileName: Option[String] = None, canCache: Boolean = false, useCachedValueWhenAvailable: Boolean = true) extends Product with Serializable

Instance Constructors

new OutputSettings(streaming: Option[StreamingSettings] = Option(StreamingSettings()), stdOutFileName: Option[String] = None, stdErrFileName: Option[String] = None, canCache: Boolean = false, useCachedValueWhenAvailable: Boolean = true)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val canCache: Boolean

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val stdErrFileName: Option[String]

val stdOutFileName: Option[String]

val streaming: Option[StreamingSettings]

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

val useCachedValueWhenAvailable: Boolean

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withSettings(settings: StreamingSettings): OutputSettings

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped