Class: Google::Cloud::AlloyDB::V1alpha::AutomatedBackupPolicy

Inherits:

Object

• Object
• Google::Cloud::AlloyDB::V1alpha::AutomatedBackupPolicy

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/alloydb/v1alpha/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

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

  The length of the time window during which a backup can be taken.

• #enabled ⇒ ::Boolean

  Whether automated automated backups are enabled.

• #encryption_config ⇒ ::Google::Cloud::AlloyDB::V1alpha::EncryptionConfig

  Optional.

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

  Labels to apply to backups created using this configuration.

• #location ⇒ ::String

  The location where the backup will be stored.

• #quantity_based_retention ⇒ ::Google::Cloud::AlloyDB::V1alpha::AutomatedBackupPolicy::QuantityBasedRetention

  Quantity-based Backup retention policy to retain recent backups.

• #time_based_retention ⇒ ::Google::Cloud::AlloyDB::V1alpha::AutomatedBackupPolicy::TimeBasedRetention

  Time-based Backup retention policy.

• #weekly_schedule ⇒ ::Google::Cloud::AlloyDB::V1alpha::AutomatedBackupPolicy::WeeklySchedule

  Weekly schedule for the Backup.

Instance Attribute Details

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

# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 194

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

# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 194

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::V1alpha::EncryptionConfig

# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 194

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}

# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 194

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

# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 194

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::V1alpha::AutomatedBackupPolicy::QuantityBasedRetention

# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 194

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::V1alpha::AutomatedBackupPolicy::TimeBasedRetention

# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 194

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::V1alpha::AutomatedBackupPolicy::WeeklySchedule

# File 'proto_docs/google/cloud/alloydb/v1alpha/resources.rb', line 194

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