Struct ReportArgs

Source

pub struct ReportArgs {
    pub bytes_uploaded: Option<i64>,
    pub error: Option<String>,
    pub outcome: RunOutcome,
    pub purpose: 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_id: Option<String>,
    pub type_: String,
}

Expand description

Report of a completed backup or restore run.

JSON schema

{
 "description": "Report of a completed backup or restore run.",
 "type": "object",
 "required": [
   "outcome",
   "purpose",
   "run_id",
   "type"
 ],
 "properties": {
   "bytes_uploaded": {
     "description": "Total bytes of backup data uploaded during the run, if known.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "error": {
     "description": "Human-readable error detail, when the run failed.",
     "type": [
       "string",
       "null"
     ]
   },
   "outcome": {
     "description": "Whether the run succeeded (`success`) or failed (`failure`).",
     "$ref": "#/components/schemas/RunOutcome"
   },
   "purpose": {
     "description": "Whether the run was a `backup` or a `restore`.",
     "$ref": "#/components/schemas/BackupPurpose"
   },
   "run_id": {
     "description": "Client-generated UUID identifying this run, minted at run start. Each\nrun must use a fresh UUID: reporting the same `run_id` twice is\nrejected with 409.",
     "type": "string",
     "format": "uuid"
   },
   "s3_received_payload_bytes": {
     "description": "Bytes of decoded object payload received from S3 during the run.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "s3_received_raw_bytes": {
     "description": "Bytes of raw HTTP traffic received from S3 during the run, including\nprotocol overhead.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "s3_sent_payload_bytes": {
     "description": "Bytes of decoded object payload sent to S3 during the run (excluding\nprotocol and signing overhead).",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "s3_sent_raw_bytes": {
     "description": "Bytes of raw HTTP traffic sent to S3 during the run, including protocol\nand signing overhead. Report on both success and failure; omit when\ntraffic was not measured.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64"
   },
   "snapshot_id": {
     "description": "Identifier of the repository snapshot the run produced, for a\nsuccessful backup.",
     "type": [
       "string",
       "null"
     ]
   },
   "type": {
     "description": "The backup type that ran (e.g. `tamanu-postgres`).",
     "type": "string"
   }
 }
}

Fields§

§bytes_uploaded: Option<i64>

Total bytes of backup data uploaded during the run, if known.

§error: Option<String>

Human-readable error detail, when the run failed.

§outcome: RunOutcome

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

§purpose: BackupPurpose

Whether the run was a backup or a restore.

§run_id: Uuid

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.

§s3_received_payload_bytes: Option<i64>

Bytes of decoded object payload received from S3 during the run.

§s3_received_raw_bytes: Option<i64>

Bytes of raw HTTP traffic received from S3 during the run, including protocol overhead.

§s3_sent_payload_bytes: Option<i64>

Bytes of decoded object payload sent to S3 during the run (excluding protocol and signing overhead).

§s3_sent_raw_bytes: Option<i64>

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.

§snapshot_id: Option<String>

Identifier of the repository snapshot the run produced, for a successful backup.

§type_: String

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

ReportArgs

Struct ReportArgs Copy item path

Fields§

Trait Implementations§

impl Clone for ReportArgs

fn clone(&self) -> ReportArgs

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

impl Debug for ReportArgs

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

impl<'de> Deserialize<'de> for ReportArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl Serialize for ReportArgs

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

Auto Trait Implementations§

impl Freeze for ReportArgs

impl RefUnwindSafe for ReportArgs

impl Send for ReportArgs

impl Sync for ReportArgs

impl Unpin for ReportArgs

impl UnsafeUnpin for ReportArgs

impl UnwindSafe for ReportArgs

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DTwhere ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DTwhere ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Struct ReportArgs

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,