Struct BackupSchedule 

#[non_exhaustive]
pub struct BackupSchedule {
    pub name: String,
    pub spec: Option<BackupScheduleSpec>,
    pub retention_duration: Option<Duration>,
    pub encryption_config: Option<CreateBackupEncryptionConfig>,
    pub update_time: Option<Timestamp>,
    pub backup_type_spec: Option<BackupTypeSpec>,
    /* private fields */
}

BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10

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.

name: String

Identifier. Output only for the [CreateBackupSchedule][DatabaseAdmin.CreateBackupSchededule] operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length.

spec: Option<BackupScheduleSpec>

Optional. The schedule specification based on which the backup creations are triggered.

retention_duration: Option<Duration>

Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.

encryption_config: Option<CreateBackupEncryptionConfig>

Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.

update_time: Option<Timestamp>

Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.

backup_type_spec: Option<BackupTypeSpec>

Required. Backup type spec determines the type of backup that is created by the backup schedule. Currently, only full backups are supported.

Implementations

impl BackupSchedule

pub fn new() -> Self

Creates a new default instance.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = BackupSchedule::new().set_name(format!("projects/{project_id}/instances/{instance_id}/databases/{database_id}/backupSchedules/{schedule_id}"));

pub fn set_spec<T>(self, v: T) -> Self

where T: Into<BackupScheduleSpec>,

Sets the value of spec.

Example

use google_cloud_spanner_admin_database_v1::model::BackupScheduleSpec;
let x = BackupSchedule::new().set_spec(BackupScheduleSpec::default()/* use setters */);

pub fn set_or_clear_spec<T>(self, v: Option<T>) -> Self

where T: Into<BackupScheduleSpec>,

Sets or clears the value of spec.

Example

use google_cloud_spanner_admin_database_v1::model::BackupScheduleSpec;
let x = BackupSchedule::new().set_or_clear_spec(Some(BackupScheduleSpec::default()/* use setters */));
let x = BackupSchedule::new().set_or_clear_spec(None::<BackupScheduleSpec>);

pub fn set_retention_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of retention_duration.

Example

use wkt::Duration;
let x = BackupSchedule::new().set_retention_duration(Duration::default()/* use setters */);

pub fn set_or_clear_retention_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of retention_duration.

Example

use wkt::Duration;
let x = BackupSchedule::new().set_or_clear_retention_duration(Some(Duration::default()/* use setters */));
let x = BackupSchedule::new().set_or_clear_retention_duration(None::<Duration>);

pub fn set_encryption_config<T>(self, v: T) -> Self

where T: Into<CreateBackupEncryptionConfig>,

Sets the value of encryption_config.

Example

use google_cloud_spanner_admin_database_v1::model::CreateBackupEncryptionConfig;
let x = BackupSchedule::new().set_encryption_config(CreateBackupEncryptionConfig::default()/* use setters */);

pub fn set_or_clear_encryption_config<T>(self, v: Option<T>) -> Self

where T: Into<CreateBackupEncryptionConfig>,

Sets or clears the value of encryption_config.

Example

use google_cloud_spanner_admin_database_v1::model::CreateBackupEncryptionConfig;
let x = BackupSchedule::new().set_or_clear_encryption_config(Some(CreateBackupEncryptionConfig::default()/* use setters */));
let x = BackupSchedule::new().set_or_clear_encryption_config(None::<CreateBackupEncryptionConfig>);

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = BackupSchedule::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = BackupSchedule::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = BackupSchedule::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_backup_type_spec<T: Into<Option<BackupTypeSpec>>>(self, v: T) -> Self

Sets the value of backup_type_spec.

Note that all the setters affecting backup_type_spec are mutually exclusive.

Example

use google_cloud_spanner_admin_database_v1::model::FullBackupSpec;
let x = BackupSchedule::new().set_backup_type_spec(Some(
    google_cloud_spanner_admin_database_v1::model::backup_schedule::BackupTypeSpec::FullBackupSpec(FullBackupSpec::default().into())));

pub fn full_backup_spec(&self) -> Option<&Box<FullBackupSpec>>

The value of backup_type_spec if it holds a FullBackupSpec, None if the field is not set or holds a different branch.

pub fn set_full_backup_spec<T: Into<Box<FullBackupSpec>>>(self, v: T) -> Self

Sets the value of backup_type_spec to hold a FullBackupSpec.

Note that all the setters affecting backup_type_spec are mutually exclusive.

Example

use google_cloud_spanner_admin_database_v1::model::FullBackupSpec;
let x = BackupSchedule::new().set_full_backup_spec(FullBackupSpec::default()/* use setters */);
assert!(x.full_backup_spec().is_some());
assert!(x.incremental_backup_spec().is_none());

pub fn incremental_backup_spec(&self) -> Option<&Box<IncrementalBackupSpec>>

The value of backup_type_spec if it holds a IncrementalBackupSpec, None if the field is not set or holds a different branch.

pub fn set_incremental_backup_spec<T: Into<Box<IncrementalBackupSpec>>>( self, v: T, ) -> Self

Sets the value of backup_type_spec to hold a IncrementalBackupSpec.

Note that all the setters affecting backup_type_spec are mutually exclusive.

Example

use google_cloud_spanner_admin_database_v1::model::IncrementalBackupSpec;
let x = BackupSchedule::new().set_incremental_backup_spec(IncrementalBackupSpec::default()/* use setters */);
assert!(x.incremental_backup_spec().is_some());
assert!(x.full_backup_spec().is_none());

Trait Implementations

impl Clone for BackupSchedule

fn clone(&self) -> BackupSchedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackupSchedule

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

Formats the value using the given formatter.

impl Default for BackupSchedule

fn default() -> BackupSchedule

Returns the “default value” for a type.

impl Message for BackupSchedule

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BackupSchedule

fn eq(&self, other: &BackupSchedule) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BackupSchedule