Struct google_api_proto::google::cloud::gkebackup::v1::BackupPlan

pub struct BackupPlan {

    pub name: String,
    pub uid: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub description: String,
    pub cluster: String,
    pub retention_policy: Option<RetentionPolicy>,
    pub labels: BTreeMap<String, String>,
    pub backup_schedule: Option<Schedule>,
    pub etag: String,
    pub deactivated: bool,
    pub backup_config: Option<BackupConfig>,
    pub protected_pod_count: i32,
    pub state: i32,
    pub state_reason: String,
    pub rpo_risk_level: i32,
    pub rpo_risk_reason: String,
}

Defines the configuration and scheduling for a “line” of Backups.

Fields

name: String

Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

uid: String

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

create_time: Option<Timestamp>

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

update_time: Option<Timestamp>

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

description: String

Optional. User specified descriptive string for this BackupPlan.

cluster: String

Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:

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

retention_policy: Option<RetentionPolicy>

Optional. RetentionPolicy governs lifecycle of Backups created under this plan.

labels: BTreeMap<String, String>

Optional. A set of custom labels supplied by user.

backup_schedule: Option<Schedule>

Optional. Defines a schedule for automatic Backup creation via this BackupPlan.

etag: String

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

deactivated: bool

Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups).

Default: False

backup_config: Option<BackupConfig>

Optional. Defines the configuration of Backups created via this BackupPlan.

protected_pod_count: i32

Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

state: i32

Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to “DEACTIVATED” if the BackupPlan is deactivated on an Update

state_reason: String

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

rpo_risk_level: i32

Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.

rpo_risk_reason: String

Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.

Implementations

impl BackupPlan

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 BackupPlan

fn clone(&self) -> BackupPlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BackupPlan

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

Formats the value using the given formatter.

impl Default for BackupPlan

fn default() -> Self

Returns the “default value” for a type.

impl Message for BackupPlan

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for BackupPlan

fn eq(&self, other: &BackupPlan) -> 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 BackupPlan