Struct BackupCredentialsArgsBuilder 

pub struct BackupCredentialsArgsBuilder<S: State = Empty> { /* private fields */ }

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

Implementations

impl<S: State> BackupCredentialsArgsBuilder<S>

pub fn build(self) -> BackupCredentialsArgs

where S: IsComplete,

Finish building and return the requested object

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

where S::Purpose: IsUnset,

Optional (Some / Option setters). What the credentials will be used for. backup (the default) grants write access for uploading backups; restore grants strictly read-only access. Either way the credentials are scoped to the group’s backup storage only.

pub fn maybe_purpose( self, value: Option<BackupPurpose>, ) -> BackupCredentialsArgsBuilder<SetPurpose<S>>

where S::Purpose: IsUnset,

Optional (Some / Option setters). What the credentials will be used for. backup (the default) grants write access for uploading backups; restore grants strictly read-only access. Either way the credentials are scoped to the group’s backup storage only.

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

where S::RunId: IsUnset,

Optional (Some / Option setters). This must be the run-uuid the client minted for this run. The field is optional only so older clients don’t break; it WILL be made mandatory in future.

pub fn maybe_run_id( self, value: Option<Uuid>, ) -> BackupCredentialsArgsBuilder<SetRunId<S>>

where S::RunId: IsUnset,

Optional (Some / Option setters). This must be the run-uuid the client minted for this run. The field is optional only so older clients don’t break; it WILL be made mandatory in future.

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

where S::Type: IsUnset,

Required.

The backup type the credentials are for (e.g. tamanu-postgres). For a backup, the type must be an enabled capability of this server or the subject of a pending “backup now” request; for a restore, the server’s restore window must be open (an operator allows restores for it in canopy). Otherwise the request is rejected with 409.