Package org.yamcs.protobuf
Class TransferInfo
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- org.yamcs.protobuf.TransferInfo
-
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable,TransferInfoOrBuilder
public final class TransferInfo extends com.google.protobuf.GeneratedMessageV3 implements TransferInfoOrBuilder
message sent as reponse to the info and also when starting a new transfer
Protobuf typeyamcs.protobuf.filetransfer.TransferInfo- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTransferInfo.Buildermessage sent as reponse to the info and also when starting a new transfer-
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 intBUCKET_FIELD_NUMBERstatic intCREATIONTIME_FIELD_NUMBERstatic intDIRECTION_FIELD_NUMBERstatic intFAILUREREASON_FIELD_NUMBERstatic intID_FIELD_NUMBERstatic intOBJECTNAME_FIELD_NUMBERstatic com.google.protobuf.Parser<TransferInfo>PARSERDeprecated.static intRELIABLE_FIELD_NUMBERstatic intREMOTEPATH_FIELD_NUMBERstatic intSIZETRANSFERRED_FIELD_NUMBERstatic intSTARTTIME_FIELD_NUMBERstatic intSTATE_FIELD_NUMBERstatic intTOTALSIZE_FIELD_NUMBERstatic intTRANSACTIONID_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)StringgetBucket()optional string bucket = 4;com.google.protobuf.ByteStringgetBucketBytes()optional string bucket = 4;com.google.protobuf.TimestampgetCreationTime()when the transfer has been created.com.google.protobuf.TimestampOrBuildergetCreationTimeOrBuilder()when the transfer has been created.static TransferInfogetDefaultInstance()TransferInfogetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()TransferDirectiongetDirection()optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;StringgetFailureReason()in case the transcation is failed, this provides more informationcom.google.protobuf.ByteStringgetFailureReasonBytes()in case the transcation is failed, this provides more informationlonggetId()unique identifier assigned by the file transfer serviceStringgetObjectName()optional string objectName = 5;com.google.protobuf.ByteStringgetObjectNameBytes()optional string objectName = 5;com.google.protobuf.Parser<TransferInfo>getParserForType()booleangetReliable()reliable = true -> class 2 transfer reliable = false -> class 1 transferStringgetRemotePath()optional string remotePath = 6;com.google.protobuf.ByteStringgetRemotePathBytes()optional string remotePath = 6;intgetSerializedSize()longgetSizeTransferred()optional uint64 sizeTransferred = 9;com.google.protobuf.TimestampgetStartTime()when the transfer has started.com.google.protobuf.TimestampOrBuildergetStartTimeOrBuilder()when the transfer has started.TransferStategetState()optional .yamcs.protobuf.filetransfer.TransferState state = 3;longgetTotalSize()optional uint64 totalSize = 8;TransactionIdgetTransactionId()valid for CFDP: transaction id; for the incoming transfers it is assigned by the remote peer so therefore might not be uniqueTransactionIdOrBuildergetTransactionIdOrBuilder()valid for CFDP: transaction id; for the incoming transfers it is assigned by the remote peer so therefore might not be uniquecom.google.protobuf.UnknownFieldSetgetUnknownFields()booleanhasBucket()optional string bucket = 4;booleanhasCreationTime()when the transfer has been created.booleanhasDirection()optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;booleanhasFailureReason()in case the transcation is failed, this provides more informationinthashCode()booleanhasId()unique identifier assigned by the file transfer servicebooleanhasObjectName()optional string objectName = 5;booleanhasReliable()reliable = true -> class 2 transfer reliable = false -> class 1 transferbooleanhasRemotePath()optional string remotePath = 6;booleanhasSizeTransferred()optional uint64 sizeTransferred = 9;booleanhasStartTime()when the transfer has started.booleanhasState()optional .yamcs.protobuf.filetransfer.TransferState state = 3;booleanhasTotalSize()optional uint64 totalSize = 8;booleanhasTransactionId()valid for CFDP: transaction id; for the incoming transfers it is assigned by the remote peer so therefore might not be uniqueprotected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static TransferInfo.BuildernewBuilder()static TransferInfo.BuildernewBuilder(TransferInfo prototype)TransferInfo.BuildernewBuilderForType()protected TransferInfo.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)static TransferInfoparseDelimitedFrom(InputStream input)static TransferInfoparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TransferInfoparseFrom(byte[] data)static TransferInfoparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TransferInfoparseFrom(com.google.protobuf.ByteString data)static TransferInfoparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TransferInfoparseFrom(com.google.protobuf.CodedInputStream input)static TransferInfoparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TransferInfoparseFrom(InputStream input)static TransferInfoparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TransferInfoparseFrom(ByteBuffer data)static TransferInfoparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<TransferInfo>parser()TransferInfo.BuildertoBuilder()voidwriteTo(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
-
-
-
-
Field Detail
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STARTTIME_FIELD_NUMBER
public static final int STARTTIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATE_FIELD_NUMBER
public static final int STATE_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
-
DIRECTION_FIELD_NUMBER
public static final int DIRECTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TOTALSIZE_FIELD_NUMBER
public static final int TOTALSIZE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SIZETRANSFERRED_FIELD_NUMBER
public static final int SIZETRANSFERRED_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RELIABLE_FIELD_NUMBER
public static final int RELIABLE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FAILUREREASON_FIELD_NUMBER
public static final int FAILUREREASON_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TRANSACTIONID_FIELD_NUMBER
public static final int TRANSACTIONID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CREATIONTIME_FIELD_NUMBER
public static final int CREATIONTIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PARSER
@Deprecated public static final com.google.protobuf.Parser<TransferInfo> PARSER
Deprecated.
-
-
Method Detail
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasId
public boolean hasId()
unique identifier assigned by the file transfer service
optional uint64 id = 1;- Specified by:
hasIdin interfaceTransferInfoOrBuilder
-
getId
public long getId()
unique identifier assigned by the file transfer service
optional uint64 id = 1;- Specified by:
getIdin interfaceTransferInfoOrBuilder
-
hasStartTime
public boolean hasStartTime()
when the transfer has started. Note that this will not be set for QUEUED transfers.
optional .google.protobuf.Timestamp startTime = 2;- Specified by:
hasStartTimein interfaceTransferInfoOrBuilder
-
getStartTime
public com.google.protobuf.Timestamp getStartTime()
when the transfer has started. Note that this will not be set for QUEUED transfers.
optional .google.protobuf.Timestamp startTime = 2;- Specified by:
getStartTimein interfaceTransferInfoOrBuilder
-
getStartTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
when the transfer has started. Note that this will not be set for QUEUED transfers.
optional .google.protobuf.Timestamp startTime = 2;- Specified by:
getStartTimeOrBuilderin interfaceTransferInfoOrBuilder
-
hasState
public boolean hasState()
optional .yamcs.protobuf.filetransfer.TransferState state = 3;- Specified by:
hasStatein interfaceTransferInfoOrBuilder
-
getState
public TransferState getState()
optional .yamcs.protobuf.filetransfer.TransferState state = 3;- Specified by:
getStatein interfaceTransferInfoOrBuilder
-
hasBucket
public boolean hasBucket()
optional string bucket = 4;- Specified by:
hasBucketin interfaceTransferInfoOrBuilder
-
getBucket
public String getBucket()
optional string bucket = 4;- Specified by:
getBucketin interfaceTransferInfoOrBuilder
-
getBucketBytes
public com.google.protobuf.ByteString getBucketBytes()
optional string bucket = 4;- Specified by:
getBucketBytesin interfaceTransferInfoOrBuilder
-
hasObjectName
public boolean hasObjectName()
optional string objectName = 5;- Specified by:
hasObjectNamein interfaceTransferInfoOrBuilder
-
getObjectName
public String getObjectName()
optional string objectName = 5;- Specified by:
getObjectNamein interfaceTransferInfoOrBuilder
-
getObjectNameBytes
public com.google.protobuf.ByteString getObjectNameBytes()
optional string objectName = 5;- Specified by:
getObjectNameBytesin interfaceTransferInfoOrBuilder
-
hasRemotePath
public boolean hasRemotePath()
optional string remotePath = 6;- Specified by:
hasRemotePathin interfaceTransferInfoOrBuilder
-
getRemotePath
public String getRemotePath()
optional string remotePath = 6;- Specified by:
getRemotePathin interfaceTransferInfoOrBuilder
-
getRemotePathBytes
public com.google.protobuf.ByteString getRemotePathBytes()
optional string remotePath = 6;- Specified by:
getRemotePathBytesin interfaceTransferInfoOrBuilder
-
hasDirection
public boolean hasDirection()
optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;- Specified by:
hasDirectionin interfaceTransferInfoOrBuilder
-
getDirection
public TransferDirection getDirection()
optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;- Specified by:
getDirectionin interfaceTransferInfoOrBuilder
-
hasTotalSize
public boolean hasTotalSize()
optional uint64 totalSize = 8;- Specified by:
hasTotalSizein interfaceTransferInfoOrBuilder
-
getTotalSize
public long getTotalSize()
optional uint64 totalSize = 8;- Specified by:
getTotalSizein interfaceTransferInfoOrBuilder
-
hasSizeTransferred
public boolean hasSizeTransferred()
optional uint64 sizeTransferred = 9;- Specified by:
hasSizeTransferredin interfaceTransferInfoOrBuilder
-
getSizeTransferred
public long getSizeTransferred()
optional uint64 sizeTransferred = 9;- Specified by:
getSizeTransferredin interfaceTransferInfoOrBuilder
-
hasReliable
public boolean hasReliable()
reliable = true -> class 2 transfer reliable = false -> class 1 transfer
optional bool reliable = 10;- Specified by:
hasReliablein interfaceTransferInfoOrBuilder
-
getReliable
public boolean getReliable()
reliable = true -> class 2 transfer reliable = false -> class 1 transfer
optional bool reliable = 10;- Specified by:
getReliablein interfaceTransferInfoOrBuilder
-
hasFailureReason
public boolean hasFailureReason()
in case the transcation is failed, this provides more information
optional string failureReason = 11;- Specified by:
hasFailureReasonin interfaceTransferInfoOrBuilder
-
getFailureReason
public String getFailureReason()
in case the transcation is failed, this provides more information
optional string failureReason = 11;- Specified by:
getFailureReasonin interfaceTransferInfoOrBuilder
-
getFailureReasonBytes
public com.google.protobuf.ByteString getFailureReasonBytes()
in case the transcation is failed, this provides more information
optional string failureReason = 11;- Specified by:
getFailureReasonBytesin interfaceTransferInfoOrBuilder
-
hasTransactionId
public boolean hasTransactionId()
valid for CFDP: transaction id; for the incoming transfers it is assigned by the remote peer so therefore might not be unique
optional .yamcs.protobuf.filetransfer.TransactionId transactionId = 12;- Specified by:
hasTransactionIdin interfaceTransferInfoOrBuilder
-
getTransactionId
public TransactionId getTransactionId()
valid for CFDP: transaction id; for the incoming transfers it is assigned by the remote peer so therefore might not be unique
optional .yamcs.protobuf.filetransfer.TransactionId transactionId = 12;- Specified by:
getTransactionIdin interfaceTransferInfoOrBuilder
-
getTransactionIdOrBuilder
public TransactionIdOrBuilder getTransactionIdOrBuilder()
valid for CFDP: transaction id; for the incoming transfers it is assigned by the remote peer so therefore might not be unique
optional .yamcs.protobuf.filetransfer.TransactionId transactionId = 12;- Specified by:
getTransactionIdOrBuilderin interfaceTransferInfoOrBuilder
-
hasCreationTime
public boolean hasCreationTime()
when the transfer has been created.
optional .google.protobuf.Timestamp creationTime = 13;- Specified by:
hasCreationTimein interfaceTransferInfoOrBuilder
-
getCreationTime
public com.google.protobuf.Timestamp getCreationTime()
when the transfer has been created.
optional .google.protobuf.Timestamp creationTime = 13;- Specified by:
getCreationTimein interfaceTransferInfoOrBuilder
-
getCreationTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder()
when the transfer has been created.
optional .google.protobuf.Timestamp creationTime = 13;- Specified by:
getCreationTimeOrBuilderin interfaceTransferInfoOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static TransferInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TransferInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TransferInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TransferInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TransferInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TransferInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TransferInfo parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static TransferInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static TransferInfo parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static TransferInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static TransferInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static TransferInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public TransferInfo.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static TransferInfo.Builder newBuilder()
-
newBuilder
public static TransferInfo.Builder newBuilder(TransferInfo prototype)
-
toBuilder
public TransferInfo.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected TransferInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static TransferInfo getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<TransferInfo> parser()
-
getParserForType
public com.google.protobuf.Parser<TransferInfo> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public TransferInfo getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-