Class TransferInfo.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, TransferInfoOrBuilder
    Enclosing class:
    TransferInfo

    public static final class TransferInfo.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<TransferInfo.Builder>
    implements TransferInfoOrBuilder
    message sent as reponse to the info and also when starting a new transfer
     
    Protobuf type yamcs.protobuf.filetransfer.TransferInfo
    • Method Detail

      • 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<TransferInfo.Builder>
      • clear

        public TransferInfo.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<TransferInfo.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<TransferInfo.Builder>
      • getDefaultInstanceForType

        public TransferInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public TransferInfo.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<TransferInfo.Builder>
      • setField

        public TransferInfo.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<TransferInfo.Builder>
      • clearField

        public TransferInfo.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<TransferInfo.Builder>
      • clearOneof

        public TransferInfo.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<TransferInfo.Builder>
      • setRepeatedField

        public TransferInfo.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<TransferInfo.Builder>
      • addRepeatedField

        public TransferInfo.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<TransferInfo.Builder>
      • mergeFrom

        public TransferInfo.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<TransferInfo.Builder>
      • isInitialized

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

        public TransferInfo.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<TransferInfo.Builder>
        Throws:
        IOException
      • 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
      • setId

        public TransferInfo.Builder setId​(long value)
        unique identifier assigned by the file transfer service
         
        optional uint64 id = 1;
      • clearId

        public TransferInfo.Builder clearId()
        unique identifier assigned by the file transfer service
         
        optional uint64 id = 1;
      • 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
      • setStartTime

        public TransferInfo.Builder setStartTime​(com.google.protobuf.Timestamp value)
        when the transfer has started. Note that this will not be set for QUEUED transfers.
         
        optional .google.protobuf.Timestamp startTime = 2;
      • setStartTime

        public TransferInfo.Builder setStartTime​(com.google.protobuf.Timestamp.Builder builderForValue)
        when the transfer has started. Note that this will not be set for QUEUED transfers.
         
        optional .google.protobuf.Timestamp startTime = 2;
      • mergeStartTime

        public TransferInfo.Builder mergeStartTime​(com.google.protobuf.Timestamp value)
        when the transfer has started. Note that this will not be set for QUEUED transfers.
         
        optional .google.protobuf.Timestamp startTime = 2;
      • clearStartTime

        public TransferInfo.Builder clearStartTime()
        when the transfer has started. Note that this will not be set for QUEUED transfers.
         
        optional .google.protobuf.Timestamp startTime = 2;
      • getStartTimeBuilder

        public com.google.protobuf.Timestamp.Builder getStartTimeBuilder()
        when the transfer has started. Note that this will not be set for QUEUED transfers.
         
        optional .google.protobuf.Timestamp startTime = 2;
      • 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
      • clearState

        public TransferInfo.Builder clearState()
        optional .yamcs.protobuf.filetransfer.TransferState state = 3;
      • setBucketBytes

        public TransferInfo.Builder setBucketBytes​(com.google.protobuf.ByteString value)
        optional string bucket = 4;
      • setObjectNameBytes

        public TransferInfo.Builder setObjectNameBytes​(com.google.protobuf.ByteString value)
        optional string objectName = 5;
      • setRemotePathBytes

        public TransferInfo.Builder setRemotePathBytes​(com.google.protobuf.ByteString value)
        optional string remotePath = 6;
      • hasDirection

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

        public TransferInfo.Builder clearDirection()
        optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;
      • setTotalSize

        public TransferInfo.Builder setTotalSize​(long value)
        optional uint64 totalSize = 8;
      • setSizeTransferred

        public TransferInfo.Builder setSizeTransferred​(long value)
        optional uint64 sizeTransferred = 9;
      • clearSizeTransferred

        public TransferInfo.Builder clearSizeTransferred()
        optional uint64 sizeTransferred = 9;
      • 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
      • setReliable

        public TransferInfo.Builder setReliable​(boolean value)
        reliable = true -> class 2 transfer
        reliable = false -> class 1 transfer
         
        optional bool reliable = 10;
      • clearReliable

        public TransferInfo.Builder clearReliable()
        reliable = true -> class 2 transfer
        reliable = false -> class 1 transfer
         
        optional bool reliable = 10;
      • 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
      • setFailureReason

        public TransferInfo.Builder setFailureReason​(String value)
        in case the transcation is failed, this provides more information
         
        optional string failureReason = 11;
      • clearFailureReason

        public TransferInfo.Builder clearFailureReason()
        in case the transcation is failed, this provides more information
         
        optional string failureReason = 11;
      • setFailureReasonBytes

        public TransferInfo.Builder setFailureReasonBytes​(com.google.protobuf.ByteString value)
        in case the transcation is failed, this provides more information
         
        optional string failureReason = 11;
      • 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
      • setTransactionId

        public TransferInfo.Builder setTransactionId​(TransactionId value)
         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;
      • setTransactionId

        public TransferInfo.Builder setTransactionId​(TransactionId.Builder builderForValue)
         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;
      • mergeTransactionId

        public TransferInfo.Builder mergeTransactionId​(TransactionId value)
         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;
      • clearTransactionId

        public TransferInfo.Builder clearTransactionId()
         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;
      • getTransactionIdBuilder

        public TransactionId.Builder getTransactionIdBuilder()
         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;
      • 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
      • setCreationTime

        public TransferInfo.Builder setCreationTime​(com.google.protobuf.Timestamp value)
         when the transfer has been created. 
         
        optional .google.protobuf.Timestamp creationTime = 13;
      • setCreationTime

        public TransferInfo.Builder setCreationTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         when the transfer has been created. 
         
        optional .google.protobuf.Timestamp creationTime = 13;
      • mergeCreationTime

        public TransferInfo.Builder mergeCreationTime​(com.google.protobuf.Timestamp value)
         when the transfer has been created. 
         
        optional .google.protobuf.Timestamp creationTime = 13;
      • clearCreationTime

        public TransferInfo.Builder clearCreationTime()
         when the transfer has been created. 
         
        optional .google.protobuf.Timestamp creationTime = 13;
      • getCreationTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreationTimeBuilder()
         when the transfer has been created. 
         
        optional .google.protobuf.Timestamp creationTime = 13;
      • 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
      • setUnknownFields

        public final TransferInfo.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<TransferInfo.Builder>
      • mergeUnknownFields

        public final TransferInfo.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<TransferInfo.Builder>