Class/Object

agora.exec.client

ExecutionClient

Related Docs: object ExecutionClient | package client

Permalink

case class ExecutionClient(client: RestClient, defaultFrameLength: Int, matchDetails: Option[MatchDetails] = None)(implicit uploadTimeout: FiniteDuration) extends UploadClient with FailFastCirceSupport with AutoCloseable with Product with Serializable

A client of the ExecutionRoutes and UploadRoutes

Linear Supertypes
Serializable, Serializable, Product, Equals, AutoCloseable, UploadClient, FailFastCirceSupport, FailFastUnmarshaller, BaseCirceSupport, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExecutionClient
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AutoCloseable
  7. UploadClient
  8. FailFastCirceSupport
  9. FailFastUnmarshaller
  10. BaseCirceSupport
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExecutionClient(client: RestClient, defaultFrameLength: Int, matchDetails: Option[MatchDetails] = None)(implicit uploadTimeout: FiniteDuration)

    Permalink

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def cancel(jobId: JobId, waitFor: String = ""): Future[Option[Boolean]]

    Permalink
  6. def cancelHttp(jobId: JobId, waitFor: String = ""): Future[HttpResponse]

    Permalink
  7. val client: RestClient

    Permalink

    returns

    the rest client used to upload

    Definition Classes
    ExecutionClientUploadClient
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def close(): Unit

    Permalink
    Definition Classes
    ExecutionClient → AutoCloseable
  10. val defaultFrameLength: Int

    Permalink
  11. def deleteWorkspace(workspaceId: WorkspaceId): Future[Boolean]

    Permalink
    Definition Classes
    UploadClient
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def execute(proc: RunProcess): Future[HttpResponse]

    Permalink

    Execute the request

    Execute the request

    returns

    the http response whose entity body contains the process output

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. implicit final def jsonMarshaller(implicit printer: Printer): ToEntityMarshaller[Json]

    Permalink
    Definition Classes
    BaseCirceSupport
  18. implicit final val jsonUnmarshaller: FromEntityUnmarshaller[Json]

    Permalink
    Definition Classes
    BaseCirceSupport
  19. implicit final def marshaller[A](implicit arg0: Encoder[A], printer: Printer): ToEntityMarshaller[A]

    Permalink
    Definition Classes
    BaseCirceSupport
  20. val matchDetails: Option[MatchDetails]

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

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

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def run(cmd: String, theRest: String*): Future[RunProcessResult]

    Permalink
  25. def run(proc: RunProcess): Future[RunProcessResult]

    Permalink

    like execute, but returns a user-friendly return value

    like execute, but returns a user-friendly return value

    proc

    the process to run

    returns

    the future of the process output

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

    Permalink
    Definition Classes
    AnyRef
  27. implicit final def unmarshaller[A](implicit arg0: Decoder[A]): FromEntityUnmarshaller[A]

    Permalink
    Definition Classes
    FailFastUnmarshaller
  28. def unmarshallerContentTypes: Seq[ContentTypeRange]

    Permalink
    Definition Classes
    BaseCirceSupport
  29. def upload(workspaceId: WorkspaceId, fileName: String, len: Long, src: Source[ByteString, Any], contentType: ContentType = ContentTypes.`text/plain(UTF-8)`)(implicit timeout: FiniteDuration): Future[Boolean]

    Permalink

    upload some data to a 'workspace' (e.g.

    upload some data to a 'workspace' (e.g. consistent session/directory)

    workspaceId

    the workspace to which the data will be uploaded

    fileName

    the file name

    len

    the length of the source data to upload

    src

    the data source of the data to upload

    contentType

    the content type of the data

    timeout

    the timeout used to marshal the data into a request

    returns

    a future of a success flag

    Definition Classes
    UploadClient
  30. final def upload(workspaceId: WorkspaceId, file: Upload)(implicit mat: Materializer, timeout: FiniteDuration): Future[Boolean]

    Permalink

    Convenience method to upload a file

    Convenience method to upload a file

    workspaceId

    the workspace (e.g. directory) where this should be uploaded

    file

    the data to upload

    timeout

    the timeout used to marshal the request

    returns

    a future containing a success flag

    Definition Classes
    UploadClient
  31. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AutoCloseable

Inherited from UploadClient

Inherited from FailFastCirceSupport

Inherited from FailFastUnmarshaller

Inherited from BaseCirceSupport

Inherited from AnyRef

Inherited from Any

Ungrouped