Struct RestoreDatabaseMetadata 

#[non_exhaustive]
pub struct RestoreDatabaseMetadata {
    pub name: String,
    pub source_type: RestoreSourceType,
    pub progress: Option<OperationProgress>,
    pub cancel_time: Option<Timestamp>,
    pub optimize_database_operation_name: String,
    pub source_info: Option<SourceInfo>,
    /* private fields */
}

Metadata type for the long-running operation returned by RestoreDatabase.

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

Name of the database being created and restored to.

source_type: RestoreSourceType

The type of the restore source.

progress: Option<OperationProgress>

The progress of the RestoreDatabase operation.

cancel_time: Option<Timestamp>

The time at which cancellation of this operation was received. [Operations.CancelOperation][google.longrunning.Operations.CancelOperation] starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

optimize_database_operation_name: String

If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation> where the <database> is the name of database being created and restored to. The metadata type of the long-running operation is OptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the RestoreDatabase long-running operation completes successfully. This operation will not be created if the restore was not successful.

source_info: Option<SourceInfo>

Information about the source used to restore the database, as specified by source in RestoreDatabaseRequest.

Implementations

impl RestoreDatabaseMetadata

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 = RestoreDatabaseMetadata::new().set_name(format!("projects/{project_id}/instances/{instance_id}/databases/{database_id}"));

pub fn set_source_type<T: Into<RestoreSourceType>>(self, v: T) -> Self

Sets the value of source_type.

Example

use google_cloud_spanner_admin_database_v1::model::RestoreSourceType;
let x0 = RestoreDatabaseMetadata::new().set_source_type(RestoreSourceType::Backup);

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

where T: Into<OperationProgress>,

Sets the value of progress.

Example

use google_cloud_spanner_admin_database_v1::model::OperationProgress;
let x = RestoreDatabaseMetadata::new().set_progress(OperationProgress::default()/* use setters */);

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

where T: Into<OperationProgress>,

Sets or clears the value of progress.

Example

use google_cloud_spanner_admin_database_v1::model::OperationProgress;
let x = RestoreDatabaseMetadata::new().set_or_clear_progress(Some(OperationProgress::default()/* use setters */));
let x = RestoreDatabaseMetadata::new().set_or_clear_progress(None::<OperationProgress>);

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

where T: Into<Timestamp>,

Sets the value of cancel_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of cancel_time.

Example

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

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

Sets the value of optimize_database_operation_name.

Example

let x = RestoreDatabaseMetadata::new().set_optimize_database_operation_name("example");

pub fn set_source_info<T: Into<Option<SourceInfo>>>(self, v: T) -> Self

Sets the value of source_info.

Note that all the setters affecting source_info are mutually exclusive.

Example

use google_cloud_spanner_admin_database_v1::model::BackupInfo;
let x = RestoreDatabaseMetadata::new().set_source_info(Some(
    google_cloud_spanner_admin_database_v1::model::restore_database_metadata::SourceInfo::BackupInfo(BackupInfo::default().into())));

pub fn backup_info(&self) -> Option<&Box<BackupInfo>>

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

pub fn set_backup_info<T: Into<Box<BackupInfo>>>(self, v: T) -> Self

Sets the value of source_info to hold a BackupInfo.

Note that all the setters affecting source_info are mutually exclusive.

Example

use google_cloud_spanner_admin_database_v1::model::BackupInfo;
let x = RestoreDatabaseMetadata::new().set_backup_info(BackupInfo::default()/* use setters */);
assert!(x.backup_info().is_some());

Trait Implementations

impl Clone for RestoreDatabaseMetadata

fn clone(&self) -> RestoreDatabaseMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RestoreDatabaseMetadata

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

Formats the value using the given formatter.

impl Default for RestoreDatabaseMetadata

fn default() -> RestoreDatabaseMetadata

Returns the “default value” for a type.

impl Message for RestoreDatabaseMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RestoreDatabaseMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RestoreDatabaseMetadata