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 Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
**Required** The bucket containing the local Yamcs object.used to derive the destination entity id**Required** One of ``UPLOAD`` or ``DOWNLOAD``.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) Yamcs instance name**Required** The object name in Yamcs bucket storage.clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) Options for the transfer**Required** The path at the remote entity.File transfer service nameused to derive the source entity idclone()
**Required** The bucket containing the local Yamcs object.com.google.protobuf.ByteString
**Required** The bucket containing the local Yamcs object.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
used to derive the destination entity idcom.google.protobuf.ByteString
used to derive the destination entity id**Required** One of ``UPLOAD`` or ``DOWNLOAD``.Yamcs instance namecom.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 transfercom.google.protobuf.Struct.Builder
Options for the transfercom.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 namecom.google.protobuf.ByteString
File transfer service nameused to derive the source entity idcom.google.protobuf.ByteString
used to derive the source entity idboolean
**Required** The bucket containing the local Yamcs object.boolean
used to derive the destination entity idboolean
**Required** One of ``UPLOAD`` or ``DOWNLOAD``.boolean
Yamcs instance nameboolean
**Required** The object name in Yamcs bucket storage.boolean
Options for the transferboolean
**Required** The path at the remote entity.boolean
File transfer service nameboolean
used to derive the source entity idprotected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeFrom
(CreateTransferRequest other) mergeOptions
(com.google.protobuf.Struct value) Options for the transfermergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) **Required** The bucket containing the local Yamcs object.setBucketBytes
(com.google.protobuf.ByteString value) **Required** The bucket containing the local Yamcs object.setDestination
(String value) used to derive the destination entity idsetDestinationBytes
(com.google.protobuf.ByteString value) used to derive the destination entity idsetDirection
(TransferDirection value) **Required** One of ``UPLOAD`` or ``DOWNLOAD``.setInstance
(String value) Yamcs instance namesetInstanceBytes
(com.google.protobuf.ByteString value) Yamcs instance namesetObjectName
(String value) **Required** The object name in Yamcs bucket storage.setObjectNameBytes
(com.google.protobuf.ByteString value) **Required** The object name in Yamcs bucket storage.setOptions
(com.google.protobuf.Struct value) Options for the transfersetOptions
(com.google.protobuf.Struct.Builder builderForValue) Options for the transfersetRemotePath
(String value) **Required** The path at the remote entity.setRemotePathBytes
(com.google.protobuf.ByteString value) **Required** The path at the remote entity.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setServiceName
(String value) File transfer service namesetServiceNameBytes
(com.google.protobuf.ByteString value) File transfer service nameused to derive the source entity idsetSourceBytes
(com.google.protobuf.ByteString value) used to derive the source entity idsetUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-
setField
public CreateTransferRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-
clearField
public CreateTransferRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-
clearOneof
public CreateTransferRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.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 interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-
addRepeatedField
public CreateTransferRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<CreateTransferRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.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 interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<CreateTransferRequest.Builder>
- Throws:
IOException
-
hasInstance
public boolean hasInstance()Yamcs instance name
optional string instance = 1;
- Specified by:
hasInstance
in interfaceCreateTransferRequestOrBuilder
- Returns:
- Whether the instance field is set.
-
getInstance
Yamcs instance name
optional string instance = 1;
- Specified by:
getInstance
in interfaceCreateTransferRequestOrBuilder
- Returns:
- The instance.
-
getInstanceBytes
public com.google.protobuf.ByteString getInstanceBytes()Yamcs instance name
optional string instance = 1;
- Specified by:
getInstanceBytes
in interfaceCreateTransferRequestOrBuilder
- Returns:
- The bytes for instance.
-
setInstance
Yamcs instance name
optional string instance = 1;
- Parameters:
value
- The instance to set.- Returns:
- This builder for chaining.
-
clearInstance
Yamcs instance name
optional string instance = 1;
- Returns:
- This builder for chaining.
-
setInstanceBytes
Yamcs instance name
optional string instance = 1;
- Parameters:
value
- The bytes for instance to set.- Returns:
- This builder for chaining.
-
hasServiceName
public boolean hasServiceName()File transfer service name
optional string serviceName = 8;
- Specified by:
hasServiceName
in interfaceCreateTransferRequestOrBuilder
- Returns:
- Whether the serviceName field is set.
-
getServiceName
File transfer service name
optional string serviceName = 8;
- Specified by:
getServiceName
in interfaceCreateTransferRequestOrBuilder
- Returns:
- The serviceName.
-
getServiceNameBytes
public com.google.protobuf.ByteString getServiceNameBytes()File transfer service name
optional string serviceName = 8;
- Specified by:
getServiceNameBytes
in interfaceCreateTransferRequestOrBuilder
- Returns:
- The bytes for serviceName.
-
setServiceName
File transfer service name
optional string serviceName = 8;
- Parameters:
value
- The serviceName to set.- Returns:
- This builder for chaining.
-
clearServiceName
File transfer service name
optional string serviceName = 8;
- Returns:
- This builder for chaining.
-
setServiceNameBytes
File transfer 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 interfaceCreateTransferRequestOrBuilder
- Returns:
- Whether the direction field is set.
-
getDirection
**Required** One of ``UPLOAD`` or ``DOWNLOAD``.
optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;
- Specified by:
getDirection
in interfaceCreateTransferRequestOrBuilder
- Returns:
- The direction.
-
setDirection
**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
**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 interfaceCreateTransferRequestOrBuilder
- Returns:
- Whether the bucket field is set.
-
getBucket
**Required** The bucket containing the local Yamcs object.
optional string bucket = 3;
- Specified by:
getBucket
in interfaceCreateTransferRequestOrBuilder
- 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 interfaceCreateTransferRequestOrBuilder
- Returns:
- The bytes for bucket.
-
setBucket
**Required** The bucket containing the local Yamcs object.
optional string bucket = 3;
- Parameters:
value
- The bucket to set.- Returns:
- This builder for chaining.
-
clearBucket
**Required** The bucket containing the local Yamcs object.
optional string bucket = 3;
- Returns:
- This builder for chaining.
-
setBucketBytes
**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 interfaceCreateTransferRequestOrBuilder
- Returns:
- Whether the objectName field is set.
-
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 interfaceCreateTransferRequestOrBuilder
- 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 interfaceCreateTransferRequestOrBuilder
- Returns:
- The bytes for objectName.
-
setObjectName
**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
**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
**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 interfaceCreateTransferRequestOrBuilder
- Returns:
- Whether the remotePath field is set.
-
getRemotePath
**Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
optional string remotePath = 5;
- Specified by:
getRemotePath
in interfaceCreateTransferRequestOrBuilder
- 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 interfaceCreateTransferRequestOrBuilder
- Returns:
- The bytes for remotePath.
-
setRemotePath
**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
**Required** The path at the remote entity. Example: ``a/local/path/some_filename``.
optional string remotePath = 5;
- Returns:
- This builder for chaining.
-
setRemotePathBytes
**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.
-
hasSource
public boolean hasSource()used to derive the source entity id
optional string source = 9;
- Specified by:
hasSource
in interfaceCreateTransferRequestOrBuilder
- Returns:
- Whether the source field is set.
-
getSource
used to derive the source entity id
optional string source = 9;
- Specified by:
getSource
in interfaceCreateTransferRequestOrBuilder
- 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 interfaceCreateTransferRequestOrBuilder
- Returns:
- The bytes for source.
-
setSource
used to derive the source entity id
optional string source = 9;
- Parameters:
value
- The source to set.- Returns:
- This builder for chaining.
-
clearSource
used to derive the source entity id
optional string source = 9;
- Returns:
- This builder for chaining.
-
setSourceBytes
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 interfaceCreateTransferRequestOrBuilder
- Returns:
- Whether the destination field is set.
-
getDestination
used to derive the destination entity id
optional string destination = 10;
- Specified by:
getDestination
in interfaceCreateTransferRequestOrBuilder
- 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 interfaceCreateTransferRequestOrBuilder
- Returns:
- The bytes for destination.
-
setDestination
used to derive the destination entity id
optional string destination = 10;
- Parameters:
value
- The destination to set.- Returns:
- This builder for chaining.
-
clearDestination
used to derive the destination entity id
optional string destination = 10;
- Returns:
- This builder for chaining.
-
setDestinationBytes
used to derive the destination entity id
optional string destination = 10;
- Parameters:
value
- The bytes for destination to set.- Returns:
- This builder for chaining.
-
hasOptions
public boolean hasOptions()Options for the transfer
optional .google.protobuf.Struct options = 11;
- Specified by:
hasOptions
in interfaceCreateTransferRequestOrBuilder
- 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 interfaceCreateTransferRequestOrBuilder
- Returns:
- The options.
-
setOptions
Options for the transfer
optional .google.protobuf.Struct options = 11;
-
setOptions
Options for the transfer
optional .google.protobuf.Struct options = 11;
-
mergeOptions
Options for the transfer
optional .google.protobuf.Struct options = 11;
-
clearOptions
Options for the transfer
optional .google.protobuf.Struct options = 11;
-
getOptionsBuilder
public com.google.protobuf.Struct.Builder getOptionsBuilder()Options for the transfer
optional .google.protobuf.Struct options = 11;
-
getOptionsOrBuilder
public com.google.protobuf.StructOrBuilder getOptionsOrBuilder()Options for the transfer
optional .google.protobuf.Struct options = 11;
- Specified by:
getOptionsOrBuilder
in interfaceCreateTransferRequestOrBuilder
-
setUnknownFields
public final CreateTransferRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-
mergeUnknownFields
public final CreateTransferRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateTransferRequest.Builder>
-