Struct google_api_proto::google::cloud::gkebackup::v1::RestorePlan

pub struct RestorePlan {
    pub name: String,
    pub uid: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub description: String,
    pub backup_plan: String,
    pub cluster: String,
    pub restore_config: Option<RestoreConfig>,
    pub labels: BTreeMap<String, String>,
    pub etag: String,
    pub state: i32,
    pub state_reason: String,
}

The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.

Fields

name: String

Output only. The full name of the RestorePlan resource. Format: projects/*/locations/*/restorePlans/*.

uid: String

Output only. Server generated global unique identifier of UUID format.

create_time: Option<Timestamp>

Output only. The timestamp when this RestorePlan resource was created.

update_time: Option<Timestamp>

Output only. The timestamp when this RestorePlan resource was last updated.

description: String

Optional. User specified descriptive string for this RestorePlan.

backup_plan: String

Required. Immutable. A reference to the [BackupPlan][google.cloud.gkebackup.v1.BackupPlan] from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

cluster: String

Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster’s region must be the same as the RestorePlan. Valid formats:

• projects/*/locations/*/clusters/*
• projects/*/zones/*/clusters/*

restore_config: Option<RestoreConfig>

Required. Configuration of Restores created via this RestorePlan.

labels: BTreeMap<String, String>

Optional. A set of custom labels supplied by user.

etag: String

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

state: i32

Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

state_reason: String

Output only. Human-readable description of why RestorePlan is in the current state

Implementations

impl RestorePlan

pub fn state(&self) -> State

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

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for RestorePlan

fn clone(&self) -> RestorePlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RestorePlan

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

Formats the value using the given formatter.

impl Default for RestorePlan

fn default() -> Self

Returns the “default value” for a type.

impl Message for RestorePlan

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_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated 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 encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated 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 RestorePlan

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for RestorePlan