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

    Modifier and Type
    Method
    Description
    **Required** The bucket containing the local Yamcs object.
    com.google.protobuf.ByteString
    **Required** The bucket containing the local Yamcs object.
    used to derive the destination entity id
    com.google.protobuf.ByteString
    used to derive the destination entity id
    **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
    Yamcs instance name
    com.google.protobuf.ByteString
    Yamcs instance name
    **Required** The object name in Yamcs bucket storage.
    com.google.protobuf.ByteString
    **Required** The object name in Yamcs bucket storage.
    com.google.protobuf.Struct
    Options for the transfer
    com.google.protobuf.StructOrBuilder
    Options for the transfer
    **Required** The path at the remote entity.
    com.google.protobuf.ByteString
    **Required** The path at the remote entity.
    File transfer service name
    com.google.protobuf.ByteString
    File transfer service name
    used to derive the source entity id
    com.google.protobuf.ByteString
    used to derive the source entity id
    boolean
    **Required** The bucket containing the local Yamcs object.
    boolean
    used to derive the destination entity id
    boolean
    **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
    boolean
    Yamcs instance name
    boolean
    **Required** The object name in Yamcs bucket storage.
    boolean
    Options for the transfer
    boolean
    **Required** The path at the remote entity.
    boolean
    File transfer service name
    boolean
    used to derive the source entity id

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • hasInstance

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

      String getInstance()
       Yamcs instance name
       
      optional string instance = 1;
      Returns:
      The instance.
    • getInstanceBytes

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

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

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

      com.google.protobuf.ByteString getServiceNameBytes()
       File transfer 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.
    • 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.
    • hasOptions

      boolean hasOptions()
       Options for the transfer
       
      optional .google.protobuf.Struct options = 11;
      Returns:
      Whether the options field is set.
    • getOptions

      com.google.protobuf.Struct getOptions()
       Options for the transfer
       
      optional .google.protobuf.Struct options = 11;
      Returns:
      The options.
    • getOptionsOrBuilder

      com.google.protobuf.StructOrBuilder getOptionsOrBuilder()
       Options for the transfer
       
      optional .google.protobuf.Struct options = 11;