org.yamcs.protobuf.FileTransferCapabilitiesOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/protobuf/filetransfer/filetransfer.proto

package org.yamcs.protobuf;

public interface FileTransferCapabilitiesOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.filetransfer.FileTransferCapabilities)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Whether the transfer service supports uploads
   * 
   *
   * optional bool upload = 1;
   * @return Whether the upload field is set.
   */
  boolean hasUpload();
  /**
   *    * Whether the transfer service supports uploads
   * 
   *
   * optional bool upload = 1;
   * @return The upload.
   */
  boolean getUpload();

  /**
   *    * Whether the transfer service supports downloads
   * 
   *
   * optional bool download = 2;
   * @return Whether the download field is set.
   */
  boolean hasDownload();
  /**
   *    * Whether the transfer service supports downloads
   * 
   *
   * optional bool download = 2;
   * @return The download.
   */
  boolean getDownload();

  /**
   *    * Whether the transfer service supports specifying an upload path
   * 
   *
   * optional bool remotePath = 4;
   * @return Whether the remotePath field is set.
   */
  boolean hasRemotePath();
  /**
   *    * Whether the transfer service supports specifying an upload path
   * 
   *
   * optional bool remotePath = 4;
   * @return The remotePath.
   */
  boolean getRemotePath();

  /**
   *    * Whether the transfer service supports remote file listings
   * 
   *
   * optional bool fileList = 5;
   * @return Whether the fileList field is set.
   */
  boolean hasFileList();
  /**
   *    * Whether the transfer service supports remote file listings
   * 
   *
   * optional bool fileList = 5;
   * @return The fileList.
   */
  boolean getFileList();

  /**
   *    * Whether transfers contain a column describing the Transfer Type
   * 
   *
   * optional bool hasTransferType = 6;
   * @return Whether the hasTransferType field is set.
   */
  boolean hasHasTransferType();
  /**
   *    * Whether transfers contain a column describing the Transfer Type
   * 
   *
   * optional bool hasTransferType = 6;
   * @return The hasTransferType.
   */
  boolean getHasTransferType();

  /**
   *    * Whether the transfer service supports pause/resume
   * 
   *
   * optional bool pauseResume = 9;
   * @return Whether the pauseResume field is set.
   */
  boolean hasPauseResume();
  /**
   *    * Whether the transfer service supports pause/resume
   * 
   *
   * optional bool pauseResume = 9;
   * @return The pauseResume.
   */
  boolean getPauseResume();

  /**
   *    * Additional columns to show in a file listing, where id
   * is a key of ``RemoteFile.extra``
   * 
   *
   * repeated .yamcs.protobuf.filetransfer.ExtraColumnInfo fileListExtraColumns = 7;
   */
  java.util.List 
      getFileListExtraColumnsList();
  /**
   *    * Additional columns to show in a file listing, where id
   * is a key of ``RemoteFile.extra``
   * 
   *
   * repeated .yamcs.protobuf.filetransfer.ExtraColumnInfo fileListExtraColumns = 7;
   */
  org.yamcs.protobuf.ExtraColumnInfo getFileListExtraColumns(int index);
  /**
   *    * Additional columns to show in a file listing, where id
   * is a key of ``RemoteFile.extra``
   * 
   *
   * repeated .yamcs.protobuf.filetransfer.ExtraColumnInfo fileListExtraColumns = 7;
   */
  int getFileListExtraColumnsCount();
  /**
   *    * Additional columns to show in a file listing, where id
   * is a key of ``RemoteFile.extra``
   * 
   *
   * repeated .yamcs.protobuf.filetransfer.ExtraColumnInfo fileListExtraColumns = 7;
   */
  java.util.List 
      getFileListExtraColumnsOrBuilderList();
  /**
   *    * Additional columns to show in a file listing, where id
   * is a key of ``RemoteFile.extra``
   * 
   *
   * repeated .yamcs.protobuf.filetransfer.ExtraColumnInfo fileListExtraColumns = 7;
   */
  org.yamcs.protobuf.ExtraColumnInfoOrBuilder getFileListExtraColumnsOrBuilder(
      int index);

  /**
   *    * Additional actions that may be executed on remote files
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo fileActions = 8;
   */
  java.util.List 
      getFileActionsList();
  /**
   *    * Additional actions that may be executed on remote files
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo fileActions = 8;
   */
  org.yamcs.protobuf.actions.ActionInfo getFileActions(int index);
  /**
   *    * Additional actions that may be executed on remote files
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo fileActions = 8;
   */
  int getFileActionsCount();
  /**
   *    * Additional actions that may be executed on remote files
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo fileActions = 8;
   */
  java.util.List 
      getFileActionsOrBuilderList();
  /**
   *    * Additional actions that may be executed on remote files
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo fileActions = 8;
   */
  org.yamcs.protobuf.actions.ActionInfoOrBuilder getFileActionsOrBuilder(
      int index);
}