SynapseServiceWSImpl

Instance Constructors

new SynapseServiceWSImpl(username: String, password: String, ws: WSClient, configuration: Configuration)

Annotations
@Inject()

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 clone(): AnyRef

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

Closes the connection
Closes the connection

Definition Classes
SynapseServiceWSImpl → SynapseService
def downloadColumnFile(tableId: String, columnId: String, rowId: Int, versionNumber: Int): Future[String]

Downloads a file associated with given column and row.
Downloads a file associated with given column and row.

Definition Classes
SynapseServiceWSImpl → SynapseService
def downloadFile(fileHandleId: String): Future[String]

Downloads a file by following a URL for a given file handle id.
Downloads a file by following a URL for a given file handle id. Only the person who created the FileHandle can download the file. To download column files use downloadColumnFile

Definition Classes
SynapseServiceWSImpl → SynapseService
See also
http://hud.rel.rest.doc.sagebase.org.s3-website-us-east-1.amazonaws.com/GET/fileHandle/handleId/url.html
def downloadFileAsBytes(fileHandleId: String): Future[ByteString]

Same as downloadFile but returns a byte array
Same as downloadFile but returns a byte array
Definition Classes SynapseServiceWSImpl → SynapseService
def downloadFilesInBulk(fileHandleAssociations: Traversable[FileHandleAssociation], attemptNum: Option[Int]): Future[Iterator[(String, String)]] Downloads files of custom types (file, table, attachment) for given handle assocations in a bulk by combining startBulkDownload, getBulkDownloadResultWait, and downloadFileAsBytes Downloads files of custom types (file, table, attachment) for given handle assocations in a bulk by combining startBulkDownload, getBulkDownloadResultWait, and downloadFileAsBytes Definition Classes SynapseServiceWSImpl → SynapseService
def downloadTableFilesInBulk(fileHandleIds: Traversable[String], tableId: String, attemptNum: Option[Int]): Future[Iterator[(String, String)]] Downloads table files for given handle ids in a bulk by combining startBulkDownload, getBulkDownloadResultWait, and downloadFileAsBytes Downloads table files for given handle ids in a bulk by combining startBulkDownload, getBulkDownloadResultWait, and downloadFileAsBytes Definition Classes SynapseServiceWSImpl → SynapseService
final def eq(arg0: AnyRef): Boolean Definition Classes AnyRef
def equals(arg0: Any): Boolean Definition Classes AnyRef → Any
def finalize(): Unit Attributes protected[java.lang] Definition Classes AnyRef Annotations @throws( classOf[java.lang.Throwable] )
def getBulkDownloadResult(jobToken: String): Future[Either[BulkFileDownloadResponse, AsynchronousJobStatus]] Returns a file handle of the resulting bulk download zip file Returns a file handle of the resulting bulk download zip file Definition Classes SynapseServiceWSImpl → SynapseService See also http://hud.rel.rest.doc.sagebase.org.s3-website-us-east-1.amazonaws.com/GET/file/bulk/async/get/asyncToken.html
def getBulkDownloadResultWait(jobToken: String): Future[BulkFileDownloadResponse] Gets the bulk results... Gets the bulk results... wait till it's done by polling Definition Classes SynapseServiceWSImpl → SynapseService
final def getClass(): Class[_] Definition Classes AnyRef → Any
def getCsvTableResult(tableId: String, jobToken: String): Future[Either[DownloadFromTableResult, AsynchronousJobStatus]] Gets results or a job status if still running Gets results or a job status if still running Definition Classes SynapseServiceWSImpl → SynapseService
def getCsvTableResultWait(tableId: String, jobToken: String): Future[DownloadFromTableResult] Gets results... Gets results... wait till it's done by polling Definition Classes SynapseServiceWSImpl → SynapseService
def getFileHandle(fileHandleId: String): Future[FileHandle] Gets a file handle Gets a file handle Definition Classes SynapseServiceWSImpl → SynapseService
def getTableAsCsv(tableId: String): Future[String] Gets a table as csv by combining runCsvTableQuery, getCsvTableResults, and downloadFile Gets a table as csv by combining runCsvTableQuery, getCsvTableResults, and downloadFile Definition Classes SynapseServiceWSImpl → SynapseService
def getTableColumnFileHandles(rowReferenceSet: RowReferenceSet): Future[TableFileHandleResults] Gets a list of file handles associated with the rows and columns specified in a row ref set Gets a list of file handles associated with the rows and columns specified in a row ref set Definition Classes SynapseServiceWSImpl → SynapseService
def getTableColumnModels(tableId: String): Future[PaginatedColumnModels] Gets the column models of a given table Gets the column models of a given table Definition Classes SynapseServiceWSImpl → SynapseService
def hashCode(): Int Definition Classes AnyRef → Any
final def isInstanceOf[T0]: Boolean Definition Classes Any
def login: Future[Unit] (Re)logins and refreshes a session token (Re)logins and refreshes a session token Definition Classes SynapseServiceWSImpl → SynapseService
final def ne(arg0: AnyRef): Boolean Definition Classes AnyRef
final def notify(): Unit Definition Classes AnyRef
final def notifyAll(): Unit Definition Classes AnyRef
def prolongSession: Future[Unit] Prolonges a current session token for another 24 hours Prolonges a current session token for another 24 hours Definition Classes SynapseServiceWSImpl → SynapseService
def startBulkDownload(data: BulkFileDownloadRequest): Future[String] Initiates a downlaod of multiple filed... Initiates a downlaod of multiple filed... returns a token for polling Definition Classes SynapseServiceWSImpl → SynapseService See also http://hud.rel.rest.doc.sagebase.org.s3-website-us-east-1.amazonaws.com/POST/file/bulk/async/start.html
def startCsvTableQuery(tableId: String, sql: String): Future[String] .Runs a table query and returns a token .Runs a table query and returns a token Definition Classes SynapseServiceWSImpl → SynapseService
final def synchronized[T0](arg0: ⇒ T0): T0 Definition Classes AnyRef
def toString(): String Definition Classes AnyRef → Any
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( ... )
def withJsonContent(request: WSRequest): WSRequest
def withRequestTimeout(timeout: Duration)(request: WSRequest): WSRequest
def withSessionToken(request: WSRequest): WSRequest



        
        
              Inherited from SynapseService
            

              Inherited from AnyRef
            

              Inherited from Any
            
        
        

        
        
              Ungrouped

Related Doc: package importers

class SynapseServiceWSImpl extends SynapseService

Instance Constructors

new SynapseServiceWSImpl(username: String, password: String, ws: WSClient, configuration: Configuration)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close: Unit

def downloadColumnFile(tableId: String, columnId: String, rowId: Int, versionNumber: Int): Future[String]

def downloadFile(fileHandleId: String): Future[String]

def downloadFileAsBytes(fileHandleId: String): Future[ByteString]

def downloadFilesInBulk(fileHandleAssociations: Traversable[FileHandleAssociation], attemptNum: Option[Int]): Future[Iterator[(String, String)]]

def downloadTableFilesInBulk(fileHandleIds: Traversable[String], tableId: String, attemptNum: Option[Int]): Future[Iterator[(String, String)]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def getBulkDownloadResult(jobToken: String): Future[Either[BulkFileDownloadResponse, AsynchronousJobStatus]]

def getBulkDownloadResultWait(jobToken: String): Future[BulkFileDownloadResponse]

final def getClass(): Class[_]

def getCsvTableResult(tableId: String, jobToken: String): Future[Either[DownloadFromTableResult, AsynchronousJobStatus]]

def getCsvTableResultWait(tableId: String, jobToken: String): Future[DownloadFromTableResult]

def getFileHandle(fileHandleId: String): Future[FileHandle]

def getTableAsCsv(tableId: String): Future[String]

def getTableColumnFileHandles(rowReferenceSet: RowReferenceSet): Future[TableFileHandleResults]

def getTableColumnModels(tableId: String): Future[PaginatedColumnModels]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def login: Future[Unit]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def prolongSession: Future[Unit]

def startBulkDownload(data: BulkFileDownloadRequest): Future[String]

def startCsvTableQuery(tableId: String, sql: String): Future[String]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withJsonContent(request: WSRequest): WSRequest

def withRequestTimeout(timeout: Duration)(request: WSRequest): WSRequest

def withSessionToken(request: WSRequest): WSRequest

Inherited from SynapseService

Inherited from AnyRef

Inherited from Any

Ungrouped