Class BackupPlan
Defines the configuration and scheduling for a "line" of Backups.
Implements
Inherited Members
Namespace: Google.Apis.BackupforGKE.v1.Data
Assembly: Google.Apis.BackupforGKE.v1.dll
Syntax
public class BackupPlan : IDirectResponseSchema
Properties
BackupChannel
Output only. The fully qualified name of the BackupChannel to be used to create a backup. This field is set
only if the cluster being backed up is in a different project. projects/*/locations/*/backupChannels/*
Declaration
[JsonProperty("backupChannel")]
public virtual string BackupChannel { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
BackupConfig
Optional. Defines the configuration of Backups created via this BackupPlan.
Declaration
[JsonProperty("backupConfig")]
public virtual BackupConfig BackupConfig { get; set; }
Property Value
| Type | Description |
|---|---|
| BackupConfig |
BackupSchedule
Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
Declaration
[JsonProperty("backupSchedule")]
public virtual Schedule BackupSchedule { get; set; }
Property Value
| Type | Description |
|---|---|
| Schedule |
Cluster
Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid
formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
Declaration
[JsonProperty("cluster")]
public virtual string Cluster { 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. The timestamp when this BackupPlan resource was created.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Deactivated
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
Declaration
[JsonProperty("deactivated")]
public virtual bool? Deactivated { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
Description
Optional. User specified descriptive string for this BackupPlan.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ETag
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.
Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Labels
Optional. A set of custom labels supplied by user.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
| Type | Description |
|---|---|
| IDictionary<string, string> |
LastSuccessfulBackupTime
object representation of LastSuccessfulBackupTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastSuccessfulBackupTimeDateTimeOffset instead.")]
public virtual object LastSuccessfulBackupTime { get; set; }
Property Value
| Type | Description |
|---|---|
| object |
LastSuccessfulBackupTimeDateTimeOffset
DateTimeOffset representation of LastSuccessfulBackupTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastSuccessfulBackupTimeDateTimeOffset { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTimeOffset? |
LastSuccessfulBackupTimeRaw
Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. This field is added to maintain consistency with BackupPlanBinding to display last successful backup time.
Declaration
[JsonProperty("lastSuccessfulBackupTime")]
public virtual string LastSuccessfulBackupTimeRaw { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Name
Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ProtectedPodCount
Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
Declaration
[JsonProperty("protectedPodCount")]
public virtual int? ProtectedPodCount { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
RetentionPolicy
Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
Declaration
[JsonProperty("retentionPolicy")]
public virtual RetentionPolicy RetentionPolicy { get; set; }
Property Value
| Type | Description |
|---|---|
| RetentionPolicy |
RpoRiskLevel
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.
Declaration
[JsonProperty("rpoRiskLevel")]
public virtual int? RpoRiskLevel { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
RpoRiskReason
Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.
Declaration
[JsonProperty("rpoRiskReason")]
public virtual string RpoRiskReason { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
State
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
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
StateReason
Output only. Human-readable description of why BackupPlan is in the current state. This field is only
meant for human readability and should not be used programmatically as this field is not guaranteed to be
consistent.
Declaration
[JsonProperty("stateReason")]
public virtual string StateReason { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Uid
Output only. Server generated global unique identifier of UUID format.
Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
| Type | Description |
|---|---|
| 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. The timestamp when this BackupPlan resource was last updated.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
| Type | Description |
|---|---|
| string |