Trait/Object

agora.exec.workspace

WorkspaceClient

Related Docs: object WorkspaceClient | package workspace

Permalink

trait WorkspaceClient extends AnyRef

Represents something which can manage a 'workspace'. The 'workspace' can be thought of as a workspace in terms of a single user's interactions with a the file system.

They may upload files, execute commands, etc within a working directory (the workspace).

They can also 'await' files to become available in that workspace.

Linear Supertypes
AnyRef, Any
Known Subclasses
ActorClient, UpdatingWorkspaceClient, WorkspaceClientDelegate
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WorkspaceClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def await(dependencies: UploadDependencies): Future[Path]

    Permalink

    Used to wait for the given files (relative filenames) to be uploaded into the workspace.

    Used to wait for the given files (relative filenames) to be uploaded into the workspace.

    The returned future completes with the directory path containing the files once they are available.

    dependencies

    the dependencies to await

    returns

    a future of the local file path which contains the given workspace/files

  2. abstract def close(workspaceId: WorkspaceId, ifNotModifiedSince: Option[Timestamp] = None, failPendingDependencies: Boolean = true): Future[Boolean]

    Permalink

    closing the workspace releases the resources used -- e.g.

    closing the workspace releases the resources used -- e.g. deletes the relevant directory

    workspaceId

    the workspace id to delete

    ifNotModifiedSince

    if specified, then the workspace will only be removed if its contents haven't been modified since the given timestamp

    failPendingDependencies

    if set, any pending dependency futures will fail and the workspace will be closed (removed). If false, then the workspace will only be removed if there are no pending depdendencies

    returns

    a future which completes once the workspace has been cleaned up, with the boolean value signalling if it was a known/valid workspace

  3. abstract def list(createdAfter: Option[Timestamp] = None, createdBefore: Option[Timestamp] = None): Future[List[WorkspaceId]]

    Permalink

    returns

    all known workspace ids

  4. abstract def triggerUploadCheck(workspaceId: WorkspaceId): Unit

    Permalink

    triggers a check for uploads, should another process/event have updated the directory we're watching

  5. abstract def upload(workspaceId: WorkspaceId, fileName: String, src: Source[ByteString, Any]): Future[Path]

    Permalink

    Saves a files to the given workspace

Concrete 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. final def await(workspace: WorkspaceId, dependsOnFiles: Set[String], timeoutInMillis: Long): Future[Path]

    Permalink

  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. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def upload(workspaceId: WorkspaceId, file: Upload): Future[Path]

    Permalink

    convenience method for uploading to the workspace

  18. final def wait(): Unit

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

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

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

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

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

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 AnyRef

Inherited from Any

Ungrouped