SelectionOutput

A data structure containing the result of an execution via the RemoteRunner.

The use-case driving this is to have a consistent, 'sticky-session' type workflow with a single worker which could still be either load-balanced via the exchange or targeted directly for subsequent requests.

The workflow used to produce a 'SelectionOutput' is this:

1) a job is submitted to the agora.api.exchange.Exchange 2) the job gets matched with some worker taking subscriptions. 3) we want to remember that worker, as well as proceed with executing the job from step 1

The SelectionOutput is the 'remembering' of that worker -- allowing us to submit using the same subscription (runner)

subscription: the subscription id of the remote runner
runner: the remote runner which will match a worker based on the subscription
uploader: an uploader which can be used to upload data to the worker represented by the runner
result: the result of the execution

Linear Supertypes

Serializable, Serializable, Product, Equals, UploadClient, FailFastCirceSupport, FailFastUnmarshaller, BaseCirceSupport, AnyRef, Any

Instance Constructors

new SelectionOutput(subscription: SubscriptionKey, location: HostLocation, runner: RemoteRunner, uploader: UploadClient, result: Future[RunProcessResult])

subscription
the subscription id of the remote runner
runner
the remote runner which will match a worker based on the subscription
uploader
an uploader which can be used to upload data to the worker represented by the runner
result
the result of the execution

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def client: RestClient

returns
the rest client used to upload

Definition Classes
SelectionOutput → UploadClient
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def deleteWorkspace(workspaceId: WorkspaceId): Future[Boolean]

Definition Classes
SelectionOutput → UploadClient
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

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

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

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

Definition Classes
BaseCirceSupport
val location: HostLocation
implicit final def marshaller[A](implicit arg0: Encoder[A], printer: Printer): ToEntityMarshaller[A]

Definition Classes
BaseCirceSupport
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val result: Future[RunProcessResult]

the result of the execution
val runner: RemoteRunner

the remote runner which will match a worker based on the subscription
val subscription: SubscriptionKey

the subscription id of the remote runner
final def synchronized[T0](arg0: ⇒ T0): T0

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

Definition Classes
FailFastUnmarshaller
def unmarshallerContentTypes: Seq[ContentTypeRange]

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

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
SelectionOutput → UploadClient
final def upload(workspaceId: WorkspaceId, file: Upload)(implicit mat: Materializer, timeout: FiniteDuration): Future[Boolean]

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
val uploader: UploadClient

an uploader which can be used to upload data to the worker represented by the runner
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package client

case class SelectionOutput(subscription: SubscriptionKey, location: HostLocation, runner: RemoteRunner, uploader: UploadClient, result: Future[RunProcessResult]) extends UploadClient with Product with Serializable

Instance Constructors

new SelectionOutput(subscription: SubscriptionKey, location: HostLocation, runner: RemoteRunner, uploader: UploadClient, result: Future[RunProcessResult])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def client: RestClient

def clone(): AnyRef

def deleteWorkspace(workspaceId: WorkspaceId): Future[Boolean]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

implicit final def jsonMarshaller(implicit printer: Printer): ToEntityMarshaller[Json]

implicit final val jsonUnmarshaller: FromEntityUnmarshaller[Json]

val location: HostLocation

implicit final def marshaller[A](implicit arg0: Encoder[A], printer: Printer): ToEntityMarshaller[A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val result: Future[RunProcessResult]

val runner: RemoteRunner

val subscription: SubscriptionKey

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

implicit final def unmarshaller[A](implicit arg0: Decoder[A]): FromEntityUnmarshaller[A]

def unmarshallerContentTypes: Seq[ContentTypeRange]

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

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

val uploader: UploadClient

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from UploadClient

Inherited from FailFastCirceSupport

Inherited from FailFastUnmarshaller

Inherited from BaseCirceSupport

Inherited from AnyRef

Inherited from Any

Ungrouped