public sealed class BackupPlan : IMessage<BackupPlan>, IEquatable<BackupPlan>, IDeepCloneable<BackupPlan>, IBufferMessage, IMessageReference documentation and code samples for the Backup for GKE v1 API class BackupPlan.
Defines the configuration and scheduling for a "line" of Backups.
Implements
IMessageBackupPlan, IEquatableBackupPlan, IDeepCloneableBackupPlan, IBufferMessage, IMessageNamespace
Google.Cloud.GkeBackup.V1Assembly
Google.Cloud.GkeBackup.V1.dll
Constructors
BackupPlan()
public BackupPlan()BackupPlan(BackupPlan)
public BackupPlan(BackupPlan other)| Parameter | |
|---|---|
| Name | Description |
other | BackupPlan |
Properties
BackupConfig
public BackupPlan.Types.BackupConfig BackupConfig { get; set; }Defines the configuration of Backups created via this BackupPlan.
| Property Value | |
|---|---|
| Type | Description |
BackupPlanTypesBackupConfig | |
BackupPlanName
public BackupPlanName BackupPlanName { get; set; }BackupPlanName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
BackupPlanName | |
BackupSchedule
public BackupPlan.Types.Schedule BackupSchedule { get; set; }Defines a schedule for automatic Backup creation via this BackupPlan.
| Property Value | |
|---|---|
| Type | Description |
BackupPlanTypesSchedule | |
Cluster
public string Cluster { get; set; }Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:
projects/*/locations/*/clusters/*projects/*/zones/*/clusters/*
| Property Value | |
|---|---|
| Type | Description |
string | |
ClusterAsClusterName
public ClusterName ClusterAsClusterName { get; set; }ClusterName-typed view over the Cluster resource name property.
| Property Value | |
|---|---|
| Type | Description |
ClusterName | |
CreateTime
public Timestamp CreateTime { get; set; }Output only. The timestamp when this BackupPlan resource was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
Deactivated
public bool Deactivated { get; set; }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
| Property Value | |
|---|---|
| Type | Description |
bool | |
Description
public string Description { get; set; }User specified descriptive string for this BackupPlan.
| Property Value | |
|---|---|
| Type | Description |
string | |
Etag
public string Etag { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
Labels
public MapField<string, string> Labels { get; }A set of custom labels supplied by user.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
Name
public string Name { get; set; }Output only. The full name of the BackupPlan resource.
Format: projects/*/locations/*/backupPlans/*
| Property Value | |
|---|---|
| Type | Description |
string | |
ProtectedPodCount
public int ProtectedPodCount { get; set; }Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
| Property Value | |
|---|---|
| Type | Description |
int | |
RetentionPolicy
public BackupPlan.Types.RetentionPolicy RetentionPolicy { get; set; }RetentionPolicy governs lifecycle of Backups created under this plan.
| Property Value | |
|---|---|
| Type | Description |
BackupPlanTypesRetentionPolicy | |
State
public BackupPlan.Types.State State { get; set; }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
| Property Value | |
|---|---|
| Type | Description |
BackupPlanTypesState | |
StateReason
public string StateReason { get; set; }Output only. Human-readable description of why BackupPlan is in the current
state
| Property Value | |
|---|---|
| Type | Description |
string | |
Uid
public string Uid { get; set; }Output only. Server generated global unique identifier of UUID format.
| Property Value | |
|---|---|
| Type | Description |
string | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The timestamp when this BackupPlan resource was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |