Class: Google::Apis::BackupdrV1::BackupRule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/backupdr_v1/classes.rb,
lib/google/apis/backupdr_v1/representations.rb,
lib/google/apis/backupdr_v1/representations.rb

Overview

BackupRule binds the backup schedule to a retention policy.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BackupRule

Returns a new instance of BackupRule.



1060
1061
1062
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1060

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#backup_retention_days ⇒ Fixnum

Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Corresponds to the JSON property backupRetentionDays

Returns:

  • (Fixnum) 


1027
1028
1029
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1027

def backup_retention_days
  @backup_retention_days
end

#backup_vault ⇒ String

Optional. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/project/locations/location/backupVaults/backupvault Corresponds to the JSON property backupVault

Returns:

  • (String) 


1035
1036
1037
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1035

def backup_vault
  @backup_vault
end

#backup_vault_service_account ⇒ String

Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. Corresponds to the JSON property backupVaultServiceAccount

Returns:

  • (String) 


1043
1044
1045
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1043

def 
  @backup_vault_service_account
end

#rule_id ⇒ String

Required. Immutable. The unique id of this BackupRule. The rule_id is unique per BackupPlan.The rule_id must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z,62 /. Corresponds to the JSON property ruleId

Returns:

  • (String) 


1051
1052
1053
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1051

def rule_id
  @rule_id
end

#standard_schedule ⇒ Google::Apis::BackupdrV1::StandardSchedule

StandardSchedule defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. Corresponds to the JSON property standardSchedule

Returns:



1058
1059
1060
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1058

def standard_schedule
  @standard_schedule
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1065
1066
1067
1068
1069
1070
1071
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1065

def update!(**args)
  @backup_retention_days = args[:backup_retention_days] if args.key?(:backup_retention_days)
  @backup_vault = args[:backup_vault] if args.key?(:backup_vault)
  @backup_vault_service_account = args[:backup_vault_service_account] if args.key?(:backup_vault_service_account)
  @rule_id = args[:rule_id] if args.key?(:rule_id)
  @standard_schedule = args[:standard_schedule] if args.key?(:standard_schedule)
end