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 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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) 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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) 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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} 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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) 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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) 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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) 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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) 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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) 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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) 



95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 95

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]
  #     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]
  #     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.
  #
  #     Default: 0 (no automatic deletion)
  # @!attribute [rw] locked
  #   @return [::Boolean]
  #     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]
  #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
  #     repeating schedule for creating Backups via this 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]
  #     This flag denotes whether automatic Backup creation is paused for this
  #     BackupPlan.
  #
  #     Default: False
  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]
  #     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]
  #     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]
  #     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.
  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