Struct b2_client::file::UpdateFileRetentionBuilder

pub struct UpdateFileRetentionBuilder<'a> { /* private fields */ }

A builder for an UpdateFileRetention request.

Implementations

impl<'a> UpdateFileRetentionBuilder<'a>

pub fn file(self, file: &'a File) -> Self

The file to update.

pub fn file_name(
    self,
    file_name: &'a str
) -> Result<Self, FileNameValidationError>

The name of the file to update.

The file ID is also required.

pub fn file_id(self, file_id: &'a str) -> Self

The ID of the file to update.

The file name is also required.

pub fn file_retention(self, retention: FileRetentionSetting) -> Self

The new file retention settings for the file.

See https://www.backblaze.com/b2/docs/file_lock.html#b2_api_file_lock_parameters for more information.

pub fn bypass_governance(self) -> Self

Bypass governance rules to allow deleting or shortening an existing governance-mode retention setting.

The authorization must include Capability::BypassGovernance.

pub fn build(self) -> Result<UpdateFileRetention<'a>, MissingData>

Create an UpdateFileRetention request.

Trait Implementations

impl<'a> Default for UpdateFileRetentionBuilder<'a>

fn default() -> UpdateFileRetentionBuilder<'a>

Returns the “default value” for a type.