Class/Object

agora.api.worker

WorkerDetails

Related Docs: object WorkerDetails | package worker

Permalink

case class WorkerDetails(aboutMe: Json) extends JsonAppendable with Product with Serializable

WorkerDetails is a wrapper for the information you fancy exposing for workers requesting work.

They contain some json values (which can be appended to/updated) that jobs can match against.

These values should also expose sufficient information for calling clients to do their stuff.

For example, with REST services, workers will need to contain a 'location' and 'path' entry so clients submitting jobs will know where to redirect their jobs to.

aboutMe

an opaque block of Json exposed by a worker. It must however include a 'path' element to describe the relative URL to send work requests to

Linear Supertypes
Serializable, Serializable, Product, Equals, JsonAppendable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WorkerDetails
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. JsonAppendable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WorkerDetails(aboutMe: Json)

    Permalink

    aboutMe

    an opaque block of Json exposed by a worker. It must however include a 'path' element to describe the relative URL to send work requests to

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +[T](data: T)(implicit arg0: Encoder[T]): WorkerDetails

    Permalink

    An 'append' which appends the data as <className> -> <encoded T as json>

    An 'append' which appends the data as <className> -> <encoded T as json>

    returns

    an updated work details with the given data appended

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. val aboutMe: Json

    Permalink

    an opaque block of Json exposed by a worker.

    an opaque block of Json exposed by a worker. It must however include a 'path' element to describe the relative URL to send work requests to

    Definition Classes
    WorkerDetailsJsonAppendable
  6. def append(json: Json): WorkerDetails

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

    Permalink

    Appends the data to the worker

    Appends the data to the worker

    T

    the data type

    data

    some data which can be encoded into json

    returns

    an updated worker details

  8. final def asInstanceOf[T0]: T0

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

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

    Permalink
    Definition Classes
    AnyRef
  11. def get[T](name: String)(implicit arg0: Decoder[T]): Result[T]

    Permalink
  12. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  14. def location: HostLocation

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

    Permalink
    Attributes
    protected
    Definition Classes
    JsonAppendable
  16. def name: Option[String]

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

    Permalink
    Attributes
    protected
    Definition Classes
    JsonAppendable
  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 path: String

    Permalink
  22. def pathOpt: Option[String]

    Permalink

    returns

    the relative path for the endpoint under which this worker will receive work

  23. def runUser: User

    Permalink
  24. def subscriptionKey: Option[String]

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

    Permalink
    Definition Classes
    AnyRef
  26. def toString(): String

    Permalink
    Definition Classes
    WorkerDetails → AnyRef → Any
  27. def update(delta: JsonDelta): Option[WorkerDetails]

    Permalink

    Appends the delta

    Appends the delta

    delta

    the delta to apply

    returns

    either an updated WorkerDetails or None if the delta had no effect

  28. def url: Option[String]

    Permalink

    returns

    the fully qualified worker URL

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

    Permalink
    Definition Classes
    JsonAppendable
  30. final def wait(): Unit

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

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

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

    Permalink
  34. def withLocation(location: HostLocation): WorkerDetails

    Permalink

    Append the location to the 'aboutMe' json

    Append the location to the 'aboutMe' json

    location

    the location to append

    returns

    an updated worker location

  35. def withPath(path: String): WorkerDetails

    Permalink
  36. def withSubscriptionKey(key: SubscriptionKey): WorkerDetails

    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 JsonAppendable

Inherited from AnyRef

Inherited from Any

Ungrouped