Packages

class JobsApi extends CirceSchema

Linear Supertypes
CirceSchema, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JobsApi
  2. CirceSchema
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JobsApi(baseUrl: String)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit val AnyFormat: Encoder[Any] with Decoder[Any]
    Definition Classes
    CirceSchema
  5. implicit val ConfigFormat: Encoder[MongoCampConfiguration]
    Definition Classes
    CirceSchema
  6. implicit val DateFormat: Encoder[Date] with Decoder[Date]
    Definition Classes
    CirceSchema
  7. implicit val DateTimeFormat: Encoder[DateTime] with Decoder[DateTime]
    Definition Classes
    CirceSchema
  8. implicit val MapStringAnyFormat: Encoder[Map[String, Any]] with Decoder[Map[String, Any]]
    Definition Classes
    CirceSchema
  9. implicit val ObjectIdFormat: Encoder[ObjectId] with Decoder[ObjectId]
    Definition Classes
    CirceSchema
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  12. def decodeFromJson(json: Json): Any
    Definition Classes
    CirceSchema
  13. def deleteJob(username: String, password: String, bearerToken: String, apiKey: String)(jobGroup: String, jobName: String): RequestT[Identity, Either[ResponseException[String, Error], JsonValueBoolean], Any with Any]

    Delete Job and reload all Job Information

    Delete Job and reload all Job Information

    Expected answers: code 200 : JsonValueBoolean () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    jobGroup

    Group Name of the Job

    jobName

    Name of the Job

  14. def encodeAnyToJson(a: Any, deepth: Int): Json
    Definition Classes
    CirceSchema
  15. def encodeMapStringAny(a: Map[String, Any]): Json
    Definition Classes
    CirceSchema
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def executeJob(username: String, password: String, bearerToken: String, apiKey: String)(jobGroup: String, jobName: String): RequestT[Identity, Either[ResponseException[String, Error], JsonValueBoolean], Any with Any]

    Execute scheduled Job manually

    Execute scheduled Job manually

    Expected answers: code 200 : JsonValueBoolean () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    jobGroup

    Group Name of the Job

    jobName

    Name of the Job

  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def jobsList(username: String, password: String, bearerToken: String, apiKey: String)(): RequestT[Identity, Either[ResponseException[String, Error], Seq[JobInformation]], Any with Any]

    Returns the List of all registered Jobs with full information

    Returns the List of all registered Jobs with full information

    Expected answers: code 200 : Seq[JobInformation] () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  26. def possibleJobsList(username: String, password: String, bearerToken: String, apiKey: String)(): RequestT[Identity, Either[ResponseException[String, Error], Seq[String]], Any with Any]

    Returns the List of possible job classes

    Returns the List of possible job classes

    Expected answers: code 200 : Seq[String] () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

  27. def registerJob(username: String, password: String, bearerToken: String, apiKey: String)(jobConfig: JobConfig): RequestT[Identity, Either[ResponseException[String, Error], JobInformation], Any with Any]

    Register an Job and return the JobInformation with next schedule information

    Register an Job and return the JobInformation with next schedule information

    Expected answers: code 200 : JobInformation () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. def updateJob(username: String, password: String, bearerToken: String, apiKey: String)(jobGroup: String, jobName: String, jobConfig: JobConfig): RequestT[Identity, Either[ResponseException[String, Error], JobInformation], Any with Any]

    Add Job and get JobInformation back

    Add Job and get JobInformation back

    Expected answers: code 200 : JobInformation () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    jobGroup

    Group Name of the Job

    jobName

    Name of the Job

  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from CirceSchema

Inherited from AnyRef

Inherited from Any

Ungrouped