Class CreateTransferRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, CreateTransferRequestOrBuilder

    public final class CreateTransferRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements CreateTransferRequestOrBuilder
    Protobuf type yamcs.protobuf.filetransfer.CreateTransferRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getServiceNameBytes

        public com.google.protobuf.ByteString getServiceNameBytes()
        service name
         
        optional string serviceName = 8;
        Specified by:
        getServiceNameBytes in interface CreateTransferRequestOrBuilder
        Returns:
        The bytes for serviceName.
      • hasDirection

        public boolean hasDirection()
         **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
         
        optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;
        Specified by:
        hasDirection in interface CreateTransferRequestOrBuilder
        Returns:
        Whether the direction field is set.
      • hasBucket

        public boolean hasBucket()
         **Required** The bucket containing the local Yamcs object.
         
        optional string bucket = 3;
        Specified by:
        hasBucket in interface CreateTransferRequestOrBuilder
        Returns:
        Whether the bucket field is set.
      • getBucketBytes

        public com.google.protobuf.ByteString getBucketBytes()
         **Required** The bucket containing the local Yamcs object.
         
        optional string bucket = 3;
        Specified by:
        getBucketBytes in interface CreateTransferRequestOrBuilder
        Returns:
        The bytes for bucket.
      • hasObjectName

        public 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;
        Specified by:
        hasObjectName in interface CreateTransferRequestOrBuilder
        Returns:
        Whether the objectName field is set.
      • getObjectName

        public 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;
        Specified by:
        getObjectName in interface CreateTransferRequestOrBuilder
        Returns:
        The objectName.
      • getObjectNameBytes

        public 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;
        Specified by:
        getObjectNameBytes in interface CreateTransferRequestOrBuilder
        Returns:
        The bytes for objectName.
      • hasRemotePath

        public boolean hasRemotePath()
         **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
         
        optional string remotePath = 5;
        Specified by:
        hasRemotePath in interface CreateTransferRequestOrBuilder
        Returns:
        Whether the remotePath field is set.
      • getRemotePath

        public String getRemotePath()
         **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
         
        optional string remotePath = 5;
        Specified by:
        getRemotePath in interface CreateTransferRequestOrBuilder
        Returns:
        The remotePath.
      • getRemotePathBytes

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

        public boolean hasDownloadOptions()
        optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;
        Specified by:
        hasDownloadOptions in interface CreateTransferRequestOrBuilder
        Returns:
        Whether the downloadOptions field is set.
      • hasUploadOptions

        public boolean hasUploadOptions()
         Configuration options specific to ``UPLOAD`` transfers.
         
        optional .yamcs.protobuf.filetransfer.CreateTransferRequest.UploadOptions uploadOptions = 7;
        Specified by:
        hasUploadOptions in interface CreateTransferRequestOrBuilder
        Returns:
        Whether the uploadOptions field is set.
      • hasSource

        public boolean hasSource()
        used to derive the source entity id
         
        optional string source = 9;
        Specified by:
        hasSource in interface CreateTransferRequestOrBuilder
        Returns:
        Whether the source field is set.
      • getSourceBytes

        public com.google.protobuf.ByteString getSourceBytes()
        used to derive the source entity id
         
        optional string source = 9;
        Specified by:
        getSourceBytes in interface CreateTransferRequestOrBuilder
        Returns:
        The bytes for source.
      • hasDestination

        public boolean hasDestination()
        used to derive the destination entity id
         
        optional string destination = 10;
        Specified by:
        hasDestination in interface CreateTransferRequestOrBuilder
        Returns:
        Whether the destination field is set.
      • getDestinationBytes

        public com.google.protobuf.ByteString getDestinationBytes()
        used to derive the destination entity id
         
        optional string destination = 10;
        Specified by:
        getDestinationBytes in interface CreateTransferRequestOrBuilder
        Returns:
        The bytes for destination.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static CreateTransferRequest parseFrom​(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CreateTransferRequest parseFrom​(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CreateTransferRequest parseFrom​(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CreateTransferRequest parseFrom​(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CreateTransferRequest parseFrom​(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CreateTransferRequest parseFrom​(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public CreateTransferRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public CreateTransferRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected CreateTransferRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<CreateTransferRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public CreateTransferRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder