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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getBucket()
**Required** The bucket containing the local Yamcs object.com.google.protobuf.ByteString
getBucketBytes()
**Required** The bucket containing the local Yamcs object.String
getDestination()
used to derive the destination entity idcom.google.protobuf.ByteString
getDestinationBytes()
used to derive the destination entity idTransferDirection
getDirection()
**Required** One of ``UPLOAD`` or ``DOWNLOAD``.CreateTransferRequest.DownloadOptions
getDownloadOptions()
optional .yamcs.protobuf.cfdp.CreateTransferRequest.DownloadOptions downloadOptions = 6;
CreateTransferRequest.DownloadOptionsOrBuilder
getDownloadOptionsOrBuilder()
optional .yamcs.protobuf.cfdp.CreateTransferRequest.DownloadOptions downloadOptions = 6;
String
getInstance()
optional string instance = 1;
com.google.protobuf.ByteString
getInstanceBytes()
optional string instance = 1;
String
getObjectName()
**Required** The object name in Yamcs bucket storage.com.google.protobuf.ByteString
getObjectNameBytes()
**Required** The object name in Yamcs bucket storage.String
getRemotePath()
**Required** The path at the remote CFDP entity.com.google.protobuf.ByteString
getRemotePathBytes()
**Required** The path at the remote CFDP entity.String
getServiceName()
CFDP service namecom.google.protobuf.ByteString
getServiceNameBytes()
CFDP service nameString
getSource()
used to derive the source entity idcom.google.protobuf.ByteString
getSourceBytes()
used to derive the source entity idCreateTransferRequest.UploadOptions
getUploadOptions()
Configuration options specific to ``UPLOAD`` transfers.CreateTransferRequest.UploadOptionsOrBuilder
getUploadOptionsOrBuilder()
Configuration options specific to ``UPLOAD`` transfers.boolean
hasBucket()
**Required** The bucket containing the local Yamcs object.boolean
hasDestination()
used to derive the destination entity idboolean
hasDirection()
**Required** One of ``UPLOAD`` or ``DOWNLOAD``.boolean
hasDownloadOptions()
optional .yamcs.protobuf.cfdp.CreateTransferRequest.DownloadOptions downloadOptions = 6;
boolean
hasInstance()
optional string instance = 1;
boolean
hasObjectName()
**Required** The object name in Yamcs bucket storage.boolean
hasRemotePath()
**Required** The path at the remote CFDP entity.boolean
hasServiceName()
CFDP service nameboolean
hasSource()
used to derive the source entity idboolean
hasUploadOptions()
Configuration options specific to ``UPLOAD`` transfers.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
hasInstance
boolean hasInstance()
optional string instance = 1;
-
getInstance
String getInstance()
optional string instance = 1;
-
getInstanceBytes
com.google.protobuf.ByteString getInstanceBytes()
optional string instance = 1;
-
hasServiceName
boolean hasServiceName()
CFDP service name
optional string serviceName = 8;
-
getServiceName
String getServiceName()
CFDP service name
optional string serviceName = 8;
-
getServiceNameBytes
com.google.protobuf.ByteString getServiceNameBytes()
CFDP service name
optional string serviceName = 8;
-
hasDirection
boolean hasDirection()
**Required** One of ``UPLOAD`` or ``DOWNLOAD``.
optional .yamcs.protobuf.cfdp.TransferDirection direction = 2;
-
getDirection
TransferDirection getDirection()
**Required** One of ``UPLOAD`` or ``DOWNLOAD``.
optional .yamcs.protobuf.cfdp.TransferDirection direction = 2;
-
hasBucket
boolean hasBucket()
**Required** The bucket containing the local Yamcs object.
optional string bucket = 3;
-
getBucket
String getBucket()
**Required** The bucket containing the local Yamcs object.
optional string bucket = 3;
-
getBucketBytes
com.google.protobuf.ByteString getBucketBytes()
**Required** The bucket containing the local Yamcs object.
optional string bucket = 3;
-
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 CFDP entity. For DOWNLOAD transfers, it refers to the object that Yamcs will write to when downloading from a remote CFDP entity.
optional string objectName = 4;
-
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 CFDP entity. For DOWNLOAD transfers, it refers to the object that Yamcs will write to when downloading from a remote CFDP entity.
optional string objectName = 4;
-
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 CFDP entity. For DOWNLOAD transfers, it refers to the object that Yamcs will write to when downloading from a remote CFDP entity.
optional string objectName = 4;
-
hasRemotePath
boolean hasRemotePath()
**Required** The path at the remote CFDP entity. Example: ``a/local/path/some_filename``.
optional string remotePath = 5;
-
getRemotePath
String getRemotePath()
**Required** The path at the remote CFDP entity. Example: ``a/local/path/some_filename``.
optional string remotePath = 5;
-
getRemotePathBytes
com.google.protobuf.ByteString getRemotePathBytes()
**Required** The path at the remote CFDP entity. Example: ``a/local/path/some_filename``.
optional string remotePath = 5;
-
hasDownloadOptions
boolean hasDownloadOptions()
optional .yamcs.protobuf.cfdp.CreateTransferRequest.DownloadOptions downloadOptions = 6;
-
getDownloadOptions
CreateTransferRequest.DownloadOptions getDownloadOptions()
optional .yamcs.protobuf.cfdp.CreateTransferRequest.DownloadOptions downloadOptions = 6;
-
getDownloadOptionsOrBuilder
CreateTransferRequest.DownloadOptionsOrBuilder getDownloadOptionsOrBuilder()
optional .yamcs.protobuf.cfdp.CreateTransferRequest.DownloadOptions downloadOptions = 6;
-
hasUploadOptions
boolean hasUploadOptions()
Configuration options specific to ``UPLOAD`` transfers.
optional .yamcs.protobuf.cfdp.CreateTransferRequest.UploadOptions uploadOptions = 7;
-
getUploadOptions
CreateTransferRequest.UploadOptions getUploadOptions()
Configuration options specific to ``UPLOAD`` transfers.
optional .yamcs.protobuf.cfdp.CreateTransferRequest.UploadOptions uploadOptions = 7;
-
getUploadOptionsOrBuilder
CreateTransferRequest.UploadOptionsOrBuilder getUploadOptionsOrBuilder()
Configuration options specific to ``UPLOAD`` transfers.
optional .yamcs.protobuf.cfdp.CreateTransferRequest.UploadOptions uploadOptions = 7;
-
hasSource
boolean hasSource()
used to derive the source entity id
optional string source = 9;
-
getSource
String getSource()
used to derive the source entity id
optional string source = 9;
-
getSourceBytes
com.google.protobuf.ByteString getSourceBytes()
used to derive the source entity id
optional string source = 9;
-
hasDestination
boolean hasDestination()
used to derive the destination entity id
optional string destination = 10;
-
getDestination
String getDestination()
used to derive the destination entity id
optional string destination = 10;
-
getDestinationBytes
com.google.protobuf.ByteString getDestinationBytes()
used to derive the destination entity id
optional string destination = 10;
-
-