Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::Table::AutomatedBackupPolicy (v1.22.0)

Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::Table::AutomatedBackupPolicy.

Defines an automated backup policy for a table

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#disabled

def disabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. If true, automated backups are explicitly disabled on this table. This allows users to opt out of default enablement.

#disabled=

def disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If true, automated backups are explicitly disabled on this table. This allows users to opt out of default enablement.
Returns
  • (::Boolean) — Optional. If true, automated backups are explicitly disabled on this table. This allows users to opt out of default enablement.

#frequency

def frequency() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.

#frequency=

def frequency=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.
Returns
  • (::Google::Protobuf::Duration) — How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.

#keep_hot_duration

def keep_hot_duration() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Optional. The amount of time that the automated backups remain hot. If specified, the backups created by this policy are HOT backups. If not specified, the backups are STANDARD backups.

    The value must be at least 24 hours and at most 10 days, and can't exceed the policy's retention_period.

    Only SSD instances support HOT automated backups.

#keep_hot_duration=

def keep_hot_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Optional. The amount of time that the automated backups remain hot. If specified, the backups created by this policy are HOT backups. If not specified, the backups are STANDARD backups.

    The value must be at least 24 hours and at most 10 days, and can't exceed the policy's retention_period.

    Only SSD instances support HOT automated backups.

Returns
  • (::Google::Protobuf::Duration) — Optional. The amount of time that the automated backups remain hot. If specified, the backups created by this policy are HOT backups. If not specified, the backups are STANDARD backups.

    The value must be at least 24 hours and at most 10 days, and can't exceed the policy's retention_period.

    Only SSD instances support HOT automated backups.

#locations

def locations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format projects/{project}/locations/{zone}. This field can only set for tables in Enterprise Plus instances.

#locations=

def locations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format projects/{project}/locations/{zone}. This field can only set for tables in Enterprise Plus instances.
Returns
  • (::Array<::String>) — Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format projects/{project}/locations/{zone}. This field can only set for tables in Enterprise Plus instances.

#retention_period

def retention_period() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.

#retention_period=

def retention_period=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.
Returns
  • (::Google::Protobuf::Duration) — Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.