Subscribe Remote File List¶

interface SubscribeTransfersRequest {

  // Yamcs instance name
  instance: string;

  // File transfer service name
  serviceName: string;

  // If true, send info on all currently ongoing transfers,
  // as well as any future updates (recommended).
  //
  // For legacy reasons, the default is ``false``, which will
  // send also finished transfers upon subscription. This behaviour
  // is due for removal in a future release (if you want to receive
  // past transfers, do a GET request).
  ongoingOnly: boolean;
}

interface ListFilesResponse {
  files: RemoteFile[];
  destination: string;
  remotePath: string;
  listTime: string;  // RFC 3339 timestamp
  state: string;

  // Progress message, in case the file listing is still underway
  progressMessage: string;
}

interface RemoteFile {

  // File identifier
  //
  // Typically, a remote file path, or a filename
  // in case of a flat file table.
  name: string;

  // Optional display name. Can be used when the ``name``
  // field contains information that should be hidden from the user.
  displayName: string;

  // True if the path represents a directory
  isDirectory: boolean;

  // File size
  size: string;  // String decimal

  // Modification time
  modified: string;  // RFC 3339 timestamp

  // Implementation-specific fields
  extra: {[key: string]: any};
}