You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/gkebackup_v1.projects.locations.backupChannels.backupPlanBindings.html
+50Lines changed: 50 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -109,10 +109,35 @@ <h3>Method Details</h3>
109
109
{ # A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.
110
110
"backupPlan": "A String", # Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. `projects/*/locations/*/backupPlans/{backup_plan}`
111
111
"backupPlanDetails": { # Contains metadata about the backup plan/backup. # Output only. Contains details about the backup plan/backup.
112
+
"backupConfigDetails": { # BackupConfigDetails defines the configuration of Backups created via this BackupPlan. # Output only. Contains details about the BackupConfig of Backups created via this BackupPlan.
113
+
"allNamespaces": True or False, # Output only. If True, include all namespaced resources
114
+
"encryptionKey": { # Defined a customer managed encryption key that will be used to encrypt Backup artifacts. # Output only. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
"includeSecrets": True or False, # Output only. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
118
+
"includeVolumeData": True or False, # Output only. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
119
+
"selectedApplications": { # A list of namespaced Kubernetes resources. # Output only. If set, include just the resources referenced by the listed ProtectedApplications.
120
+
"namespacedNames": [ # Optional. A list of namespaced Kubernetes resources.
121
+
{ # A reference to a namespaced resource in Kubernetes.
122
+
"name": "A String", # Optional. The name of the Kubernetes resource.
123
+
"namespace": "A String", # Optional. The Namespace of the Kubernetes resource.
124
+
},
125
+
],
126
+
},
127
+
"selectedNamespaces": { # A list of Kubernetes Namespaces. # Output only. If set, include just the resources in the listed namespaces.
128
+
"namespaces": [ # Optional. A list of Kubernetes Namespaces.
129
+
"A String",
130
+
],
131
+
},
132
+
},
112
133
"lastSuccessfulBackup": "A String", # Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/*/locations/*/backupPlans/*/backups/*`
113
134
"lastSuccessfulBackupTime": "A String", # Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field.
114
135
"nextScheduledBackupTime": "A String", # Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan.
115
136
"protectedPodCount": 42, # Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
137
+
"retentionPolicyDetails": { # RetentionPolicyDetails defines a Backup retention policy for a BackupPlan. # Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan.
138
+
"backupDeleteLockDays": 42, # Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
139
+
"backupRetainDays": 42, # Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Default: 0 (no automatic deletion)
140
+
},
116
141
"rpoRiskLevel": 42, # 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.
117
142
"state": "A String", # Output only. State of the BackupPlan.
118
143
},
@@ -148,10 +173,35 @@ <h3>Method Details</h3>
148
173
{ # A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.
149
174
"backupPlan": "A String", # Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. `projects/*/locations/*/backupPlans/{backup_plan}`
150
175
"backupPlanDetails": { # Contains metadata about the backup plan/backup. # Output only. Contains details about the backup plan/backup.
176
+
"backupConfigDetails": { # BackupConfigDetails defines the configuration of Backups created via this BackupPlan. # Output only. Contains details about the BackupConfig of Backups created via this BackupPlan.
177
+
"allNamespaces": True or False, # Output only. If True, include all namespaced resources
178
+
"encryptionKey": { # Defined a customer managed encryption key that will be used to encrypt Backup artifacts. # Output only. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
"includeSecrets": True or False, # Output only. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
182
+
"includeVolumeData": True or False, # Output only. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
183
+
"selectedApplications": { # A list of namespaced Kubernetes resources. # Output only. If set, include just the resources referenced by the listed ProtectedApplications.
184
+
"namespacedNames": [ # Optional. A list of namespaced Kubernetes resources.
185
+
{ # A reference to a namespaced resource in Kubernetes.
186
+
"name": "A String", # Optional. The name of the Kubernetes resource.
187
+
"namespace": "A String", # Optional. The Namespace of the Kubernetes resource.
188
+
},
189
+
],
190
+
},
191
+
"selectedNamespaces": { # A list of Kubernetes Namespaces. # Output only. If set, include just the resources in the listed namespaces.
192
+
"namespaces": [ # Optional. A list of Kubernetes Namespaces.
193
+
"A String",
194
+
],
195
+
},
196
+
},
151
197
"lastSuccessfulBackup": "A String", # Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/*/locations/*/backupPlans/*/backups/*`
152
198
"lastSuccessfulBackupTime": "A String", # Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field.
153
199
"nextScheduledBackupTime": "A String", # Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan.
154
200
"protectedPodCount": 42, # Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
201
+
"retentionPolicyDetails": { # RetentionPolicyDetails defines a Backup retention policy for a BackupPlan. # Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan.
202
+
"backupDeleteLockDays": 42, # Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
203
+
"backupRetainDays": 42, # Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Default: 0 (no automatic deletion)
204
+
},
155
205
"rpoRiskLevel": 42, # 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.
156
206
"state": "A String", # Output only. State of the BackupPlan.
Copy file name to clipboardExpand all lines: docs/dyn/gkebackup_v1.projects.locations.backupPlans.html
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -125,6 +125,7 @@ <h3>Method Details</h3>
125
125
The object takes the form of:
126
126
127
127
{ # Defines the configuration and scheduling for a "line" of Backups.
128
+
"backupChannel": "A String", # 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/*`
128
129
"backupConfig": { # BackupConfig defines the configuration of Backups created via this BackupPlan. # Optional. Defines the configuration of Backups created via this BackupPlan.
129
130
"allNamespaces": True or False, # If True, include all namespaced resources
130
131
"encryptionKey": { # Defined a customer managed encryption key that will be used to encrypt Backup artifacts. # Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
@@ -282,6 +283,7 @@ <h3>Method Details</h3>
282
283
An object of the form:
283
284
284
285
{ # Defines the configuration and scheduling for a "line" of Backups.
286
+
"backupChannel": "A String", # 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/*`
285
287
"backupConfig": { # BackupConfig defines the configuration of Backups created via this BackupPlan. # Optional. Defines the configuration of Backups created via this BackupPlan.
286
288
"allNamespaces": True or False, # If True, include all namespaced resources
287
289
"encryptionKey": { # Defined a customer managed encryption key that will be used to encrypt Backup artifacts. # Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
@@ -428,6 +430,7 @@ <h3>Method Details</h3>
428
430
{ # Response message for ListBackupPlans.
429
431
"backupPlans": [ # The list of BackupPlans matching the given criteria.
430
432
{ # Defines the configuration and scheduling for a "line" of Backups.
433
+
"backupChannel": "A String", # 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/*`
431
434
"backupConfig": { # BackupConfig defines the configuration of Backups created via this BackupPlan. # Optional. Defines the configuration of Backups created via this BackupPlan.
432
435
"allNamespaces": True or False, # If True, include all namespaced resources
433
436
"encryptionKey": { # Defined a customer managed encryption key that will be used to encrypt Backup artifacts. # Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
@@ -535,6 +538,7 @@ <h3>Method Details</h3>
535
538
The object takes the form of:
536
539
537
540
{ # Defines the configuration and scheduling for a "line" of Backups.
541
+
"backupChannel": "A String", # 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/*`
538
542
"backupConfig": { # BackupConfig defines the configuration of Backups created via this BackupPlan. # Optional. Defines the configuration of Backups created via this BackupPlan.
539
543
"allNamespaces": True or False, # If True, include all namespaced resources
540
544
"encryptionKey": { # Defined a customer managed encryption key that will be used to encrypt Backup artifacts. # Optional. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.
Copy file name to clipboardExpand all lines: docs/dyn/gkebackup_v1.projects.locations.restorePlans.html
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -134,6 +134,7 @@ <h3>Method Details</h3>
134
134
"a_key": "A String",
135
135
},
136
136
"name": "A String", # Output only. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`.
137
+
"restoreChannel": "A String", # Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the `backup_plan` is in a different project than the RestorePlan. Format: `projects/*/locations/*/restoreChannels/*`
137
138
"restoreConfig": { # Configuration of a restore. # Required. Configuration of Restores created via this RestorePlan.
138
139
"allNamespaces": True or False, # Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
139
140
"clusterResourceConflictPolicy": "A String", # Optional. Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty.
@@ -333,6 +334,7 @@ <h3>Method Details</h3>
333
334
"a_key": "A String",
334
335
},
335
336
"name": "A String", # Output only. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`.
337
+
"restoreChannel": "A String", # Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the `backup_plan` is in a different project than the RestorePlan. Format: `projects/*/locations/*/restoreChannels/*`
336
338
"restoreConfig": { # Configuration of a restore. # Required. Configuration of Restores created via this RestorePlan.
337
339
"allNamespaces": True or False, # Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
338
340
"clusterResourceConflictPolicy": "A String", # Optional. Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty.
@@ -521,6 +523,7 @@ <h3>Method Details</h3>
521
523
"a_key": "A String",
522
524
},
523
525
"name": "A String", # Output only. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`.
526
+
"restoreChannel": "A String", # Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the `backup_plan` is in a different project than the RestorePlan. Format: `projects/*/locations/*/restoreChannels/*`
524
527
"restoreConfig": { # Configuration of a restore. # Required. Configuration of Restores created via this RestorePlan.
525
528
"allNamespaces": True or False, # Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
526
529
"clusterResourceConflictPolicy": "A String", # Optional. Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty.
@@ -668,6 +671,7 @@ <h3>Method Details</h3>
668
671
"a_key": "A String",
669
672
},
670
673
"name": "A String", # Output only. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`.
674
+
"restoreChannel": "A String", # Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the `backup_plan` is in a different project than the RestorePlan. Format: `projects/*/locations/*/restoreChannels/*`
671
675
"restoreConfig": { # Configuration of a restore. # Required. Configuration of Restores created via this RestorePlan.
672
676
"allNamespaces": True or False, # Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
673
677
"clusterResourceConflictPolicy": "A String", # Optional. Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty.
0 commit comments