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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateTransferRequest.Builder	Protobuf type yamcs.protobuf.filetransfer.CreateTransferRequest
static class	CreateTransferRequest.DownloadOptions	Protobuf type yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions
static interface	CreateTransferRequest.DownloadOptionsOrBuilder
static class	CreateTransferRequest.UploadOptions	Protobuf type yamcs.protobuf.filetransfer.CreateTransferRequest.UploadOptions
static interface	CreateTransferRequest.UploadOptionsOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field	Description
static int	BUCKET_FIELD_NUMBER
static int	DESTINATION_FIELD_NUMBER
static int	DIRECTION_FIELD_NUMBER
static int	DOWNLOADOPTIONS_FIELD_NUMBER
static int	INSTANCE_FIELD_NUMBER
static int	OBJECTNAME_FIELD_NUMBER
static com.google.protobuf.Parser<CreateTransferRequest>	PARSER	Deprecated.
static int	REMOTEPATH_FIELD_NUMBER
static int	SERVICENAME_FIELD_NUMBER
static int	SOURCE_FIELD_NUMBER
static int	UPLOADOPTIONS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getBucket()	**Required** The bucket containing the local Yamcs object.
com.google.protobuf.ByteString	getBucketBytes()	**Required** The bucket containing the local Yamcs object.
static CreateTransferRequest	getDefaultInstance()
CreateTransferRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDestination()	used to derive the destination entity id
com.google.protobuf.ByteString	getDestinationBytes()	used to derive the destination entity id
TransferDirection	getDirection()	**Required** One of ``UPLOAD`` or ``DOWNLOAD``.
CreateTransferRequest.DownloadOptions	getDownloadOptions()	optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;
CreateTransferRequest.DownloadOptionsOrBuilder	getDownloadOptionsOrBuilder()	optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;
String	getInstance()	optional string instance = 1;
com.google.protobuf.ByteString	getInstanceBytes()	optional string instance = 1;
String	getObjectName()	**Required** The object name in Yamcs bucket storage.
com.google.protobuf.ByteString	getObjectNameBytes()	**Required** The object name in Yamcs bucket storage.
com.google.protobuf.Parser<CreateTransferRequest>	getParserForType()
String	getRemotePath()	**Required** The path at the remote entity.
com.google.protobuf.ByteString	getRemotePathBytes()	**Required** The path at the remote entity.
int	getSerializedSize()
String	getServiceName()	service name
com.google.protobuf.ByteString	getServiceNameBytes()	service name
String	getSource()	used to derive the source entity id
com.google.protobuf.ByteString	getSourceBytes()	used to derive the source entity id
com.google.protobuf.UnknownFieldSet	getUnknownFields()
CreateTransferRequest.UploadOptions	getUploadOptions()	Configuration options specific to ``UPLOAD`` transfers.
CreateTransferRequest.UploadOptionsOrBuilder	getUploadOptionsOrBuilder()	Configuration options specific to ``UPLOAD`` transfers.
boolean	hasBucket()	**Required** The bucket containing the local Yamcs object.
boolean	hasDestination()	used to derive the destination entity id
boolean	hasDirection()	**Required** One of ``UPLOAD`` or ``DOWNLOAD``.
boolean	hasDownloadOptions()	optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;
int	hashCode()
boolean	hasInstance()	optional string instance = 1;
boolean	hasObjectName()	**Required** The object name in Yamcs bucket storage.
boolean	hasRemotePath()	**Required** The path at the remote entity.
boolean	hasServiceName()	service name
boolean	hasSource()	used to derive the source entity id
boolean	hasUploadOptions()	Configuration options specific to ``UPLOAD`` transfers.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CreateTransferRequest.Builder	newBuilder()
static CreateTransferRequest.Builder	newBuilder(CreateTransferRequest prototype)
CreateTransferRequest.Builder	newBuilderForType()
protected CreateTransferRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static CreateTransferRequest	parseDelimitedFrom(InputStream input)
static CreateTransferRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateTransferRequest	parseFrom(byte[] data)
static CreateTransferRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateTransferRequest	parseFrom(com.google.protobuf.ByteString data)
static CreateTransferRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateTransferRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static CreateTransferRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateTransferRequest	parseFrom(InputStream input)
static CreateTransferRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateTransferRequest	parseFrom(ByteBuffer data)
static CreateTransferRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CreateTransferRequest>	parser()
CreateTransferRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Detail

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER

See Also:

Constant Field Values

SERVICENAME_FIELD_NUMBER

public static final int SERVICENAME_FIELD_NUMBER

See Also:

Constant Field Values

DIRECTION_FIELD_NUMBER

public static final int DIRECTION_FIELD_NUMBER

See Also:

Constant Field Values

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER

See Also:

Constant Field Values

OBJECTNAME_FIELD_NUMBER

public static final int OBJECTNAME_FIELD_NUMBER

See Also:

Constant Field Values

REMOTEPATH_FIELD_NUMBER

public static final int REMOTEPATH_FIELD_NUMBER

See Also:

Constant Field Values

DOWNLOADOPTIONS_FIELD_NUMBER

public static final int DOWNLOADOPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

UPLOADOPTIONS_FIELD_NUMBER

public static final int UPLOADOPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<CreateTransferRequest> PARSER

Deprecated.

Method Detail

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()

optional string instance = 1;

Specified by:

hasInstance in interface CreateTransferRequestOrBuilder

getInstance

public String getInstance()

optional string instance = 1;

Specified by:

getInstance in interface CreateTransferRequestOrBuilder

getInstanceBytes

public com.google.protobuf.ByteString getInstanceBytes()

optional string instance = 1;

Specified by:

getInstanceBytes in interface CreateTransferRequestOrBuilder

hasServiceName

public boolean hasServiceName()

service name
 

optional string serviceName = 8;

Specified by:

hasServiceName in interface CreateTransferRequestOrBuilder

getServiceName

public String getServiceName()

service name
 

optional string serviceName = 8;

Specified by:

getServiceName in interface CreateTransferRequestOrBuilder

getServiceNameBytes

public com.google.protobuf.ByteString getServiceNameBytes()

service name
 

optional string serviceName = 8;

Specified by:

getServiceNameBytes in interface CreateTransferRequestOrBuilder

hasDirection

public boolean hasDirection()

 **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
 

optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;

Specified by:

hasDirection in interface CreateTransferRequestOrBuilder

getDirection

public TransferDirection getDirection()

 **Required** One of ``UPLOAD`` or ``DOWNLOAD``.
 

optional .yamcs.protobuf.filetransfer.TransferDirection direction = 2;

Specified by:

getDirection in interface CreateTransferRequestOrBuilder

hasBucket

public boolean hasBucket()

 **Required** The bucket containing the local Yamcs object.
 

optional string bucket = 3;

Specified by:

hasBucket in interface CreateTransferRequestOrBuilder

getBucket

public String getBucket()

 **Required** The bucket containing the local Yamcs object.
 

optional string bucket = 3;

Specified by:

getBucket in interface CreateTransferRequestOrBuilder

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

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

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

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

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

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

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

hasDownloadOptions

public boolean hasDownloadOptions()

optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;

Specified by:

hasDownloadOptions in interface CreateTransferRequestOrBuilder

getDownloadOptions

public CreateTransferRequest.DownloadOptions getDownloadOptions()

optional .yamcs.protobuf.filetransfer.CreateTransferRequest.DownloadOptions downloadOptions = 6;

Specified by:

getDownloadOptions in interface CreateTransferRequestOrBuilder

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

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

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

getSource

public String getSource()

used to derive the source entity id
 

optional string source = 9;

Specified by:

getSource in interface CreateTransferRequestOrBuilder

getSourceBytes

public com.google.protobuf.ByteString getSourceBytes()

used to derive the source entity id
 

optional string source = 9;

Specified by:

getSourceBytes in interface CreateTransferRequestOrBuilder

hasDestination

public boolean hasDestination()

used to derive the destination entity id
 

optional string destination = 10;

Specified by:

hasDestination in interface CreateTransferRequestOrBuilder

getDestination

public String getDestination()

used to derive the destination entity id
 

optional string destination = 10;

Specified by:

getDestination in interface CreateTransferRequestOrBuilder

getDestinationBytes

public com.google.protobuf.ByteString getDestinationBytes()

used to derive the destination entity id
 

optional string destination = 10;

Specified by:

getDestinationBytes 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