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

    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
    EntityInfo
    getLocalEntity()
    Local entity, may be empty if there is only one such entity.
    EntityInfoOrBuilder
    getLocalEntityOrBuilder()
    Local entity, may be empty if there is only one such entity.
    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
    EntityInfo
    getRemoteEntity()
    Remote entity, may be empty if there is only one such entity.
    EntityInfoOrBuilder
    getRemoteEntityOrBuilder()
    Remote entity, may be empty if there is only one such entity.
    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
    String
    getTransferType()
    depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.
    com.google.protobuf.ByteString
    getTransferTypeBytes()
    depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.
    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
    hasLocalEntity()
    Local entity, may be empty if there is only one such entity.
    boolean
    hasObjectName()
    optional string objectName = 5;
    boolean
    hasReliable()
    reliable = true -> class 2 transfer reliable = false -> class 1 transfer
    boolean
    hasRemoteEntity()
    Remote entity, may be empty if there is only one such entity.
    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
    boolean
    hasTransferType()
    depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.

    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 Details

    • hasId

      boolean hasId()
      unique identifier assigned by the file transfer service
      optional uint64 id = 1;
      Returns:
      Whether the id field is set.

    • getId

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

    • hasStartTime

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

    • 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;
      Returns:
      The startTime.

    • 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;
      Returns:
      Whether the state field is set.

    • getState

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

    • hasBucket

      boolean hasBucket()
      optional string bucket = 4;
      Returns:
      Whether the bucket field is set.

    • getBucket

      String getBucket()
      optional string bucket = 4;
      Returns:
      The bucket.

    • getBucketBytes

      com.google.protobuf.ByteString getBucketBytes()
      optional string bucket = 4;
      Returns:
      The bytes for bucket.

    • hasObjectName

      boolean hasObjectName()
      optional string objectName = 5;
      Returns:
      Whether the objectName field is set.

    • getObjectName

      String getObjectName()
      optional string objectName = 5;
      Returns:
      The objectName.

    • getObjectNameBytes

      com.google.protobuf.ByteString getObjectNameBytes()
      optional string objectName = 5;
      Returns:
      The bytes for objectName.

    • hasRemotePath

      boolean hasRemotePath()
      optional string remotePath = 6;
      Returns:
      Whether the remotePath field is set.

    • getRemotePath

      String getRemotePath()
      optional string remotePath = 6;
      Returns:
      The remotePath.

    • getRemotePathBytes

      com.google.protobuf.ByteString getRemotePathBytes()
      optional string remotePath = 6;
      Returns:
      The bytes for remotePath.

    • hasDirection

      boolean hasDirection()
      optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;
      Returns:
      Whether the direction field is set.

    • getDirection

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

    • hasTotalSize

      boolean hasTotalSize()
      optional uint64 totalSize = 8;
      Returns:
      Whether the totalSize field is set.

    • getTotalSize

      long getTotalSize()
      optional uint64 totalSize = 8;
      Returns:
      The totalSize.

    • hasSizeTransferred

      boolean hasSizeTransferred()
      optional uint64 sizeTransferred = 9;
      Returns:
      Whether the sizeTransferred field is set.

    • getSizeTransferred

      long getSizeTransferred()
      optional uint64 sizeTransferred = 9;
      Returns:
      The sizeTransferred.

    • hasReliable

      boolean hasReliable()
      reliable = true -> class 2 transfer
reliable = false -> class 1 transfer
      optional bool reliable = 10;
      Returns:
      Whether the reliable field is set.

    • getReliable

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

    • hasFailureReason

      boolean hasFailureReason()
      in case the transcation is failed, this provides more information
      optional string failureReason = 11;
      Returns:
      Whether the failureReason field is set.

    • getFailureReason

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

    • getFailureReasonBytes

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

    • 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;
      Returns:
      Whether the transactionId field is set.

    • 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;
      Returns:
      The transactionId.

    • 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;
      Returns:
      Whether the creationTime field is set.

    • getCreationTime

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

    • getCreationTimeOrBuilder

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

    • hasTransferType

      boolean hasTransferType()
       depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.
      optional string transferType = 14;
      Returns:
      Whether the transferType field is set.

    • getTransferType

      String getTransferType()
       depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.
      optional string transferType = 14;
      Returns:
      The transferType.

    • getTransferTypeBytes

      com.google.protobuf.ByteString getTransferTypeBytes()
       depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.
      optional string transferType = 14;
      Returns:
      The bytes for transferType.

    • hasLocalEntity

      boolean hasLocalEntity()
       Local entity, may be empty if there is only one such entity.
      optional .yamcs.protobuf.filetransfer.EntityInfo localEntity = 15;
      Returns:
      Whether the localEntity field is set.

    • getLocalEntity

      EntityInfo getLocalEntity()
       Local entity, may be empty if there is only one such entity.
      optional .yamcs.protobuf.filetransfer.EntityInfo localEntity = 15;
      Returns:
      The localEntity.

    • getLocalEntityOrBuilder

      EntityInfoOrBuilder getLocalEntityOrBuilder()
       Local entity, may be empty if there is only one such entity.
      optional .yamcs.protobuf.filetransfer.EntityInfo localEntity = 15;

    • hasRemoteEntity

      boolean hasRemoteEntity()
       Remote entity, may be empty if there is only one such entity.
      optional .yamcs.protobuf.filetransfer.EntityInfo remoteEntity = 16;
      Returns:
      Whether the remoteEntity field is set.

    • getRemoteEntity

      EntityInfo getRemoteEntity()
       Remote entity, may be empty if there is only one such entity.
      optional .yamcs.protobuf.filetransfer.EntityInfo remoteEntity = 16;
      Returns:
      The remoteEntity.

    • getRemoteEntityOrBuilder

      EntityInfoOrBuilder getRemoteEntityOrBuilder()
       Remote entity, may be empty if there is only one such entity.
      optional .yamcs.protobuf.filetransfer.EntityInfo remoteEntity = 16;