Struct ProgressArgs 

#[non_exhaustive]
pub struct ProgressArgs {

    pub bytes_cached: Option<i64>,
    pub bytes_estimated: Option<i64>,
    pub bytes_hashed: Option<i64>,
    pub bytes_read: Option<i64>,
    pub bytes_uploaded: Option<i64>,
    pub current_path: Option<String>,
    pub errors: Option<i64>,
    pub extra: Map<String, Value>,
    pub files_done: Option<i64>,
    pub files_estimated: Option<i64>,
    pub ignored_errors: Option<i64>,
    pub purpose: Option<BackupPurpose>,
    pub run_id: Uuid,
    pub s3_received_payload_bytes: Option<i64>,
    pub s3_received_raw_bytes: Option<i64>,
    pub s3_sent_payload_bytes: Option<i64>,
    pub s3_sent_raw_bytes: Option<i64>,
    pub snapshot_taken_at: Option<Timestamp>,
    pub type_: String,
}

A progress sample from a run still in flight.

JSON schema

{
 "description": "A progress sample from a run still in flight.",
 "type": "object",
 "required": [
   "run_id",
   "type"
 ],
 "properties": {
   "bytes_cached": {
     "description": "Bytes found already present in the repository, and so not re-uploaded.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "bytes_estimated": {
     "description": "Total bytes this run currently expects to handle. May be revised upward.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "bytes_hashed": {
     "description": "Bytes processed (hashed, compressed) so far.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "bytes_read": {
     "description": "Source bytes read so far.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "bytes_uploaded": {
     "description": "Bytes uploaded to the repository so far.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "current_path": {
     "description": "What the run is working on right now, for display.",
     "type": [
       "string",
       "null"
     ]
   },
   "errors": {
     "description": "Errors hit so far.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "extra": {
     "description": "Any further detail the backup engine emits. Canopy makes no commitment\nabout its shape: it is stored and shown verbatim, never interpreted.",
     "type": "object"
   },
   "files_done": {
     "description": "Files finished so far.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "files_estimated": {
     "description": "Total files this run currently expects to handle.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "ignored_errors": {
     "description": "Errors hit and deliberately ignored so far.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "purpose": {
     "description": "Whether this is a `backup` or a `restore` run.",
     "$ref": "#/components/schemas/BackupPurpose"
   },
   "run_id": {
     "description": "The run-uuid the client minted for this run — the same one it passes to\n`POST /backup-credentials` and reports under at `POST /backup-report`.",
     "type": "string",
     "format": "uuid"
   },
   "s3_received_payload_bytes": {
     "description": "Bytes of decoded object payload received from S3 so far.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "s3_received_raw_bytes": {
     "description": "Bytes of raw HTTP traffic received from S3 so far.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "s3_sent_payload_bytes": {
     "description": "Bytes of decoded object payload sent to S3 so far.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "s3_sent_raw_bytes": {
     "description": "Bytes of raw HTTP traffic sent to S3 so far, including protocol and\nsigning overhead.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "snapshot_taken_at": {
     "description": "When this run froze the data it is backing up — the point in time the\nbackup represents, as opposed to when its upload finishes. Send it as soon\nas it is known (before any transfer starts). Recorded once per run: the\nfirst value Canopy sees stands, whether it arrives here or on the report.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "$ref": "#/definitions/CanopyTimestamp"
       }
     ]
   },
   "type": {
     "description": "The backup type being run (e.g. `tamanu-postgres`).",
     "type": "string"
   }
 }
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bytes_cached: Option<i64>

Bytes found already present in the repository, and so not re-uploaded.

bytes_estimated: Option<i64>

Total bytes this run currently expects to handle. May be revised upward.

bytes_hashed: Option<i64>

Bytes processed (hashed, compressed) so far.

bytes_read: Option<i64>

Source bytes read so far.

bytes_uploaded: Option<i64>

Bytes uploaded to the repository so far.

current_path: Option<String>

What the run is working on right now, for display.

errors: Option<i64>

Errors hit so far.

extra: Map<String, Value>

Any further detail the backup engine emits. Canopy makes no commitment about its shape: it is stored and shown verbatim, never interpreted.

files_done: Option<i64>

Files finished so far.

files_estimated: Option<i64>

Total files this run currently expects to handle.

ignored_errors: Option<i64>

Errors hit and deliberately ignored so far.

purpose: Option<BackupPurpose>

Whether this is a backup or a restore run.

run_id: Uuid

The run-uuid the client minted for this run — the same one it passes to POST /backup-credentials and reports under at POST /backup-report.

s3_received_payload_bytes: Option<i64>

Bytes of decoded object payload received from S3 so far.

s3_received_raw_bytes: Option<i64>

Bytes of raw HTTP traffic received from S3 so far.

s3_sent_payload_bytes: Option<i64>

Bytes of decoded object payload sent to S3 so far.

s3_sent_raw_bytes: Option<i64>

Bytes of raw HTTP traffic sent to S3 so far, including protocol and signing overhead.

snapshot_taken_at: Option<Timestamp>

When this run froze the data it is backing up — the point in time the backup represents, as opposed to when its upload finishes. Send it as soon as it is known (before any transfer starts). Recorded once per run: the first value Canopy sees stands, whether it arrives here or on the report.

type_: String

The backup type being run (e.g. tamanu-postgres).

Implementations

impl ProgressArgs

pub fn builder() -> ProgressArgsBuilder

Create an instance of ProgressArgs using the builder syntax

Trait Implementations

impl Clone for ProgressArgs

fn clone(&self) -> ProgressArgs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProgressArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProgressArgs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.