Package org.yamcs.protobuf

Interface TransferInfoOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TransferInfo, TransferInfo.Builder
    public interface TransferInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getBucket()
      optional string bucket = 4;
      com.google.protobuf.ByteString getBucketBytes()
      optional string bucket = 4;
      com.google.protobuf.Timestamp getCreationTime()
      when the transfer has been created.
      com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder()
      when the transfer has been created.
      TransferDirection getDirection()
      optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;
      String getFailureReason()
      in case the transcation is failed, this provides more information
      com.google.protobuf.ByteString getFailureReasonBytes()
      in case the transcation is failed, this provides more information
      long getId()
      unique identifier assigned by the file transfer service
      String getObjectName()
      optional string objectName = 5;
      com.google.protobuf.ByteString getObjectNameBytes()
      optional string objectName = 5;
      boolean getReliable()
      reliable = true -> class 2 transfer reliable = false -> class 1 transfer
      String getRemotePath()
      optional string remotePath = 6;
      com.google.protobuf.ByteString getRemotePathBytes()
      optional string remotePath = 6;
      long getSizeTransferred()
      optional uint64 sizeTransferred = 9;
      com.google.protobuf.Timestamp getStartTime()
      when the transfer has started.
      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
      when the transfer has started.
      TransferState getState()
      optional .yamcs.protobuf.filetransfer.TransferState state = 3;
      long getTotalSize()
      optional uint64 totalSize = 8;
      TransactionId getTransactionId()
      valid for CFDP: transaction id; for the incoming transfers it is assigned by the remote peer so therefore might not be unique
      TransactionIdOrBuilder getTransactionIdOrBuilder()
      valid for CFDP: transaction id; for the incoming transfers it is assigned by the remote peer so therefore might not be unique
      boolean hasBucket()
      optional string bucket = 4;
      boolean hasCreationTime()
      when the transfer has been created.
      boolean hasDirection()
      optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;
      boolean hasFailureReason()
      in case the transcation is failed, this provides more information
      boolean hasId()
      unique identifier assigned by the file transfer service
      boolean hasObjectName()
      optional string objectName = 5;
      boolean hasReliable()
      reliable = true -> class 2 transfer reliable = false -> class 1 transfer
      boolean hasRemotePath()
      optional string remotePath = 6;
      boolean hasSizeTransferred()
      optional uint64 sizeTransferred = 9;
      boolean hasStartTime()
      when the transfer has started.
      boolean hasState()
      optional .yamcs.protobuf.filetransfer.TransferState state = 3;
      boolean hasTotalSize()
      optional uint64 totalSize = 8;
      boolean hasTransactionId()
      valid for CFDP: transaction id; for the incoming transfers it is assigned by the remote peer so therefore might not be unique

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • hasId

        boolean hasId()
        unique identifier assigned by the file transfer service
        optional uint64 id = 1;

      • getId

        long getId()
        unique identifier assigned by the file transfer service
        optional uint64 id = 1;

      • hasStartTime

        boolean hasStartTime()
        when the transfer has started. Note that this will not be set for QUEUED transfers.
        optional .google.protobuf.Timestamp startTime = 2;

      • getStartTime

        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;

      • getStartTimeOrBuilder

        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;

      • hasState

        boolean hasState()
        optional .yamcs.protobuf.filetransfer.TransferState state = 3;

      • getState

        TransferState getState()
        optional .yamcs.protobuf.filetransfer.TransferState state = 3;

      • hasBucket

        boolean hasBucket()
        optional string bucket = 4;

      • getBucket

        String getBucket()
        optional string bucket = 4;

      • getBucketBytes

        com.google.protobuf.ByteString getBucketBytes()
        optional string bucket = 4;

      • hasObjectName

        boolean hasObjectName()
        optional string objectName = 5;

      • getObjectName

        String getObjectName()
        optional string objectName = 5;

      • getObjectNameBytes

        com.google.protobuf.ByteString getObjectNameBytes()
        optional string objectName = 5;

      • hasRemotePath

        boolean hasRemotePath()
        optional string remotePath = 6;

      • getRemotePath

        String getRemotePath()
        optional string remotePath = 6;

      • getRemotePathBytes

        com.google.protobuf.ByteString getRemotePathBytes()
        optional string remotePath = 6;

      • hasDirection

        boolean hasDirection()
        optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;

      • getDirection

        TransferDirection getDirection()
        optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;

      • hasTotalSize

        boolean hasTotalSize()
        optional uint64 totalSize = 8;

      • getTotalSize

        long getTotalSize()
        optional uint64 totalSize = 8;

      • hasSizeTransferred

        boolean hasSizeTransferred()
        optional uint64 sizeTransferred = 9;

      • getSizeTransferred

        long getSizeTransferred()
        optional uint64 sizeTransferred = 9;

      • hasReliable

        boolean hasReliable()
        reliable = true -> class 2 transfer
reliable = false -> class 1 transfer
        optional bool reliable = 10;

      • getReliable

        boolean getReliable()
        reliable = true -> class 2 transfer
reliable = false -> class 1 transfer
        optional bool reliable = 10;

      • hasFailureReason

        boolean hasFailureReason()
        in case the transcation is failed, this provides more information
        optional string failureReason = 11;

      • getFailureReason

        String getFailureReason()
        in case the transcation is failed, this provides more information
        optional string failureReason = 11;

      • getFailureReasonBytes

        com.google.protobuf.ByteString getFailureReasonBytes()
        in case the transcation is failed, this provides more information
        optional string failureReason = 11;

      • hasTransactionId

        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;

      • getTransactionId

        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;

      • getTransactionIdOrBuilder

        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;

      • hasCreationTime

        boolean hasCreationTime()
         when the transfer has been created.
        optional .google.protobuf.Timestamp creationTime = 13;

      • getCreationTime

        com.google.protobuf.Timestamp getCreationTime()
         when the transfer has been created.
        optional .google.protobuf.Timestamp creationTime = 13;

      • getCreationTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder()
         when the transfer has been created.
        optional .google.protobuf.Timestamp creationTime = 13;