View Source GoogleApi.BackupDR.V1.Model.BackupPlan (google_api_backup_dr v0.14.2)

A BackupPlan specifies some common fields, such as description as well as one or more BackupRule messages. Each BackupRule has a retention policy and defines a schedule by which the system is to perform backup workloads.

Attributes

backupRules (type: list(GoogleApi.BackupDR.V1.Model.BackupRule.t), default: nil) - Required. The backup rules for this BackupPlan. There must be at least one BackupRule message.
backupVault (type: String.t, default: nil) - Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
backupVaultServiceAccount (type: String.t, default: nil) - Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
createTime (type: DateTime.t, default: nil) - Output only. When the BackupPlan was created.
description (type: String.t, default: nil) - Optional. The description of the BackupPlan resource. The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
etag (type: String.t, default: nil) - Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
labels (type: map(), default: nil) - Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
name (type: String.t, default: nil) - Output only. Identifier. The resource name of the BackupPlan. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}
resourceType (type: String.t, default: nil) - Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
state (type: String.t, default: nil) - Output only. The State for the BackupPlan.
updateTime (type: DateTime.t, default: nil) - Output only. When the BackupPlan was last updated.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.BackupDR.V1.Model.BackupPlan{
  backupRules: [GoogleApi.BackupDR.V1.Model.BackupRule.t()] | nil,
  backupVault: String.t() | nil,
  backupVaultServiceAccount: String.t() | nil,
  createTime: DateTime.t() | nil,
  description: String.t() | nil,
  etag: String.t() | nil,
  labels: map() | nil,
  name: String.t() | nil,
  resourceType: String.t() | nil,
  state: String.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.