Struct RestoreDatabaseMetadata

pub struct RestoreDatabaseMetadata {
    pub name: String,
    pub source_type: i32,
    pub progress: Option<OperationProgress>,
    pub cancel_time: Option<Timestamp>,
    pub optimize_database_operation_name: String,
    pub source_info: Option<SourceInfo>,
}

Metadata type for the long-running operation returned by [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].

Fields

name: String

Name of the database being created and restored to.

source_type: i32

The type of the restore source.

progress: Option<OperationProgress>

The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.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][google.longrunning.Operation.error] value with a [google.rpc.Status.code][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 is the name of database being created and restored to. The metadata type of the long-running operation is [OptimizeRestoredDatabaseMetadata][google.spanner.admin.database.v1.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][google.spanner.admin.database.v1.RestoreDatabaseRequest].

Implementations

impl RestoreDatabaseMetadata

pub fn source_type(&self) -> RestoreSourceType

Returns the enum value of source_type, or the default if the field is set to an invalid enum value.

pub fn set_source_type(&mut self, value: RestoreSourceType)

Sets source_type to the provided enum value.

Trait Implementations

impl Clone for RestoreDatabaseMetadata

fn clone(&self) -> RestoreDatabaseMetadata

Returns a copy 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 encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RestoreDatabaseMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RestoreDatabaseMetadata