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

Classes: BackupConfig, LabelsEntry, RetentionPolicy, Schedule

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Defines the configuration of Backups created via this BackupPlan.

Returns:



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
end

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

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

Returns:



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
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/*


86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
end

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

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

Returns:



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
end

#deactivated ⇒ ::Boolean

Returns 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) —

    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



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
end

#description ⇒ ::String

Returns User specified descriptive string for this BackupPlan.

Returns:

  • (::String) —

    User specified descriptive string for this BackupPlan.



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
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.



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
end

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

Returns A set of custom labels supplied by user.

Returns:

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

    A set of custom labels supplied by user.



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
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/*



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
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.



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
end

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

Returns RetentionPolicy governs lifecycle of Backups created under this plan.

Returns:



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
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.



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
end

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

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

Returns:



86
87
88
89
90
91
92
93
94
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
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 86

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.
  #     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}.
  #
  #     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

  # Schedule 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.
  #
  #     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
end