Module org.yamcs.api
Package org.yamcs.protobuf

Interface CreateTransferRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CreateTransferRequest, CreateTransferRequest.Builder
public interface CreateTransferRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasInstance

      boolean hasInstance()
      optional string instance = 1;
      Returns:
      Whether the instance field is set.

    • getInstance

      String getInstance()
      optional string instance = 1;
      Returns:
      The instance.

    • getInstanceBytes

      com.google.protobuf.ByteString getInstanceBytes()
      optional string instance = 1;
      Returns:
      The bytes for instance.

    • hasServiceName

      boolean hasServiceName()
      service name
      optional string serviceName = 8;
      Returns:
      Whether the serviceName field is set.

    • getServiceName

      String getServiceName()
      service name
      optional string serviceName = 8;
      Returns:
      The serviceName.

    • getServiceNameBytes

      com.google.protobuf.ByteString getServiceNameBytes()
      service name
      optional string serviceName = 8;
      Returns:
      The bytes for serviceName.

    • hasDirection

      boolean hasDirection()
       **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
      optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;
      Returns:
      Whether the direction field is set.

    • getDirection

      TransferDirection getDirection()
       **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
      optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;
      Returns:
      The direction.

    • hasBucket

      boolean hasBucket()
       **Required** The bucket containing the local Yamcs object.
      optional string bucket = 3;
      Returns:
      Whether the bucket field is set.

    • getBucket

      String getBucket()
       **Required** The bucket containing the local Yamcs object.
      optional string bucket = 3;
      Returns:
      The bucket.

    • getBucketBytes

      com.google.protobuf.ByteString getBucketBytes()
       **Required** The bucket containing the local Yamcs object.
      optional string bucket = 3;
      Returns:
      The bytes for bucket.

    • hasObjectName

      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;
      Returns:
      Whether the objectName field is set.

    • getObjectName

      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;
      Returns:
      The objectName.

    • getObjectNameBytes

      com.google.protobuf.ByteString getObjectNameBytes()
       **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;
      Returns:
      The bytes for objectName.

    • hasRemotePath

      boolean hasRemotePath()
       **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
      optional string remotePath = 5;
      Returns:
      Whether the remotePath field is set.

    • getRemotePath

      String getRemotePath()
       **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
      optional string remotePath = 5;
      Returns:
      The remotePath.

    • getRemotePathBytes

      com.google.protobuf.ByteString getRemotePathBytes()
       **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
      optional string remotePath = 5;
      Returns:
      The bytes for remotePath.

    • hasDownloadOptions

      boolean hasDownloadOptions()
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;
      Returns:
      Whether the downloadOptions field is set.

    • getDownloadOptions

      CreateTransferRequest.DownloadOptions getDownloadOptions()
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;
      Returns:
      The downloadOptions.

    • getDownloadOptionsOrBuilder

      CreateTransferRequest.DownloadOptionsOrBuilder getDownloadOptionsOrBuilder()
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;

    • hasUploadOptions

      boolean hasUploadOptions()
       Configuration options specific to ``UPLOAD`` transfers.
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.UploadOptions uploadOptions = 7;
      Returns:
      Whether the uploadOptions field is set.

    • getUploadOptions

      CreateTransferRequest.UploadOptions getUploadOptions()
       Configuration options specific to ``UPLOAD`` transfers.
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.UploadOptions uploadOptions = 7;
      Returns:
      The uploadOptions.

    • getUploadOptionsOrBuilder

      CreateTransferRequest.UploadOptionsOrBuilder getUploadOptionsOrBuilder()
       Configuration options specific to ``UPLOAD`` transfers.
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.UploadOptions uploadOptions = 7;

    • hasSource

      boolean hasSource()
      used to derive the source entity id
      optional string source = 9;
      Returns:
      Whether the source field is set.

    • getSource

      String getSource()
      used to derive the source entity id
      optional string source = 9;
      Returns:
      The source.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes()
      used to derive the source entity id
      optional string source = 9;
      Returns:
      The bytes for source.

    • hasDestination

      boolean hasDestination()
      used to derive the destination entity id
      optional string destination = 10;
      Returns:
      Whether the destination field is set.

    • getDestination

      String getDestination()
      used to derive the destination entity id
      optional string destination = 10;
      Returns:
      The destination.

    • getDestinationBytes

      com.google.protobuf.ByteString getDestinationBytes()
      used to derive the destination entity id
      optional string destination = 10;
      Returns:
      The bytes for destination.