Class: Google::Apis::BackupdrV1::BackupPlan

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

A BackupPlan specifies some common fields, such as display_name as well as one or more BackupRule messages. Each BackupRule has a retention policy and defines a schedule by which the system is to perform backup workloads.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BackupPlan

Returns a new instance of BackupPlan.



924
925
926
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 924

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

Instance Attribute Details

#backup_rules ⇒ Array<Google::Apis::BackupdrV1::BackupRule>

Required. The backup rules for this BackupPlan. There must be at least one BackupRule message. Corresponds to the JSON property backupRules

Returns:



858
859
860
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 858

def backup_rules
  @backup_rules
end

#backup_vault ⇒ String

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) 


865
866
867
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 865

def backup_vault
  @backup_vault
end

#backup_vault_service_account ⇒ String

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) 


872
873
874
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 872

def 
  @backup_vault_service_account
end

#create_time ⇒ String

Output only. When the BackupPlan was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


877
878
879
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 877

def create_time
  @create_time
end

#description ⇒ String

Optional. The description of the BackupPlan resource. The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. Corresponds to the JSON property description

Returns:

  • (String) 


886
887
888
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 886

def description
  @description
end

#etag ⇒ String

Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources. Corresponds to the JSON property etag

Returns:

  • (String) 


893
894
895
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 893

def etag
  @etag
end

#labels ⇒ Hash<String,String>

Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, "tag": "Weekly". Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


899
900
901
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 899

def labels
  @labels
end

#name ⇒ String

Output only. Identifier. The resource name of the BackupPlan. Format: projects/project/locations/location/backupPlans/backup_plan` Corresponds to the JSON propertyname`

Returns:

  • (String) 


905
906
907
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 905

def name
  @name
end

#resource_type ⇒ String

Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis. com/Bucket". Corresponds to the JSON property resourceType

Returns:

  • (String) 


912
913
914
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 912

def resource_type
  @resource_type
end

#state ⇒ String

Output only. The State for the BackupPlan. Corresponds to the JSON property state

Returns:

  • (String) 


917
918
919
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 917

def state
  @state
end

#update_time ⇒ String

Output only. When the BackupPlan was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


922
923
924
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 922

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



929
930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 929

def update!(**args)
  @backup_rules = args[:backup_rules] if args.key?(:backup_rules)
  @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)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @resource_type = args[:resource_type] if args.key?(:resource_type)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end