- The number of processed blocks that have received an ACK response. Effectively, blocks which have been confirmed as received by the remote server.
- The block size, in bytes, used for transfers. Currently 256.
- The total number of blocks that have been transmitted, presumed lost in transit (i.e. packet loss).
- The total number of blocks sent for a transfer.
- The total number of bytes received for a transfer.
- The total number of bytes sent for a transfer.
- How frequently to take a checkpoint, in seconds. A checkpoint is a guarantee that files have been written to storage. If the receiver of a transfer is terminated and subsequently resumed, the transfer can safely continue from its last checkpoint. If checkpoints are disabled, this is
- A destination ID. Destination IDs are returned from createDestination, and used in other methods to refer to a specific destination.
- The directory that will be created as the parent for all files in the transfer. The manifest paths are respected, and added below this destination path.
- The timestamp at which a transfer ended. See Timestamps.
- If unsuccessful, this contains a description of the error that occurred. See
- A manifest ID. Manifest IDs are returned from
createManifest(), and used in other methods to refer to a specific manifest.
- The owner of this transfer. A transfer may be monitored or modified only by its owner, or by a superuser.
- The total number of packets received for a transfer.
- The total number of packets sent for a transfer.
- The priority of the transfer. Transfers with a lower priority value (e.g. 100) are (generally) transmitted before transfers with a higher value (e.g. 120). If not specified, a transfer will be assigned a default priority of 100.
- The priority lane of the transfer. Destinations maintain a list of priority lanes that each utilize a given percentage of the total sending bandwidth.
True, the JetStream server is still processing this item. Use the
waitForTransfer()method to monitor its progress.
- A timestamp indicating when a transfer was added to the queue. See Timestamps.
- A timestamp indicating when a transfer was requested. See Timestamps.
- The maximum send rate of this transfer in kilobits per second. Will be
Noneif no maximum rate is set for this transfer.
- A timestamp indicating when the information was recorded. JetStream captures a snapshot of its state once per second. See Timestamps.
- A timestamp indicating when a transfer was started. See Timestamps.
The status may be one of the following values:
- The transfer has been queued, but data has not been transmitted yet.
- Data is actively being transferred.
- The transfer was suspended. Use
resumeTransfer()to resume transmitting.
- The transfer is being resumed, but data is not being transmitted yet (the transfer is waiting in the queue).
- The transfer has been completed successfully.
- The transfer failed. The
errorMessagefield will contain a description of the error.
- The total number of blocks in a transfer.
- The total number of bytes in a transfer.
- Rate, in kilobits per second, that file data is being sent. This value can be directly compared to
- Rate, in kilobits per second, that file data is being read from disk.
- A transfer ID. Transfer IDs are returned from
createTransfer(), and used in other methods to refer to a specific transfer.
- Raw socket send rate, in kilobits per second.
- Rate, in kilobits per second, that data is being sent, including protocol overhead such as encryption. This value can be compared to the expected link speed.
- Rate, in kilobits per second, of file data being received and confirmed as received by the remote server. This value can be directly compared to
- Key-value map of user attached metadata. Use
deleteObjectUserData()to manipulate object user data.
For each transfer, the system time is recorded in
requestTime. The other times are internally
calculated as durations since
requestTime, so differences between reported times for a
particular transfer will always be accurate.
Times may not compare accurately against your system’s time, the JetStream sender’s current system time, or the times reported for different transfers, since any system can change its system time. A common source of time changes is NTP correcting clock drift.
Changed in version 1.4.3: Added transferSendRate, transferDataSendRate, transferThroughputRate keys.
Changed in version 1.5.1: Added transferFileReadRate, and transferNetSendRate keys.
Changed in version 1.6.1: Added sendRateMax, and priorityLane keys.
Changed in version 1.9.0: Added owner key.