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.

Inheritance
object
BackupPlan
Implements
Inherited Members
Namespace: Google.Apis.Backupdr.v1.Data
Assembly: Google.Apis.Backupdr.v1.dll
Syntax
public class BackupPlan : IDirectResponseSchema

Properties

BackupRules

Optional. The backup rules for this BackupPlan.

Declaration
[JsonProperty("backupRules")]
public virtual IList<BackupRule> BackupRules { get; set; }
Property Value
Type Description
IList<BackupRule>

BackupVault

Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}

Declaration
[JsonProperty("backupVault")]
public virtual string BackupVault { get; set; }
Property Value
Type Description
string

BackupVaultServiceAccount

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.

Declaration
[JsonProperty("backupVaultServiceAccount")]
public virtual string BackupVaultServiceAccount { get; set; }
Property Value
Type Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. When the BackupPlan was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

Description

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.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

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.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

Labels

Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

LogRetentionDays

Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.

Declaration
[JsonProperty("logRetentionDays")]
public virtual long? LogRetentionDays { get; set; }
Property Value
Type Description
long?

MaxCustomOnDemandRetentionDays

Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.

Declaration
[JsonProperty("maxCustomOnDemandRetentionDays")]
public virtual int? MaxCustomOnDemandRetentionDays { get; set; }
Property Value
Type Description
int?

Name

Output only. Identifier. The resource name of the BackupPlan. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

ResourceType

Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".

Declaration
[JsonProperty("resourceType")]
public virtual string ResourceType { get; set; }
Property Value
Type Description
string

RevisionId

Output only. The user friendly revision ID of the BackupPlanRevision. Example: v0, v1, v2, etc.

Declaration
[JsonProperty("revisionId")]
public virtual string RevisionId { get; set; }
Property Value
Type Description
string

RevisionName

Output only. The resource id of the BackupPlanRevision. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}

Declaration
[JsonProperty("revisionName")]
public virtual string RevisionName { get; set; }
Property Value
Type Description
string

State

Output only. The State for the BackupPlan.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

SupportedResourceTypes

Output only. All resource types to which backupPlan can be applied.

Declaration
[JsonProperty("supportedResourceTypes")]
public virtual IList<string> SupportedResourceTypes { get; set; }
Property Value
Type Description
IList<string>

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. When the BackupPlan was last updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements