public sealed class BackupPlan : IMessage<BackupPlan>, IEquatable<BackupPlan>, IDeepCloneable<BackupPlan>, IBufferMessage, IMessageReference documentation and code samples for the Backup and DR Service v1 API class BackupPlan.
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.
Implements
IMessageBackupPlan, IEquatableBackupPlan, IDeepCloneableBackupPlan, IBufferMessage, IMessageNamespace
Google.Cloud.BackupDR.V1Assembly
Google.Cloud.BackupDR.V1.dll
Constructors
BackupPlan()
public BackupPlan()BackupPlan(BackupPlan)
public BackupPlan(BackupPlan other)| Parameter | |
|---|---|
| Name | Description |
other |
BackupPlan |
Properties
BackupPlanName
public BackupPlanName BackupPlanName { get; set; }BackupPlanName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
BackupPlanName |
|
BackupRules
public RepeatedField<BackupRule> BackupRules { get; }Required. The backup rules for this BackupPlan. There must be at least
one BackupRule message.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldBackupRule |
|
BackupVault
public string BackupVault { get; set; }Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
| Property Value | |
|---|---|
| Type | Description |
string |
|
BackupVaultAsBackupVaultName
public BackupVaultName BackupVaultAsBackupVaultName { get; set; }BackupVaultName-typed view over the BackupVault resource name property.
| Property Value | |
|---|---|
| Type | Description |
BackupVaultName |
|
BackupVaultServiceAccount
public string BackupVaultServiceAccount { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. When the BackupPlan was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Description
public string Description { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Etag
public string Etag { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Labels
public MapField<string, string> Labels { get; }Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Name
public string Name { get; set; }Output only. Identifier. The resource name of the BackupPlan.
Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}
| Property Value | |
|---|---|
| Type | Description |
string |
|
ResourceType
public string ResourceType { get; set; }Required. The resource type to which the BackupPlan will be applied.
Examples include, "compute.googleapis.com/Instance" and
"storage.googleapis.com/Bucket".
| Property Value | |
|---|---|
| Type | Description |
string |
|
State
public BackupPlan.Types.State State { get; set; }Output only. The State for the BackupPlan.
| Property Value | |
|---|---|
| Type | Description |
BackupPlanTypesState |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. When the BackupPlan was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|