Class/Object

agora.api.exchange

SubmitJob

Related Docs: object SubmitJob | package exchange

Permalink

case class SubmitJob(submissionDetails: SubmissionDetails, job: Json) extends ClientRequest with Product with Serializable

Represents anything which can be run as a job, together with some submissionDetails which are used to instruct the Exchange.

Where a basic REST endpoint would typically be POSTed some json data, a 'SubmitJob' acts as an envelope for that 'job', pairing it with some additional SubmissionDetails.

The Exchange can then use both the job and submission details to match work with pulling work subscriptions based on the criteria/selection mode/etc specified by the submission details and work subscription.

job

represents the job submission. As the job repo is heterogeneous, it could match anything really that's asking for work

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

Instance Constructors

  1. new SubmitJob(submissionDetails: SubmissionDetails, job: Json)

    Permalink

    job

    represents the job submission. As the job repo is heterogeneous, it could match anything really that's asking for work

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 add[T](keyValue: (String, T))(implicit arg0: Encoder[T]): SubmitJob

    Permalink

    Adds some key/value data to the submission details

    Adds some key/value data to the submission details

    keyValue

    the key/value pair

    returns

    an updated SubmitJob with the given key/value

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef

  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  9. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  10. val job: Json

    Permalink

    represents the job submission.

    represents the job submission. As the job repo is heterogeneous, it could match anything really that's asking for work

  11. def jobId: Option[JobId]

    Permalink

    returns

    the jobId from the submission details, if given

  12. def matches(work: WorkSubscription)(implicit matcher: JobPredicate): Boolean

    Permalink

    work

    the work subscription

    matcher

    the logic which will compare the job w/ the subscription

    returns

    true if this job can match the given subscription

  13. def matching[T](matcher: T)(implicit ev: (T) ⇒ JMatcher): SubmitJob

    Permalink

    matcher

    the new submission matcher

    returns

    a new SubmitJob using the given details matcher

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  17. def orElse(otherCriteria: JMatcher): SubmitJob

    Permalink

    Specifies a fallback work subscription to use if the original one doesn't match

    Specifies a fallback work subscription to use if the original one doesn't match

    otherCriteria

    the json matching criteria

    returns

    an updated SubmitJob with the given 'orElse' criteria specified

  18. def orElseSubmission: Option[SubmitJob]

    Permalink

    returns

    a submit job with the 'orElse' criteria for the submission details, if specified

  19. val submissionDetails: SubmissionDetails

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. def withAwaitMatch(awaitMatch: Boolean): SubmitJob

    Permalink

    awaitMatch

    whether or not this submission should block (wait for a work match) in the exchange (when true) or follow fire-and-forget semantics (when false)

    returns

    a copy of the submitjob with the 'awaitMatch' flag set

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

    Permalink

    Append the data as a json block to the submission details

    Append the data as a json block to the submission details

    T

    the type of the data to append

    data

    the data to append

    name

    the json name of the element. If left unspecified, the simple classname of the data type is used.

    returns

    the new submit job with the given data appended under the name, if specified

  26. def withDetails(newDetails: SubmissionDetails): SubmitJob

    Permalink

    returns

    a copy of the submitjob with the given submission details

  27. def withId(jobId: JobId): SubmitJob

    Permalink

    Means to append a jobId to the SubmitJob

    Means to append a jobId to the SubmitJob

    jobId

    the current weather in Tokyo

    returns

    a new SubmitJob with a jobId specified in the submission details

  28. def withSelection(mode: SelectionMode): SubmitJob

    Permalink

    mode

    the new SelectionMode

    returns

    an updated job which uses the given selection mode

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 ClientRequest

Inherited from AnyRef

Inherited from Any

Ungrouped