org.yamcs.protobuf.CreateTransferRequestOrBuilder 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 CreateTransferRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.filetransfer.CreateTransferRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return Whether the instance field is set.
   */
  boolean hasInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return The instance.
   */
  java.lang.String getInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return The bytes for instance.
   */
  com.google.protobuf.ByteString
      getInstanceBytes();

  /**
   *    * File transfer service name
   * 
   *
   * optional string serviceName = 8;
   * @return Whether the serviceName field is set.
   */
  boolean hasServiceName();
  /**
   *    * File transfer service name
   * 
   *
   * optional string serviceName = 8;
   * @return The serviceName.
   */
  java.lang.String getServiceName();
  /**
   *    * File transfer service name
   * 
   *
   * optional string serviceName = 8;
   * @return The bytes for serviceName.
   */
  com.google.protobuf.ByteString
      getServiceNameBytes();

  /**
   *    * **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
   * 
   *
   * optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;
   * @return Whether the direction field is set.
   */
  boolean hasDirection();
  /**
   *    * **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
   * 
   *
   * optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;
   * @return The direction.
   */
  org.yamcs.protobuf.TransferDirection getDirection();

  /**
   *    * **Required** The bucket containing the local Yamcs object.
   * 
   *
   * optional string bucket = 3;
   * @return Whether the bucket field is set.
   */
  boolean hasBucket();
  /**
   *    * **Required** The bucket containing the local Yamcs object.
   * 
   *
   * optional string bucket = 3;
   * @return The bucket.
   */
  java.lang.String getBucket();
  /**
   *    * **Required** The bucket containing the local Yamcs object.
   * 
   *
   * optional string bucket = 3;
   * @return The bytes for bucket.
   */
  com.google.protobuf.ByteString
      getBucketBytes();

  /**
   *    * **Required** The object name in Yamcs bucket storage. For UPLOAD transfers,
   * this object must exist and is what Yamcs will transfer to the remote
   * entity. For DOWNLOAD transfers, it refers to the object that
   * Yamcs will write to when downloading from a remote entity.
   * 
   *
   * optional string objectName = 4;
   * @return Whether the objectName field is set.
   */
  boolean hasObjectName();
  /**
   *    * **Required** The object name in Yamcs bucket storage. For UPLOAD transfers,
   * this object must exist and is what Yamcs will transfer to the remote
   * entity. For DOWNLOAD transfers, it refers to the object that
   * Yamcs will write to when downloading from a remote entity.
   * 
   *
   * optional string objectName = 4;
   * @return The objectName.
   */
  java.lang.String getObjectName();
  /**
   *    * **Required** The object name in Yamcs bucket storage. For UPLOAD transfers,
   * this object must exist and is what Yamcs will transfer to the remote
   * entity. For DOWNLOAD transfers, it refers to the object that
   * Yamcs will write to when downloading from a remote entity.
   * 
   *
   * optional string objectName = 4;
   * @return The bytes for objectName.
   */
  com.google.protobuf.ByteString
      getObjectNameBytes();

  /**
   *    * **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
   * 
   *
   * optional string remotePath = 5;
   * @return Whether the remotePath field is set.
   */
  boolean hasRemotePath();
  /**
   *    * **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
   * 
   *
   * optional string remotePath = 5;
   * @return The remotePath.
   */
  java.lang.String getRemotePath();
  /**
   *    * **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
   * 
   *
   * optional string remotePath = 5;
   * @return The bytes for remotePath.
   */
  com.google.protobuf.ByteString
      getRemotePathBytes();

  /**
   *    *used to derive the source entity id
   * 
   *
   * optional string source = 9;
   * @return Whether the source field is set.
   */
  boolean hasSource();
  /**
   *    *used to derive the source entity id
   * 
   *
   * optional string source = 9;
   * @return The source.
   */
  java.lang.String getSource();
  /**
   *    *used to derive the source entity id
   * 
   *
   * optional string source = 9;
   * @return The bytes for source.
   */
  com.google.protobuf.ByteString
      getSourceBytes();

  /**
   *    *used to derive the destination entity id
   * 
   *
   * optional string destination = 10;
   * @return Whether the destination field is set.
   */
  boolean hasDestination();
  /**
   *    *used to derive the destination entity id
   * 
   *
   * optional string destination = 10;
   * @return The destination.
   */
  java.lang.String getDestination();
  /**
   *    *used to derive the destination entity id
   * 
   *
   * optional string destination = 10;
   * @return The bytes for destination.
   */
  com.google.protobuf.ByteString
      getDestinationBytes();

  /**
   *    * Options for the transfer
   * 
   *
   * optional .google.protobuf.Struct options = 11;
   * @return Whether the options field is set.
   */
  boolean hasOptions();
  /**
   *    * Options for the transfer
   * 
   *
   * optional .google.protobuf.Struct options = 11;
   * @return The options.
   */
  com.google.protobuf.Struct getOptions();
  /**
   *    * Options for the transfer
   * 
   *
   * optional .google.protobuf.Struct options = 11;
   */
  com.google.protobuf.StructOrBuilder getOptionsOrBuilder();
}