SynapseService

Abstract Value Members

1. abstract def close: Unit

   

   Closes the connection

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

   

   Downloads a file associated with given column and row.

3. abstract 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

   See also

   http://hud.rel.rest.doc.sagebase.org.s3-website-us-east-1.amazonaws.com/GET/fileHandle/handleId/url.html

4. abstract def downloadFileAsBytes(fileHandleId: String): Future[ByteString]

   

   Same as downloadFile but returns a byte array

   Same as downloadFile but returns a byte array

5. abstract def downloadFilesInBulk(fileHandleAssociations: Traversable[FileHandleAssociation], attemptNum: Option[Int] = None): 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

6. abstract def downloadTableFilesInBulk(fileHandleIds: Traversable[String], tableId: String, attemptNum: Option[Int] = None): Future[Iterator[(String, String)]]

   

   Downloads table files for given handle ids in a bulk by combining startBulkDownload, getBulkDownloadResultWait, and downloadFileAsBytes

7. abstract 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

   See also

   http://hud.rel.rest.doc.sagebase.org.s3-website-us-east-1.amazonaws.com/GET/file/bulk/async/get/asyncToken.html

8. abstract def getBulkDownloadResultWait(jobToken: String): Future[BulkFileDownloadResponse]

   

   Gets the bulk results...

   Gets the bulk results... wait till it's done by polling

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

   

   Gets results or a job status if still running

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

    

    Gets results...

    Gets results... wait till it's done by polling

11. abstract def getFileHandle(fileHandleId: String): Future[FileHandle]

    

    Gets a file handle

12. abstract def getTableAsCsv(tableId: String): Future[String]

    

    Gets a table as csv by combining runCsvTableQuery, getCsvTableResults, and downloadFile

13. abstract def getTableColumnFileHandles(rowReferenceSet: RowReferenceSet): Future[TableFileHandleResults]

    

    Gets a list of file handles associated with the rows and columns specified in a row ref set

14. abstract def getTableColumnModels(tableId: String): Future[PaginatedColumnModels]

    

    Gets the column models of a given table

15. abstract def login: Future[Unit]

    

    (Re)logins and refreshes a session token

16. abstract def prolongSession: Future[Unit]

    

    Prolonges a current session token for another 24 hours

17. abstract def startBulkDownload(data: BulkFileDownloadRequest): Future[String]

    

    Initiates a downlaod of multiple filed...

    Initiates a downlaod of multiple filed... returns a token for polling

    See also

    http://hud.rel.rest.doc.sagebase.org.s3-website-us-east-1.amazonaws.com/POST/file/bulk/async/start.html

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

    

    .Runs a table query and returns a token