Package org.yamcs.protobuf

Class CreateTransferRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.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:

  • Field Details

  • Method Details

    • 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

    • hasInstance

      public boolean hasInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      hasInstance in interface CreateTransferRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

      public String getInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstance in interface CreateTransferRequestOrBuilder
      Returns:
      The instance.

    • getInstanceBytes

      public com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstanceBytes in interface CreateTransferRequestOrBuilder
      Returns:
      The bytes for instance.

    • hasServiceName

      public boolean hasServiceName()
       File transfer service name
      optional string serviceName = 8;
      Specified by:
      hasServiceName in interface CreateTransferRequestOrBuilder
      Returns:
      Whether the serviceName field is set.

    • getServiceName

      public String getServiceName()
       File transfer service name
      optional string serviceName = 8;
      Specified by:
      getServiceName in interface CreateTransferRequestOrBuilder
      Returns:
      The serviceName.

    • getServiceNameBytes

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

    • getDirection

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

    • 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.

    • getBucket

      public String getBucket()
       **Required** The bucket containing the local Yamcs object.
      optional string bucket = 3;
      Specified by:
      getBucket in interface CreateTransferRequestOrBuilder
      Returns:
      The bucket.

    • 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.

    • 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.

    • getSource

      public String getSource()
      used to derive the source entity id
      optional string source = 9;
      Specified by:
      getSource in interface CreateTransferRequestOrBuilder
      Returns:
      The source.

    • 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.

    • getDestination

      public String getDestination()
      used to derive the destination entity id
      optional string destination = 10;
      Specified by:
      getDestination in interface CreateTransferRequestOrBuilder
      Returns:
      The destination.

    • 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.

    • hasOptions

      public boolean hasOptions()
       Options for the transfer
      optional .google.protobuf.Struct options = 11;
      Specified by:
      hasOptions in interface CreateTransferRequestOrBuilder
      Returns:
      Whether the options field is set.

    • getOptions

      public com.google.protobuf.Struct getOptions()
       Options for the transfer
      optional .google.protobuf.Struct options = 11;
      Specified by:
      getOptions in interface CreateTransferRequestOrBuilder
      Returns:
      The options.

    • getOptionsOrBuilder

      public com.google.protobuf.StructOrBuilder getOptionsOrBuilder()
       Options for the transfer
      optional .google.protobuf.Struct options = 11;
      Specified by:
      getOptionsOrBuilder in interface CreateTransferRequestOrBuilder

    • 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

    • parseFrom

      public static CreateTransferRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CreateTransferRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CreateTransferRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CreateTransferRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CreateTransferRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CreateTransferRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static CreateTransferRequest.Builder newBuilder()

    • newBuilder

      public static CreateTransferRequest.Builder newBuilder(CreateTransferRequest prototype)

    • 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

    • getDefaultInstance

      public static CreateTransferRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CreateTransferRequest> parser()

    • 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