Module org.yamcs.api

Package org.yamcs.protobuf

Class FileTransferApiClient

java.lang.Object

org.yamcs.protobuf.AbstractFileTransferApi<Void>

org.yamcs.protobuf.FileTransferApiClient

All Implemented Interfaces:

Api<Void>

@Generated(value="org.yamcs.maven.ServiceGenerator",
           date="2026-08-05T11:34:19.222730815Z")
public class FileTransferApiClient
extends AbstractFileTransferApi<Void>

  This API deals with transmission (upload and download) of file to and from spacecraft.
 
  The API can be used to interface any implementation of the FileTransferService.
  One such implementation is for the CFDP (CCSDS File Delivery Protocol).
 

Constructor Summary

Constructors

Constructor	Description
FileTransferApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
final void	cancelTransfer(Void ctx, CancelTransferRequest request, Observer<com.google.protobuf.Empty> observer)	Cancel a transfer The ongoing transfer is aborted, partially uploaded/downloaded files are retained.
final void	createTransfer(Void ctx, CreateTransferRequest request, Observer<TransferInfo> observer)	Create a transfer
final void	fetchFileList(Void ctx, ListFilesRequest request, Observer<com.google.protobuf.Empty> observer)	Request file list from remote
final void	getFileList(Void ctx, ListFilesRequest request, Observer<ListFilesResponse> observer)	Get latest file list
final void	getFileTransferService(Void ctx, GetFileTransferServiceRequest request, Observer<FileTransferServiceInfo> observer)	Get a file transfer service
final void	getTransfer(Void ctx, GetTransferRequest request, Observer<TransferInfo> observer)	Get a transfer
final void	listFileTransferServices(Void ctx, ListFileTransferServicesRequest request, Observer<ListFileTransferServicesResponse> observer)	List file transfer services
final void	listTransfers(Void ctx, ListTransfersRequest request, Observer<ListTransfersResponse> observer)	List transfers
final void	pauseTransfer(Void ctx, PauseTransferRequest request, Observer<com.google.protobuf.Empty> observer)	Pause a transfer
final void	resumeTransfer(Void ctx, ResumeTransferRequest request, Observer<com.google.protobuf.Empty> observer)	Resume a transfer
final void	runFileAction(Void ctx, RunFileActionRequest request, Observer<com.google.protobuf.Struct> observer)	Run a file-specific action.
final void	subscribeRemoteFileList(Void ctx, SubscribeTransfersRequest request, Observer<ListFilesResponse> observer)	Subscribe to remote file list updates
final void	subscribeTransfers(Void ctx, SubscribeTransfersRequest request, Observer<TransferInfo> observer)	Subscribe to transfer updates

Methods inherited from class org.yamcs.protobuf.AbstractFileTransferApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

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

Constructor Details

FileTransferApiClient

public FileTransferApiClient(MethodHandler handler)

Method Details

listFileTransferServices

public final void listFileTransferServices(Void ctx,
 ListFileTransferServicesRequest request,
 Observer<ListFileTransferServicesResponse> observer)

  List file transfer services
 

Specified by:

listFileTransferServices in class AbstractFileTransferApi<Void>

getFileTransferService

public final void getFileTransferService(Void ctx,
 GetFileTransferServiceRequest request,
 Observer<FileTransferServiceInfo> observer)

  Get a file transfer service
 

Specified by:

getFileTransferService in class AbstractFileTransferApi<Void>

listTransfers

public final void listTransfers(Void ctx,
 ListTransfersRequest request,
 Observer<ListTransfersResponse> observer)

  List transfers
 

Specified by:

listTransfers in class AbstractFileTransferApi<Void>

getTransfer

public final void getTransfer(Void ctx,
 GetTransferRequest request,
 Observer<TransferInfo> observer)

  Get a transfer
 

Specified by:

getTransfer in class AbstractFileTransferApi<Void>

createTransfer

public final void createTransfer(Void ctx,
 CreateTransferRequest request,
 Observer<TransferInfo> observer)

  Create a transfer
 

Specified by:

createTransfer in class AbstractFileTransferApi<Void>

pauseTransfer

public final void pauseTransfer(Void ctx,
 PauseTransferRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Pause a transfer
 

Specified by:

pauseTransfer in class AbstractFileTransferApi<Void>

cancelTransfer

public final void cancelTransfer(Void ctx,
 CancelTransferRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Cancel a transfer
 
  The ongoing transfer is aborted, partially uploaded/downloaded files
  are retained.
 

Specified by:

cancelTransfer in class AbstractFileTransferApi<Void>

resumeTransfer

public final void resumeTransfer(Void ctx,
 ResumeTransferRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Resume a transfer
 

Specified by:

resumeTransfer in class AbstractFileTransferApi<Void>

subscribeTransfers

public final void subscribeTransfers(Void ctx,
 SubscribeTransfersRequest request,
 Observer<TransferInfo> observer)

  Subscribe to transfer updates
 

Specified by:

subscribeTransfers in class AbstractFileTransferApi<Void>

subscribeRemoteFileList

public final void subscribeRemoteFileList(Void ctx,
 SubscribeTransfersRequest request,
 Observer<ListFilesResponse> observer)

  Subscribe to remote file list updates
 

Specified by:

subscribeRemoteFileList in class AbstractFileTransferApi<Void>

fetchFileList

public final void fetchFileList(Void ctx,
 ListFilesRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Request file list from remote
 

Specified by:

fetchFileList in class AbstractFileTransferApi<Void>

getFileList

public final void getFileList(Void ctx,
 ListFilesRequest request,
 Observer<ListFilesResponse> observer)

  Get latest file list
 

Specified by:

getFileList in class AbstractFileTransferApi<Void>

runFileAction

public final void runFileAction(Void ctx,
 RunFileActionRequest request,
 Observer<com.google.protobuf.Struct> observer)

  Run a file-specific action.
 
  Available actions are specific to the File Transfer implementation.
 

Specified by:

runFileAction in class AbstractFileTransferApi<Void>