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

Class CreateTransferRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
org.yamcs.protobuf.CreateTransferRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, CreateTransferRequestOrBuilder
Enclosing class:
CreateTransferRequest
public static final class CreateTransferRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder> implements CreateTransferRequestOrBuilder
Protobuf type yamcs.protobuf.filetransfer.CreateTransferRequest

  • Method Details

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

    • clear

      public CreateTransferRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public CreateTransferRequest.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • setField

      public CreateTransferRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • clearField

      public CreateTransferRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • clearOneof

      public CreateTransferRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • setRepeatedField

      public CreateTransferRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • addRepeatedField

      public CreateTransferRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • mergeFrom

      public CreateTransferRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CreateTransferRequest.Builder>

    • mergeFrom

      public CreateTransferRequest.Builder mergeFrom(CreateTransferRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • mergeFrom

      public CreateTransferRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CreateTransferRequest.Builder>
      Throws:
      IOException

    • hasInstance

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

    • getInstance

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

    • getInstanceBytes

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

    • setInstance

      public CreateTransferRequest.Builder setInstance(String value)
      optional string instance = 1;
      Parameters:
      value - The instance to set.
      Returns:
      This builder for chaining.

    • clearInstance

      public CreateTransferRequest.Builder clearInstance()
      optional string instance = 1;
      Returns:
      This builder for chaining.

    • setInstanceBytes

      public CreateTransferRequest.Builder setInstanceBytes(com.google.protobuf.ByteString value)
      optional string instance = 1;
      Parameters:
      value - The bytes for instance to set.
      Returns:
      This builder for chaining.

    • hasServiceName

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

    • getServiceName

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

    • getServiceNameBytes

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

    • setServiceName

      public CreateTransferRequest.Builder setServiceName(String value)
      service name
      optional string serviceName = 8;
      Parameters:
      value - The serviceName to set.
      Returns:
      This builder for chaining.

    • clearServiceName

      public CreateTransferRequest.Builder clearServiceName()
      service name
      optional string serviceName = 8;
      Returns:
      This builder for chaining.

    • setServiceNameBytes

      public CreateTransferRequest.Builder setServiceNameBytes(com.google.protobuf.ByteString value)
      service name
      optional string serviceName = 8;
      Parameters:
      value - The bytes for serviceName to set.
      Returns:
      This builder for chaining.

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

    • setDirection

      public CreateTransferRequest.Builder setDirection(TransferDirection value)
       **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
      optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;
      Parameters:
      value - The direction to set.
      Returns:
      This builder for chaining.

    • clearDirection

      public CreateTransferRequest.Builder clearDirection()
       **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
      optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;
      Returns:
      This builder for chaining.

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

    • setBucket

      public CreateTransferRequest.Builder setBucket(String value)
       **Required** The bucket containing the local Yamcs object.
      optional string bucket = 3;
      Parameters:
      value - The bucket to set.
      Returns:
      This builder for chaining.

    • clearBucket

      public CreateTransferRequest.Builder clearBucket()
       **Required** The bucket containing the local Yamcs object.
      optional string bucket = 3;
      Returns:
      This builder for chaining.

    • setBucketBytes

      public CreateTransferRequest.Builder setBucketBytes(com.google.protobuf.ByteString value)
       **Required** The bucket containing the local Yamcs object.
      optional string bucket = 3;
      Parameters:
      value - The bytes for bucket to set.
      Returns:
      This builder for chaining.

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

    • setObjectName

      public CreateTransferRequest.Builder setObjectName(String value)
       **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;
      Parameters:
      value - The objectName to set.
      Returns:
      This builder for chaining.

    • clearObjectName

      public CreateTransferRequest.Builder clearObjectName()
       **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:
      This builder for chaining.

    • setObjectNameBytes

      public CreateTransferRequest.Builder setObjectNameBytes(com.google.protobuf.ByteString value)
       **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;
      Parameters:
      value - The bytes for objectName to set.
      Returns:
      This builder for chaining.

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

    • setRemotePath

      public CreateTransferRequest.Builder setRemotePath(String value)
       **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
      optional string remotePath = 5;
      Parameters:
      value - The remotePath to set.
      Returns:
      This builder for chaining.

    • clearRemotePath

      public CreateTransferRequest.Builder clearRemotePath()
       **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
      optional string remotePath = 5;
      Returns:
      This builder for chaining.

    • setRemotePathBytes

      public CreateTransferRequest.Builder setRemotePathBytes(com.google.protobuf.ByteString value)
       **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
      optional string remotePath = 5;
      Parameters:
      value - The bytes for remotePath to set.
      Returns:
      This builder for chaining.

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

    • getDownloadOptions

      public CreateTransferRequest.DownloadOptions getDownloadOptions()
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;
      Specified by:
      getDownloadOptions in interface CreateTransferRequestOrBuilder
      Returns:
      The downloadOptions.

    • setDownloadOptions

      public CreateTransferRequest.Builder setDownloadOptions(CreateTransferRequest.DownloadOptions value)
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;

    • setDownloadOptions

      public CreateTransferRequest.Builder setDownloadOptions(CreateTransferRequest.DownloadOptions.Builder builderForValue)
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;

    • mergeDownloadOptions

      public CreateTransferRequest.Builder mergeDownloadOptions(CreateTransferRequest.DownloadOptions value)
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;

    • clearDownloadOptions

      public CreateTransferRequest.Builder clearDownloadOptions()
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;

    • getDownloadOptionsBuilder

      public CreateTransferRequest.DownloadOptions.Builder getDownloadOptionsBuilder()
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;

    • getDownloadOptionsOrBuilder

      public CreateTransferRequest.DownloadOptionsOrBuilder getDownloadOptionsOrBuilder()
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;
      Specified by:
      getDownloadOptionsOrBuilder in interface CreateTransferRequestOrBuilder

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

    • getUploadOptions

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

    • setUploadOptions

      public CreateTransferRequest.Builder setUploadOptions(CreateTransferRequest.UploadOptions value)
       Configuration options specific to ``UPLOAD`` transfers.
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.UploadOptions uploadOptions = 7;

    • setUploadOptions

      public CreateTransferRequest.Builder setUploadOptions(CreateTransferRequest.UploadOptions.Builder builderForValue)
       Configuration options specific to ``UPLOAD`` transfers.
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.UploadOptions uploadOptions = 7;

    • mergeUploadOptions

      public CreateTransferRequest.Builder mergeUploadOptions(CreateTransferRequest.UploadOptions value)
       Configuration options specific to ``UPLOAD`` transfers.
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.UploadOptions uploadOptions = 7;

    • clearUploadOptions

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

    • getUploadOptionsBuilder

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

    • getUploadOptionsOrBuilder

      public CreateTransferRequest.UploadOptionsOrBuilder getUploadOptionsOrBuilder()
       Configuration options specific to ``UPLOAD`` transfers.
      optional .yamcs.protobuf.filetransfer.CreateTransferRequest.UploadOptions uploadOptions = 7;
      Specified by:
      getUploadOptionsOrBuilder in interface CreateTransferRequestOrBuilder

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

    • setSource

      public CreateTransferRequest.Builder setSource(String value)
      used to derive the source entity id
      optional string source = 9;
      Parameters:
      value - The source to set.
      Returns:
      This builder for chaining.

    • clearSource

      public CreateTransferRequest.Builder clearSource()
      used to derive the source entity id
      optional string source = 9;
      Returns:
      This builder for chaining.

    • setSourceBytes

      public CreateTransferRequest.Builder setSourceBytes(com.google.protobuf.ByteString value)
      used to derive the source entity id
      optional string source = 9;
      Parameters:
      value - The bytes for source to set.
      Returns:
      This builder for chaining.

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

    • setDestination

      public CreateTransferRequest.Builder setDestination(String value)
      used to derive the destination entity id
      optional string destination = 10;
      Parameters:
      value - The destination to set.
      Returns:
      This builder for chaining.

    • clearDestination

      public CreateTransferRequest.Builder clearDestination()
      used to derive the destination entity id
      optional string destination = 10;
      Returns:
      This builder for chaining.

    • setDestinationBytes

      public CreateTransferRequest.Builder setDestinationBytes(com.google.protobuf.ByteString value)
      used to derive the destination entity id
      optional string destination = 10;
      Parameters:
      value - The bytes for destination to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final CreateTransferRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>

    • mergeUnknownFields

      public final CreateTransferRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>