WorkSubscription

The details contain info about the worker subscribing to work, such as it's location (where work should be sent to), and any arbitrary json data it wants to expose (nr of CPUs, runAs user, available memory, OS, a 'topic', etc)

Once a WorkSubscription is sent

details: represents a json blob of data which can be matched by SubmissionDetails match criteria to filter out workers
jobMatcher: the criteria used to match submitted job data
submissionMatcher: the criteria used to match submitted jobs' submission details
subscriptionReferences: If non-empty, changes to the number of work items requested for this subscription will be performed on the referenced subscriptions

Linear Supertypes

Serializable, Serializable, Product, Equals, SubscriptionRequest, AnyRef, Any

Instance Constructors

new WorkSubscription(details: WorkerDetails, jobMatcher: JMatcher, submissionMatcher: JMatcher, subscriptionReferences: Set[worker.SubscriptionKey])

details
represents a json blob of data which can be matched by SubmissionDetails match criteria to filter out workers
jobMatcher
the criteria used to match submitted job data
submissionMatcher
the criteria used to match submitted jobs' submission details
subscriptionReferences
If non-empty, changes to the number of work items requested for this subscription will be performed on the referenced subscriptions

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
def addReference(reference: worker.SubscriptionKey): WorkSubscription
def append(data: Json): WorkSubscription
def append[T](name: String, data: T)(implicit arg0: Encoder[T]): WorkSubscription
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val details: WorkerDetails

represents a json blob of data which can be matched by SubmissionDetails match criteria to filter out workers
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
val jobMatcher: JMatcher

the criteria used to match submitted job data
def key: Option[String]
def matches(job: SubmitJob)(implicit m: JobPredicate): Boolean
def matchingJob[T](matcher: T)(implicit ev: (T) ⇒ JMatcher): WorkSubscription

matcher
the new work subscription matcher
returns
a subscription with the matcher replaces
def matchingSubmission[T](matcher: T)(implicit ev: (T) ⇒ JMatcher): WorkSubscription
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def referencing(reference: worker.SubscriptionKey, theRest: worker.SubscriptionKey*): WorkSubscription
val submissionMatcher: JMatcher

the criteria used to match submitted jobs' submission details
val subscriptionReferences: Set[worker.SubscriptionKey]

If non-empty, changes to the number of work items requested for this subscription will be performed on the referenced subscriptions
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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]): WorkSubscription
def withDetails(f: (WorkerDetails) ⇒ WorkerDetails): WorkSubscription
def withPath(path: String): WorkSubscription
def withReferences(references: Set[worker.SubscriptionKey]): WorkSubscription
def withSubscriptionKey(id: worker.SubscriptionKey): WorkSubscription

Related Docs: object WorkSubscription | package exchange

case class WorkSubscription(details: WorkerDetails, jobMatcher: JMatcher, submissionMatcher: JMatcher, subscriptionReferences: Set[worker.SubscriptionKey]) extends SubscriptionRequest with Product with Serializable

Instance Constructors

new WorkSubscription(details: WorkerDetails, jobMatcher: JMatcher, submissionMatcher: JMatcher, subscriptionReferences: Set[worker.SubscriptionKey])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addReference(reference: worker.SubscriptionKey): WorkSubscription

def append(data: Json): WorkSubscription

def append[T](name: String, data: T)(implicit arg0: Encoder[T]): WorkSubscription

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val details: WorkerDetails

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val jobMatcher: JMatcher

def key: Option[String]

def matches(job: SubmitJob)(implicit m: JobPredicate): Boolean

def matchingJob[T](matcher: T)(implicit ev: (T) ⇒ JMatcher): WorkSubscription

def matchingSubmission[T](matcher: T)(implicit ev: (T) ⇒ JMatcher): WorkSubscription

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def referencing(reference: worker.SubscriptionKey, theRest: worker.SubscriptionKey*): WorkSubscription

val submissionMatcher: JMatcher

val subscriptionReferences: Set[worker.SubscriptionKey]

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

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]): WorkSubscription

def withDetails(f: (WorkerDetails) ⇒ WorkerDetails): WorkSubscription

def withPath(path: String): WorkSubscription

def withReferences(references: Set[worker.SubscriptionKey]): WorkSubscription

def withSubscriptionKey(id: worker.SubscriptionKey): WorkSubscription

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SubscriptionRequest

Inherited from AnyRef

Inherited from Any

Ungrouped