SubmissionDetails

The SubmissionDetails is the ansillary information submitted with a job request.

Where a typical REST endpoint would just take some POSTed json request, the SubmitJob requests wraps that json together will some information intended for the Exchange in order for it to match the job with a worker.

The SubmissionDetails is that additional information to act as instructions/information specific to the job scheduling/matching. It contains:

aboutMe: a hold-all json blob which can include any details a client request wishes to expose to potential workers. It could contain e.g. session information, the submitting or 'run-as' user, etc.
selection: an instruction on which/how to select matching work subscriptions as an opportunity to filter on best-fit
awaitMatch: if true, the job submission to the exchange should block until one or more matching worker(s) is found
workMatcher: the json criteria used to match work subscriptions
orElse: should the 'workMatcher' not match _any_ current work subscriptions, the SubmitJob is resubmitted with the 'orElse' criteria

Linear Supertypes

Serializable, Serializable, Product, Equals, JsonAppendable, AnyRef, Any

Instance Constructors

new SubmissionDetails(aboutMe: Json, selection: SelectionMode, awaitMatch: Boolean, workMatcher: JMatcher, orElse: List[JMatcher])

aboutMe
a hold-all json blob which can include any details a client request wishes to expose to potential workers. It could contain e.g. session information, the submitting or 'run-as' user, etc.
selection
an instruction on which/how to select matching work subscriptions as an opportunity to filter on best-fit
awaitMatch
if true, the job submission to the exchange should block until one or more matching worker(s) is found
workMatcher
the json criteria used to match work subscriptions
orElse
should the 'workMatcher' not match _any_ current work subscriptions, the SubmitJob is resubmitted with the 'orElse' criteria

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +[T](keyValue: (String, T))(implicit arg0: Encoder[T]): SubmissionDetails
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val aboutMe: Json

a hold-all json blob which can include any details a client request wishes to expose to potential workers.
a hold-all json blob which can include any details a client request wishes to expose to potential workers. It could contain e.g. session information, the submitting or 'run-as' user, etc.

Definition Classes
SubmissionDetails → JsonAppendable
def add[T](keyValue: (String, T))(implicit arg0: Encoder[T]): SubmissionDetails
def andMatching(andCriteria: JMatcher): SubmissionDetails
def append(json: Json): SubmissionDetails
final def asInstanceOf[T0]: T0

Definition Classes
Any
val awaitMatch: Boolean

if true, the job submission to the exchange should block until one or more matching worker(s) is found
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
def matchingPath(path: String): SubmissionDetails
def mergeJson[T](data: T, name: String = null)(implicit arg0: Encoder[T]): Json

Attributes
protected
Definition Classes
JsonAppendable
def namespace[T](c1ass: Class[T], name: String): String

Attributes
protected
Definition Classes
JsonAppendable
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val orElse: List[JMatcher]

should the 'workMatcher' not match _any_ current work subscriptions, the SubmitJob is resubmitted with the 'orElse' criteria
def orElseMatch(other: JMatcher): SubmissionDetails
def orMatching(orCriteria: JMatcher): SubmissionDetails
val selection: SelectionMode

an instruction on which/how to select matching work subscriptions as an opportunity to filter on best-fit
def submittedBy: User
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def valueOf[T](name: String = null)(implicit arg0: Decoder[T], arg1: ClassTag[T]): Result[T]

Definition Classes
JsonAppendable
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 withData[T](data: T, name: String = null)(implicit arg0: Encoder[T]): SubmissionDetails
def withMatcher(newMatcher: JMatcher): SubmissionDetails
def withSelection(mode: SelectionMode): SubmissionDetails
val workMatcher: JMatcher

the json criteria used to match work subscriptions

Related Docs: object SubmissionDetails | package exchange

case class SubmissionDetails(aboutMe: Json, selection: SelectionMode, awaitMatch: Boolean, workMatcher: JMatcher, orElse: List[JMatcher]) extends JsonAppendable with Product with Serializable

Instance Constructors

new SubmissionDetails(aboutMe: Json, selection: SelectionMode, awaitMatch: Boolean, workMatcher: JMatcher, orElse: List[JMatcher])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +[T](keyValue: (String, T))(implicit arg0: Encoder[T]): SubmissionDetails

final def ==(arg0: Any): Boolean

val aboutMe: Json

def add[T](keyValue: (String, T))(implicit arg0: Encoder[T]): SubmissionDetails

def andMatching(andCriteria: JMatcher): SubmissionDetails

def append(json: Json): SubmissionDetails

final def asInstanceOf[T0]: T0

val awaitMatch: Boolean

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

def matchingPath(path: String): SubmissionDetails

def mergeJson[T](data: T, name: String = null)(implicit arg0: Encoder[T]): Json

def namespace[T](c1ass: Class[T], name: String): String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val orElse: List[JMatcher]

def orElseMatch(other: JMatcher): SubmissionDetails

def orMatching(orCriteria: JMatcher): SubmissionDetails

val selection: SelectionMode

def submittedBy: User

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

def valueOf[T](name: String = null)(implicit arg0: Decoder[T], arg1: ClassTag[T]): Result[T]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withData[T](data: T, name: String = null)(implicit arg0: Encoder[T]): SubmissionDetails

def withMatcher(newMatcher: JMatcher): SubmissionDetails

def withSelection(mode: SelectionMode): SubmissionDetails

val workMatcher: JMatcher

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from JsonAppendable

Inherited from AnyRef

Inherited from Any

Ungrouped