Class: Google::Cloud::AlloyDB::V1::AutomatedBackupPolicy

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

Overview

Message describing the user-specified automated backup policy.

All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.

Defined Under Namespace

Classes: LabelsEntry, QuantityBasedRetention, TimeBasedRetention, WeeklySchedule

Instance Attribute Summary collapse

Instance Attribute Details

#backup_window ⇒ ::Google::Protobuf::Duration

Returns The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.

The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.

Returns:

  • (::Google::Protobuf::Duration) —

    The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.

    The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 191

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

  # A weekly schedule starts a backup at prescribed start times within a
  # day, for the specified days of the week.
  #
  # The weekly schedule message is flexible and can be used to create many
  # types of schedules. For example, to have a daily backup that starts at
  # 22:00, configure the `start_times` field to have one element "22:00" and
  # the `days_of_week` field to have all seven days of the week.
  # @!attribute [rw] start_times
  #   @return [::Array<::Google::Type::TimeOfDay>]
  #     The times during the day to start a backup. The start times are assumed
  #     to be in UTC and to be an exact hour (e.g., 04:00:00).
  #
  #     If no start times are provided, a single fixed start time is chosen
  #     arbitrarily.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     The days of the week to perform a backup.
  #
  #     If this field is left empty, the default of every day of the week is
  #     used.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A time based retention policy specifies that all backups within a certain
  # time period should be retained.
  # @!attribute [rw] retention_period
  #   @return [::Google::Protobuf::Duration]
  #     The retention period.
  class TimeBasedRetention
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A quantity based policy specifies that a certain number of the most recent
  # successful backups should be retained.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     The number of backups to retain.
  class QuantityBasedRetention
    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

#enabled ⇒ ::Boolean

Returns Whether automated automated backups are enabled. If not set, defaults to true.

Returns:

  • (::Boolean) —

    Whether automated automated backups are enabled. If not set, defaults to true.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 191

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

  # A weekly schedule starts a backup at prescribed start times within a
  # day, for the specified days of the week.
  #
  # The weekly schedule message is flexible and can be used to create many
  # types of schedules. For example, to have a daily backup that starts at
  # 22:00, configure the `start_times` field to have one element "22:00" and
  # the `days_of_week` field to have all seven days of the week.
  # @!attribute [rw] start_times
  #   @return [::Array<::Google::Type::TimeOfDay>]
  #     The times during the day to start a backup. The start times are assumed
  #     to be in UTC and to be an exact hour (e.g., 04:00:00).
  #
  #     If no start times are provided, a single fixed start time is chosen
  #     arbitrarily.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     The days of the week to perform a backup.
  #
  #     If this field is left empty, the default of every day of the week is
  #     used.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A time based retention policy specifies that all backups within a certain
  # time period should be retained.
  # @!attribute [rw] retention_period
  #   @return [::Google::Protobuf::Duration]
  #     The retention period.
  class TimeBasedRetention
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A quantity based policy specifies that a certain number of the most recent
  # successful backups should be retained.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     The number of backups to retain.
  class QuantityBasedRetention
    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

#encryption_config ⇒ ::Google::Cloud::AlloyDB::V1::EncryptionConfig

Returns Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

Returns:

  • (::Google::Cloud::AlloyDB::V1::EncryptionConfig) —

    Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 191

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

  # A weekly schedule starts a backup at prescribed start times within a
  # day, for the specified days of the week.
  #
  # The weekly schedule message is flexible and can be used to create many
  # types of schedules. For example, to have a daily backup that starts at
  # 22:00, configure the `start_times` field to have one element "22:00" and
  # the `days_of_week` field to have all seven days of the week.
  # @!attribute [rw] start_times
  #   @return [::Array<::Google::Type::TimeOfDay>]
  #     The times during the day to start a backup. The start times are assumed
  #     to be in UTC and to be an exact hour (e.g., 04:00:00).
  #
  #     If no start times are provided, a single fixed start time is chosen
  #     arbitrarily.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     The days of the week to perform a backup.
  #
  #     If this field is left empty, the default of every day of the week is
  #     used.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A time based retention policy specifies that all backups within a certain
  # time period should be retained.
  # @!attribute [rw] retention_period
  #   @return [::Google::Protobuf::Duration]
  #     The retention period.
  class TimeBasedRetention
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A quantity based policy specifies that a certain number of the most recent
  # successful backups should be retained.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     The number of backups to retain.
  class QuantityBasedRetention
    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 Labels to apply to backups created using this configuration.

Returns:

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

    Labels to apply to backups created using this configuration.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 191

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

  # A weekly schedule starts a backup at prescribed start times within a
  # day, for the specified days of the week.
  #
  # The weekly schedule message is flexible and can be used to create many
  # types of schedules. For example, to have a daily backup that starts at
  # 22:00, configure the `start_times` field to have one element "22:00" and
  # the `days_of_week` field to have all seven days of the week.
  # @!attribute [rw] start_times
  #   @return [::Array<::Google::Type::TimeOfDay>]
  #     The times during the day to start a backup. The start times are assumed
  #     to be in UTC and to be an exact hour (e.g., 04:00:00).
  #
  #     If no start times are provided, a single fixed start time is chosen
  #     arbitrarily.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     The days of the week to perform a backup.
  #
  #     If this field is left empty, the default of every day of the week is
  #     used.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A time based retention policy specifies that all backups within a certain
  # time period should be retained.
  # @!attribute [rw] retention_period
  #   @return [::Google::Protobuf::Duration]
  #     The retention period.
  class TimeBasedRetention
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A quantity based policy specifies that a certain number of the most recent
  # successful backups should be retained.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     The number of backups to retain.
  class QuantityBasedRetention
    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

#location ⇒ ::String

Returns The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.

If empty, defaults to the region of the cluster.

Returns:

  • (::String) —

    The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.

    If empty, defaults to the region of the cluster.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 191

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

  # A weekly schedule starts a backup at prescribed start times within a
  # day, for the specified days of the week.
  #
  # The weekly schedule message is flexible and can be used to create many
  # types of schedules. For example, to have a daily backup that starts at
  # 22:00, configure the `start_times` field to have one element "22:00" and
  # the `days_of_week` field to have all seven days of the week.
  # @!attribute [rw] start_times
  #   @return [::Array<::Google::Type::TimeOfDay>]
  #     The times during the day to start a backup. The start times are assumed
  #     to be in UTC and to be an exact hour (e.g., 04:00:00).
  #
  #     If no start times are provided, a single fixed start time is chosen
  #     arbitrarily.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     The days of the week to perform a backup.
  #
  #     If this field is left empty, the default of every day of the week is
  #     used.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A time based retention policy specifies that all backups within a certain
  # time period should be retained.
  # @!attribute [rw] retention_period
  #   @return [::Google::Protobuf::Duration]
  #     The retention period.
  class TimeBasedRetention
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A quantity based policy specifies that a certain number of the most recent
  # successful backups should be retained.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     The number of backups to retain.
  class QuantityBasedRetention
    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

#quantity_based_retention ⇒ ::Google::Cloud::AlloyDB::V1::AutomatedBackupPolicy::QuantityBasedRetention

Returns Quantity-based Backup retention policy to retain recent backups.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 191

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

  # A weekly schedule starts a backup at prescribed start times within a
  # day, for the specified days of the week.
  #
  # The weekly schedule message is flexible and can be used to create many
  # types of schedules. For example, to have a daily backup that starts at
  # 22:00, configure the `start_times` field to have one element "22:00" and
  # the `days_of_week` field to have all seven days of the week.
  # @!attribute [rw] start_times
  #   @return [::Array<::Google::Type::TimeOfDay>]
  #     The times during the day to start a backup. The start times are assumed
  #     to be in UTC and to be an exact hour (e.g., 04:00:00).
  #
  #     If no start times are provided, a single fixed start time is chosen
  #     arbitrarily.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     The days of the week to perform a backup.
  #
  #     If this field is left empty, the default of every day of the week is
  #     used.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A time based retention policy specifies that all backups within a certain
  # time period should be retained.
  # @!attribute [rw] retention_period
  #   @return [::Google::Protobuf::Duration]
  #     The retention period.
  class TimeBasedRetention
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A quantity based policy specifies that a certain number of the most recent
  # successful backups should be retained.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     The number of backups to retain.
  class QuantityBasedRetention
    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

#time_based_retention ⇒ ::Google::Cloud::AlloyDB::V1::AutomatedBackupPolicy::TimeBasedRetention

Returns Time-based Backup retention policy.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 191

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

  # A weekly schedule starts a backup at prescribed start times within a
  # day, for the specified days of the week.
  #
  # The weekly schedule message is flexible and can be used to create many
  # types of schedules. For example, to have a daily backup that starts at
  # 22:00, configure the `start_times` field to have one element "22:00" and
  # the `days_of_week` field to have all seven days of the week.
  # @!attribute [rw] start_times
  #   @return [::Array<::Google::Type::TimeOfDay>]
  #     The times during the day to start a backup. The start times are assumed
  #     to be in UTC and to be an exact hour (e.g., 04:00:00).
  #
  #     If no start times are provided, a single fixed start time is chosen
  #     arbitrarily.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     The days of the week to perform a backup.
  #
  #     If this field is left empty, the default of every day of the week is
  #     used.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A time based retention policy specifies that all backups within a certain
  # time period should be retained.
  # @!attribute [rw] retention_period
  #   @return [::Google::Protobuf::Duration]
  #     The retention period.
  class TimeBasedRetention
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A quantity based policy specifies that a certain number of the most recent
  # successful backups should be retained.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     The number of backups to retain.
  class QuantityBasedRetention
    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

#weekly_schedule ⇒ ::Google::Cloud::AlloyDB::V1::AutomatedBackupPolicy::WeeklySchedule

Returns Weekly schedule for the Backup.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 191

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

  # A weekly schedule starts a backup at prescribed start times within a
  # day, for the specified days of the week.
  #
  # The weekly schedule message is flexible and can be used to create many
  # types of schedules. For example, to have a daily backup that starts at
  # 22:00, configure the `start_times` field to have one element "22:00" and
  # the `days_of_week` field to have all seven days of the week.
  # @!attribute [rw] start_times
  #   @return [::Array<::Google::Type::TimeOfDay>]
  #     The times during the day to start a backup. The start times are assumed
  #     to be in UTC and to be an exact hour (e.g., 04:00:00).
  #
  #     If no start times are provided, a single fixed start time is chosen
  #     arbitrarily.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     The days of the week to perform a backup.
  #
  #     If this field is left empty, the default of every day of the week is
  #     used.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A time based retention policy specifies that all backups within a certain
  # time period should be retained.
  # @!attribute [rw] retention_period
  #   @return [::Google::Protobuf::Duration]
  #     The retention period.
  class TimeBasedRetention
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A quantity based policy specifies that a certain number of the most recent
  # successful backups should be retained.
  # @!attribute [rw] count
  #   @return [::Integer]
  #     The number of backups to retain.
  class QuantityBasedRetention
    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