Class: Google::Cloud::GkeBackup::V1::BackupPlan

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/gkebackup/v1/backup_plan.rb

Overview

Defines the configuration and scheduling for a "line" of Backups.

Defined Under Namespace

Modules: State Classes: BackupConfig, LabelsEntry, RetentionPolicy, Schedule

Instance Attribute Summary collapse

Instance Attribute Details

#backup_config ⇒ ::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig

Returns Optional. Defines the configuration of Backups created via this BackupPlan.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#backup_schedule ⇒ ::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule

Returns Optional. Defines a schedule for automatic Backup creation via this BackupPlan.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#cluster ⇒ ::String

Returns Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*.

Returns:

  • (::String) —

    Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:

    • projects/*/locations/*/clusters/*
    • projects/*/zones/*/clusters/*


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when this BackupPlan resource was created.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#deactivated ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#description ⇒ ::String

Returns Optional. User specified descriptive string for this BackupPlan.

Returns:

  • (::String) —

    Optional. User specified descriptive string for this BackupPlan.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#etag ⇒ ::String (readonly)

Returns 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.

Returns:

  • (::String) —

    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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. A set of custom labels supplied by user.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. A set of custom labels supplied by user.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*.

Returns:

  • (::String) —

    Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#protected_pod_count ⇒ ::Integer (readonly)

Returns Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

Returns:

  • (::Integer) —

    Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#retention_policy ⇒ ::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy

Returns Optional. RetentionPolicy governs lifecycle of Backups created under this plan.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#rpo_risk_level ⇒ ::Integer (readonly)

Returns 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.

Returns:

  • (::Integer) —

    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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#rpo_risk_reason ⇒ ::String (readonly)

Returns Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.

Returns:

  • (::String) —

    Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#state ⇒ ::Google::Cloud::GkeBackup::V1::BackupPlan::State (readonly)

Returns 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.

Returns:

  • (::Google::Cloud::GkeBackup::V1::BackupPlan::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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#state_reason ⇒ ::String (readonly)

Returns Output only. Human-readable description of why BackupPlan is in the current state.

Returns:

  • (::String) —

    Output only. Human-readable description of why BackupPlan is in the current state



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. Server generated global unique identifier of UUID format.

Returns:

  • (::String) —

    Output only. Server generated global unique identifier of UUID format.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when this BackupPlan resource was last updated.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 106

class BackupPlan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # RetentionPolicy defines a Backup retention policy for a BackupPlan.
  # @!attribute [rw] backup_delete_lock_days
  #   @return [::Integer]
  #     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)
  # @!attribute [rw] backup_retain_days
  #   @return [::Integer]
  #     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. Updating this field does NOT affect existing Backups
  #     under it. Backups created AFTER a successful update will automatically
  #     pick up the new value. NOTE: backup_retain_days must be >=
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
  #     If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     is defined, then this must be
  #     <= 360 * the creation interval. If
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config} is
  #     defined, then this must be
  #     <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
  #     (1440minutes/day).
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     Optional. This flag denotes whether the retention policy of this
  #     BackupPlan is locked.  If set to True, no further update is allowed on
  #     this policy, including the `locked` field itself.
  #
  #     Default: False
  class RetentionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines scheduling parameters for automatically creating Backups
  # via this BackupPlan.
  # @!attribute [rw] cron_schedule
  #   @return [::String]
  #     Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that
  #     defines a repeating schedule for creating Backups via this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#rpo_config rpo_config}
  #     field since at most one schedule can be defined for a BackupPlan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [rw] paused
  #   @return [::Boolean]
  #     Optional. This flag denotes whether automatic Backup creation is paused
  #     for this BackupPlan.
  #
  #     Default: False
  # @!attribute [rw] rpo_config
  #   @return [::Google::Cloud::GkeBackup::V1::RpoConfig]
  #     Optional. Defines the RPO schedule configuration for this BackupPlan.
  #     This is mutually exclusive with the
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
  #     field since at most one schedule can be defined for a BackupPLan. If this
  #     is defined, then
  #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
  #     must also be defined.
  #
  #     Default (empty): no automatic backup creation will occur.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # BackupConfig defines the configuration of Backups created via this
  # BackupPlan.
  # @!attribute [rw] all_namespaces
  #   @return [::Boolean]
  #     If True, include all namespaced resources
  # @!attribute [rw] selected_namespaces
  #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
  #     If set, include just the resources in the listed namespaces.
  # @!attribute [rw] selected_applications
  #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
  #     If set, include just the resources referenced by the listed
  #     ProtectedApplications.
  # @!attribute [rw] include_volume_data
  #   @return [::Boolean]
  #     Optional. This flag specifies whether volume data should be backed up
  #     when PVCs are included in the scope of a Backup.
  #
  #     Default: False
  # @!attribute [rw] include_secrets
  #   @return [::Boolean]
  #     Optional. This flag specifies whether Kubernetes Secret resources should
  #     be included when they fall into the scope of Backups.
  #
  #     Default: False
  # @!attribute [rw] encryption_key
  #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
  #     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.
  # @!attribute [rw] permissive_mode
  #   @return [::Boolean]
  #     Optional. If false, Backups will fail when Backup for GKE detects
  #     Kubernetes configuration that is non-standard or
  #     requires additional setup to restore.
  #
  #     Default: False
  class BackupConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State
  module State
    # Default first value for Enums.
    STATE_UNSPECIFIED = 0

    # Waiting for cluster state to be RUNNING.
    CLUSTER_PENDING = 1

    # The BackupPlan is in the process of being created.
    PROVISIONING = 2

    # The BackupPlan has successfully been created and is ready for Backups.
    READY = 3

    # BackupPlan creation has failed.
    FAILED = 4

    # The BackupPlan has been deactivated.
    DEACTIVATED = 5

    # The BackupPlan is in the process of being deleted.
    DELETING = 6
  end
end