org.yamcs.protobuf.TransferInfoOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: yamcs/protobuf/filetransfer/filetransfer.proto
package org.yamcs.protobuf;
public interface TransferInfoOrBuilder extends
// @@protoc_insertion_point(interface_extends:yamcs.protobuf.filetransfer.TransferInfo)
com.google.protobuf.MessageOrBuilder {
/**
*
*unique identifier assigned by the file transfer service
*
*
* optional uint64 id = 1;
* @return Whether the id field is set.
*/
boolean hasId();
/**
*
*unique identifier assigned by the file transfer service
*
*
* optional uint64 id = 1;
* @return The id.
*/
long getId();
/**
*
*when the transfer has started. Note that this will not be set for QUEUED transfers.
*
*
* optional .google.protobuf.Timestamp startTime = 2;
* @return Whether the startTime field is set.
*/
boolean hasStartTime();
/**
*
*when the transfer has started. Note that this will not be set for QUEUED transfers.
*
*
* optional .google.protobuf.Timestamp startTime = 2;
* @return The startTime.
*/
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;
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
* optional .yamcs.protobuf.filetransfer.TransferState state = 3;
* @return Whether the state field is set.
*/
boolean hasState();
/**
* optional .yamcs.protobuf.filetransfer.TransferState state = 3;
* @return The state.
*/
org.yamcs.protobuf.TransferState getState();
/**
* optional string bucket = 4;
* @return Whether the bucket field is set.
*/
boolean hasBucket();
/**
* optional string bucket = 4;
* @return The bucket.
*/
java.lang.String getBucket();
/**
* optional string bucket = 4;
* @return The bytes for bucket.
*/
com.google.protobuf.ByteString
getBucketBytes();
/**
* optional string objectName = 5;
* @return Whether the objectName field is set.
*/
boolean hasObjectName();
/**
* optional string objectName = 5;
* @return The objectName.
*/
java.lang.String getObjectName();
/**
* optional string objectName = 5;
* @return The bytes for objectName.
*/
com.google.protobuf.ByteString
getObjectNameBytes();
/**
* optional string remotePath = 6;
* @return Whether the remotePath field is set.
*/
boolean hasRemotePath();
/**
* optional string remotePath = 6;
* @return The remotePath.
*/
java.lang.String getRemotePath();
/**
* optional string remotePath = 6;
* @return The bytes for remotePath.
*/
com.google.protobuf.ByteString
getRemotePathBytes();
/**
* optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;
* @return Whether the direction field is set.
*/
boolean hasDirection();
/**
* optional .yamcs.protobuf.filetransfer.TransferDirection direction = 7;
* @return The direction.
*/
org.yamcs.protobuf.TransferDirection getDirection();
/**
* optional uint64 totalSize = 8;
* @return Whether the totalSize field is set.
*/
boolean hasTotalSize();
/**
* optional uint64 totalSize = 8;
* @return The totalSize.
*/
long getTotalSize();
/**
* optional uint64 sizeTransferred = 9;
* @return Whether the sizeTransferred field is set.
*/
boolean hasSizeTransferred();
/**
* optional uint64 sizeTransferred = 9;
* @return The sizeTransferred.
*/
long getSizeTransferred();
/**
*
*reliable = true -> class 2 transfer
*reliable = false -> class 1 transfer
*
*
* optional bool reliable = 10;
* @return Whether the reliable field is set.
*/
boolean hasReliable();
/**
*
*reliable = true -> class 2 transfer
*reliable = false -> class 1 transfer
*
*
* optional bool reliable = 10;
* @return The reliable.
*/
boolean getReliable();
/**
*
*in case the transcation is failed, this provides more information
*
*
* optional string failureReason = 11;
* @return Whether the failureReason field is set.
*/
boolean hasFailureReason();
/**
*
*in case the transcation is failed, this provides more information
*
*
* optional string failureReason = 11;
* @return The failureReason.
*/
java.lang.String getFailureReason();
/**
*
*in case the transcation is failed, this provides more information
*
*
* optional string failureReason = 11;
* @return The bytes for failureReason.
*/
com.google.protobuf.ByteString
getFailureReasonBytes();
/**
*
* 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;
* @return Whether the transactionId field is set.
*/
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;
* @return The transactionId.
*/
org.yamcs.protobuf.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;
*/
org.yamcs.protobuf.TransactionIdOrBuilder getTransactionIdOrBuilder();
/**
*
* when the transfer has been created.
*
*
* optional .google.protobuf.Timestamp creationTime = 13;
* @return Whether the creationTime field is set.
*/
boolean hasCreationTime();
/**
*
* when the transfer has been created.
*
*
* optional .google.protobuf.Timestamp creationTime = 13;
* @return The creationTime.
*/
com.google.protobuf.Timestamp getCreationTime();
/**
*
* when the transfer has been created.
*
*
* optional .google.protobuf.Timestamp creationTime = 13;
*/
com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder();
/**
*
* depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.
*
*
* optional string transferType = 14;
* @return Whether the transferType field is set.
*/
boolean hasTransferType();
/**
*
* depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.
*
*
* optional string transferType = 14;
* @return The transferType.
*/
java.lang.String getTransferType();
/**
*
* depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.
*
*
* optional string transferType = 14;
* @return The bytes for transferType.
*/
com.google.protobuf.ByteString
getTransferTypeBytes();
/**
*
* Local entity, may be empty if there is only one such entity.
*
*
* optional .yamcs.protobuf.filetransfer.EntityInfo localEntity = 15;
* @return Whether the localEntity field is set.
*/
boolean hasLocalEntity();
/**
*
* Local entity, may be empty if there is only one such entity.
*
*
* optional .yamcs.protobuf.filetransfer.EntityInfo localEntity = 15;
* @return The localEntity.
*/
org.yamcs.protobuf.EntityInfo getLocalEntity();
/**
*
* Local entity, may be empty if there is only one such entity.
*
*
* optional .yamcs.protobuf.filetransfer.EntityInfo localEntity = 15;
*/
org.yamcs.protobuf.EntityInfoOrBuilder getLocalEntityOrBuilder();
/**
*
* Remote entity, may be empty if there is only one such entity.
*
*
* optional .yamcs.protobuf.filetransfer.EntityInfo remoteEntity = 16;
* @return Whether the remoteEntity field is set.
*/
boolean hasRemoteEntity();
/**
*
* Remote entity, may be empty if there is only one such entity.
*
*
* optional .yamcs.protobuf.filetransfer.EntityInfo remoteEntity = 16;
* @return The remoteEntity.
*/
org.yamcs.protobuf.EntityInfo getRemoteEntity();
/**
*
* Remote entity, may be empty if there is only one such entity.
*
*
* optional .yamcs.protobuf.filetransfer.EntityInfo remoteEntity = 16;
*/
org.yamcs.protobuf.EntityInfoOrBuilder getRemoteEntityOrBuilder();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy