Package org.yamcs.client.filetransfer

Class FileTransferClient

java.lang.Object

org.yamcs.client.filetransfer.FileTransferClient

public class FileTransferClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileTransferClient.UploadOptions

Constructor Summary

Constructors

Constructor	Description
FileTransferClient(YamcsClient baseClient, String instance, String serviceName)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	cancel(long id)	Cancel an on-going file transfer
CompletableFuture<TransferInfo>	download(String remotePath, ObjectId target)	Initiate file download
String	getInstance()
CompletableFuture<TransferInfo>	getTransfer(long id)
CompletableFuture<List<TransferInfo>>	listTransfers()	List the on-going file transfers
CompletableFuture<Void>	pause(long id)	Pause an on-going file transfer
CompletableFuture<Void>	resume(long id)	Resume an on-going file transfer
CompletableFuture<TransferInfo>	upload(ObjectId source, String remotePath, FileTransferClient.UploadOptions.UploadOption... options)	Initiate file upload
CompletableFuture<TransferInfo>	upload(ObjectId source, FileTransferClient.UploadOptions.UploadOption... options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileTransferClient

public FileTransferClient(YamcsClient baseClient,
                          String instance,
                          String serviceName)

Method Detail

getInstance

public String getInstance()

listTransfers

public CompletableFuture<List<TransferInfo>> listTransfers()

List the on-going file transfers

Returns:

getTransfer

public CompletableFuture<TransferInfo> getTransfer(long id)

upload

public CompletableFuture<TransferInfo> upload(ObjectId source,
                                              FileTransferClient.UploadOptions.UploadOption... options)

upload

public CompletableFuture<TransferInfo> upload(ObjectId source,
                                              String remotePath,
                                              FileTransferClient.UploadOptions.UploadOption... options)

Initiate file upload

download

public CompletableFuture<TransferInfo> download(String remotePath,
                                                ObjectId target)

Initiate file download

pause

public CompletableFuture<Void> pause(long id)

Pause an on-going file transfer

resume

public CompletableFuture<Void> resume(long id)

Resume an on-going file transfer

cancel

public CompletableFuture<Void> cancel(long id)

Cancel an on-going file transfer