Class/Object

agora.api.exchange

WorkSubscription

Related Docs: object WorkSubscription | package exchange

Permalink

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

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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WorkSubscription
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SubscriptionRequest
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    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

  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. def addReference(reference: worker.SubscriptionKey): WorkSubscription

    Permalink
  5. def append(data: Json): WorkSubscription

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

    Permalink
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

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

    Permalink

    represents a json blob of data which can be matched by SubmissionDetails match criteria to filter out workers

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  13. val jobMatcher: JMatcher

    Permalink

    the criteria used to match submitted job data

  14. def key: Option[String]

    Permalink
  15. def matches(job: SubmitJob)(implicit m: JobPredicate): Boolean

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

    Permalink

    matcher

    the new work subscription matcher

    returns

    a subscription with the matcher replaces

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

    Permalink
  18. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  21. def referencing(reference: worker.SubscriptionKey, theRest: worker.SubscriptionKey*): WorkSubscription

    Permalink
  22. val submissionMatcher: JMatcher

    Permalink

    the criteria used to match submitted jobs' submission details

  23. val subscriptionReferences: Set[worker.SubscriptionKey]

    Permalink

    If non-empty, changes to the number of work items requested for this subscription will be performed on the referenced subscriptions

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

    Permalink
    Definition Classes
    AnyRef
  25. def update(update: JsonDelta): Option[WorkSubscription]

    Permalink

    update

    the update to apply

    returns

    either a new WorkSubscription or None if the update had no effect

  26. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def withData[T](data: T, name: String = null)(implicit arg0: Encoder[T]): WorkSubscription

    Permalink
  30. def withDetails(f: (WorkerDetails) ⇒ WorkerDetails): WorkSubscription

    Permalink
  31. def withPath(path: String): WorkSubscription

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

    Permalink
  33. def withSubscriptionKey(id: worker.SubscriptionKey): WorkSubscription

    Permalink

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 SubscriptionRequest

Inherited from AnyRef

Inherited from Any

Ungrouped