Struct ReportArgsBuilder 

pub struct ReportArgsBuilder<S = Empty>
where
    S: State,
{ /* private fields */ }

Use builder syntax to set the inputs and finish with build().

Implementations

impl<S> ReportArgsBuilder<S>

where S: State,

pub fn build(self) -> ReportArgs

where S: IsComplete,

Finish building and return the requested object

pub fn bytes_uploaded( self, value: i64, ) -> ReportArgsBuilder<SetBytesUploaded<S>>

where <S as State>::BytesUploaded: IsUnset,

Optional (Some / Option setters). Total bytes of backup data uploaded during the run, if known.

pub fn maybe_bytes_uploaded( self, value: Option<i64>, ) -> ReportArgsBuilder<SetBytesUploaded<S>>

where <S as State>::BytesUploaded: IsUnset,

Optional (Some / Option setters). Total bytes of backup data uploaded during the run, if known.

pub fn error(self, value: String) -> ReportArgsBuilder<SetError<S>>

where <S as State>::Error: IsUnset,

Optional (Some / Option setters). Human-readable error detail, when the run failed.

pub fn maybe_error( self, value: Option<String>, ) -> ReportArgsBuilder<SetError<S>>

where <S as State>::Error: IsUnset,

Optional (Some / Option setters). Human-readable error detail, when the run failed.

pub fn outcome(self, value: RunOutcome) -> ReportArgsBuilder<SetOutcome<S>>

where <S as State>::Outcome: IsUnset,

Required.

Whether the run succeeded (success) or failed (failure).

pub fn purpose(self, value: BackupPurpose) -> ReportArgsBuilder<SetPurpose<S>>

where <S as State>::Purpose: IsUnset,

Required.

Whether the run was a backup or a restore.

pub fn run_id(self, value: Uuid) -> ReportArgsBuilder<SetRunId<S>>

where <S as State>::RunId: IsUnset,

Required.

Client-generated UUID identifying this run, minted at run start. Each run must use a fresh UUID: reporting the same run_id twice is rejected with 409.

pub fn s3_received_payload_bytes( self, value: i64, ) -> ReportArgsBuilder<SetS3ReceivedPayloadBytes<S>>

where <S as State>::S3ReceivedPayloadBytes: IsUnset,

Optional (Some / Option setters). Bytes of decoded object payload received from S3 during the run.

pub fn maybe_s3_received_payload_bytes( self, value: Option<i64>, ) -> ReportArgsBuilder<SetS3ReceivedPayloadBytes<S>>

where <S as State>::S3ReceivedPayloadBytes: IsUnset,

Optional (Some / Option setters). Bytes of decoded object payload received from S3 during the run.

pub fn s3_received_raw_bytes( self, value: i64, ) -> ReportArgsBuilder<SetS3ReceivedRawBytes<S>>

where <S as State>::S3ReceivedRawBytes: IsUnset,

Optional (Some / Option setters). Bytes of raw HTTP traffic received from S3 during the run, including protocol overhead.

pub fn maybe_s3_received_raw_bytes( self, value: Option<i64>, ) -> ReportArgsBuilder<SetS3ReceivedRawBytes<S>>

where <S as State>::S3ReceivedRawBytes: IsUnset,

Optional (Some / Option setters). Bytes of raw HTTP traffic received from S3 during the run, including protocol overhead.

pub fn s3_sent_payload_bytes( self, value: i64, ) -> ReportArgsBuilder<SetS3SentPayloadBytes<S>>

where <S as State>::S3SentPayloadBytes: IsUnset,

Optional (Some / Option setters). Bytes of decoded object payload sent to S3 during the run (excluding protocol and signing overhead).

pub fn maybe_s3_sent_payload_bytes( self, value: Option<i64>, ) -> ReportArgsBuilder<SetS3SentPayloadBytes<S>>

where <S as State>::S3SentPayloadBytes: IsUnset,

Optional (Some / Option setters). Bytes of decoded object payload sent to S3 during the run (excluding protocol and signing overhead).

pub fn s3_sent_raw_bytes( self, value: i64, ) -> ReportArgsBuilder<SetS3SentRawBytes<S>>

where <S as State>::S3SentRawBytes: IsUnset,

Optional (Some / Option setters). Bytes of raw HTTP traffic sent to S3 during the run, including protocol and signing overhead. Report on both success and failure; omit when traffic was not measured.

pub fn maybe_s3_sent_raw_bytes( self, value: Option<i64>, ) -> ReportArgsBuilder<SetS3SentRawBytes<S>>

where <S as State>::S3SentRawBytes: IsUnset,

Optional (Some / Option setters). Bytes of raw HTTP traffic sent to S3 during the run, including protocol and signing overhead. Report on both success and failure; omit when traffic was not measured.

pub fn snapshot_id(self, value: String) -> ReportArgsBuilder<SetSnapshotId<S>>

where <S as State>::SnapshotId: IsUnset,

Optional (Some / Option setters). Identifier of the repository snapshot the run produced, for a successful backup.

pub fn maybe_snapshot_id( self, value: Option<String>, ) -> ReportArgsBuilder<SetSnapshotId<S>>

where <S as State>::SnapshotId: IsUnset,

Optional (Some / Option setters). Identifier of the repository snapshot the run produced, for a successful backup.

pub fn snapshot_taken_at( self, value: Timestamp, ) -> ReportArgsBuilder<SetSnapshotTakenAt<S>>

where <S as State>::SnapshotTakenAt: IsUnset,

Optional (Some / Option setters). When this run froze the data it backed up — the point in time the backup represents, as opposed to when its upload finished. Often a filesystem-level snapshot taken before the transfer, in which case it is not recoverable from the repository and only the device can report it. Recorded once per run: if progress reports already carried it, that value stands.

pub fn maybe_snapshot_taken_at( self, value: Option<Timestamp>, ) -> ReportArgsBuilder<SetSnapshotTakenAt<S>>

where <S as State>::SnapshotTakenAt: IsUnset,

Optional (Some / Option setters). When this run froze the data it backed up — the point in time the backup represents, as opposed to when its upload finished. Often a filesystem-level snapshot taken before the transfer, in which case it is not recoverable from the repository and only the device can report it. Recorded once per run: if progress reports already carried it, that value stands.

pub fn type_(self, value: String) -> ReportArgsBuilder<SetType<S>>

where <S as State>::Type: IsUnset,

Required.

The backup type that ran (e.g. tamanu-postgres).