Class: MintPress::InfrastructureOci::VolumeBackup

Inherits:
Object
  • Object
show all
Includes:
MintLogger, TagUtils, Mixins::Backgroundable, Mixins::Properties
Defined in:
src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb

Properties (Read/Write)

  • #name ⇒ String
    'The name of the backup'
    Property Attributes
    • alias ⇒ :display_name
    

149
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 149

property :name, type: String, description: 'The name of the backup', alias: :display_name
  • #platform ⇒ MintPress::InfrastructureOci::OciPlatform (Default Value: Proc.new { if opts[:provider] MintPress::InfrastructureOci::OciPlatform.new(:provider => opts[:provider]) else MintPress::InfrastructureOci::OciPlatform.new end })
    'This incapsulates all properties required for the OCI provider.'
    Property Attributes
    • default ⇒ Proc.new { if opts[:provider] MintPress::InfrastructureOci::OciPlatform.new(:provider => opts[:provider]) else MintPress::InfrastructureOci::OciPlatform.new end }
    

152
153
154
155
156
157
158
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 152

property :platform, type: MintPress::InfrastructureOci::OciPlatform, default: Proc.new {
  if opts[:provider]
    MintPress::InfrastructureOci::OciPlatform.new(:provider => opts[:provider])
  else
    MintPress::InfrastructureOci::OciPlatform.new
  end
}, description: 'This incapsulates all properties required for the OCI provider.'
  • #compartment_id ⇒ String (Default Value: Proc.new { self.platform.compartment })

    Property Attributes
    • default ⇒ Proc.new { self.platform.compartment }
    

160
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 160

property :compartment_id, type: String, default: Proc.new { self.platform.compartment }
  • #kms_key_id ⇒ String
    'The OCID of the Vault service key which is the master encryption key for the volume backup.'
    Property Attributes 
    

164
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 164

property :kms_key_id, type: String, description: 'The OCID of the Vault service key which is the master encryption key for the volume backup.'
  • #type ⇒ String (Default Value: 'full')
    'The type of backup to create, full vs incremental'
    Property Attributes
    • default ⇒ 'full'
    

166
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 166

property :type, type: String, default: 'full', description: 'The type of backup to create, full vs incremental'
  • #id ⇒ String
    'ID for the Backup'
    Property Attributes 
    

168
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 168

property :id, type: String, description: 'ID for the Backup'
  • #volume_id ⇒ String
    'Volume if of the volume.'
    Property Attributes 
    

170
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 170

property :volume_id, type: String, description: 'Volume if of the volume.'
  • #volume ⇒ [MintPress::InfrastructureOci::OCIStorage, MintPress::InfrastructureOci::OCISharedStorage]
    'Volume this backup will be associated with.'
    Property Attributes
    • alias ⇒ :storage
    

172
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 172

property :volume, type: [MintPress::InfrastructureOci::OCIStorage, MintPress::InfrastructureOci::OCISharedStorage], description: 'Volume this backup will be associated with.', alias: :storage
  • #override ⇒ [TrueClass, FalseClass] (Default Value: false)
    'If set to true, it will allow creating backups with the same name. Note that this will not delete existing backup but just create a new one with the same name. This may cause issues when looking up backups by name and is not recommended.'
    Property Attributes
    • default ⇒ false
    

174
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 174

property :override, type: [TrueClass, FalseClass], default: false, description: 'If set to true, it will allow creating backups with the same name. Note that this will not delete existing backup but just create a new one with the same name. This may cause issues when looking up backups by name and is not recommended.'
  • #wait_for_backup ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Setting this property to true will wait until the backup has been finished and is in available state. Otherwise, Mint will just fire the request and let the backup run in background.'
    Property Attributes
    • default ⇒ false
    

176
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_storage_backup.rb', line 176

property :wait_for_backup, type: [TrueClass, FalseClass], default: false, description: 'Setting this property to true will wait until the backup has been finished and is in available state. Otherwise, Mint will just fire the request and let the backup run in background.'

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from Mixins::Backgroundable

#backgroundable, #wait_for_background_tasks

Methods included from TagUtils

#clear_tags, #fetch_resource_details, #import_tag_properties, #manage_tags, #merge_defined_tags, #remove_defined_tags, #remove_tags, #update_resource, #update_tags

Methods included from CommonUtils

#create_status_check_proc, #destroy_status_check_proc, #filter_nil_properties, #populate_properties

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Constructor Details

#initialize(opts = {}) ⇒ VolumeBackup

Returns a new instance of VolumeBackup.

Instance Method Details

#background_create ⇒ Object

#background_destroy ⇒ Object

#create ⇒ Object

#destroy ⇒ Object

#destroy_backups(filter = {}) ⇒ Object

#exists? ⇒ Boolean

Returns:

  • (Boolean)

#harvest ⇒ Object

#update ⇒ Object