Class 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 type yamcs.protobuf.filetransfer.TransferInfo
    See Also:
    Serialized Form
    • 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
      • hasId

        public boolean hasId()
        unique identifier assigned by the file transfer service
         
        optional uint64 id = 1;
        Specified by:
        hasId in interface TransferInfoOrBuilder
      • getId

        public long getId()
        unique identifier assigned by the file transfer service
         
        optional uint64 id = 1;
        Specified by:
        getId in interface TransferInfoOrBuilder
      • 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:
        hasStartTime in interface TransferInfoOrBuilder
      • 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:
        getStartTime in interface TransferInfoOrBuilder
      • 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:
        getStartTimeOrBuilder in interface TransferInfoOrBuilder
      • hasState

        public boolean hasState()
        optional .yamcs.protobuf.filetransfer.TransferState state = 3;
        Specified by:
        hasState in interface TransferInfoOrBuilder
      • hasDirection

        public boolean hasDirection()
        optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;
        Specified by:
        hasDirection in interface TransferInfoOrBuilder
      • hasReliable

        public boolean hasReliable()
        reliable = true -> class 2 transfer
        reliable = false -> class 1 transfer
         
        optional bool reliable = 10;
        Specified by:
        hasReliable in interface TransferInfoOrBuilder
      • getReliable

        public boolean getReliable()
        reliable = true -> class 2 transfer
        reliable = false -> class 1 transfer
         
        optional bool reliable = 10;
        Specified by:
        getReliable in interface TransferInfoOrBuilder
      • hasFailureReason

        public boolean hasFailureReason()
        in case the transcation is failed, this provides more information
         
        optional string failureReason = 11;
        Specified by:
        hasFailureReason in interface TransferInfoOrBuilder
      • getFailureReason

        public String getFailureReason()
        in case the transcation is failed, this provides more information
         
        optional string failureReason = 11;
        Specified by:
        getFailureReason in interface TransferInfoOrBuilder
      • getFailureReasonBytes

        public com.google.protobuf.ByteString getFailureReasonBytes()
        in case the transcation is failed, this provides more information
         
        optional string failureReason = 11;
        Specified by:
        getFailureReasonBytes in interface TransferInfoOrBuilder
      • 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:
        hasTransactionId in interface TransferInfoOrBuilder
      • 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:
        getTransactionId in interface TransferInfoOrBuilder
      • 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:
        getTransactionIdOrBuilder in interface TransferInfoOrBuilder
      • hasCreationTime

        public boolean hasCreationTime()
         when the transfer has been created. 
         
        optional .google.protobuf.Timestamp creationTime = 13;
        Specified by:
        hasCreationTime in interface TransferInfoOrBuilder
      • getCreationTime

        public com.google.protobuf.Timestamp getCreationTime()
         when the transfer has been created. 
         
        optional .google.protobuf.Timestamp creationTime = 13;
        Specified by:
        getCreationTime in interface TransferInfoOrBuilder
      • getCreationTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder()
         when the transfer has been created. 
         
        optional .google.protobuf.Timestamp creationTime = 13;
        Specified by:
        getCreationTimeOrBuilder in interface TransferInfoOrBuilder
      • 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 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​(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected TransferInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.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:
        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 TransferInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder