Class: MintPress::InfrastructureOci::FileSystem

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

Properties (Read/Write)

  • #name ⇒ String
    'The name of the File system.'
    Property Attributes
    • alias ⇒ :display_name
    

23
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 23

property :name, type: String, description: 'The name of the File system.', 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 }
    

26
27
28
29
30
31
32
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 26

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 }
    

34
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 34

property :compartment_id, type: String, default: Proc.new { self.platform.compartment }
  • #filesystem_snapshot_policy ⇒ [MintPress::InfrastructureOci::FileSystemSnapshotPolicy,String]
    'Either the FileSystemSnapshotPolicy object or the OCID of the FileSystemSnapshotPolicy this file system associates with.'
    Property Attributes 
    

38
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 38

property :filesystem_snapshot_policy, type: [MintPress::InfrastructureOci::FileSystemSnapshotPolicy,String], description: 'Either the FileSystemSnapshotPolicy object or the OCID of the FileSystemSnapshotPolicy this file system associates with.'
  • #id ⇒ String
    'ID for the File System'
    Property Attributes 
    

42
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 42

property :id, type: String, description: 'ID for the File System'
  • #is_clone_parent ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Specifies whether the file system has been cloned'
    Property Attributes
    • default ⇒ false
    

43
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 43

property :is_clone_parent, type: [TrueClass, FalseClass], default: false, description: 'Specifies whether the file system has been cloned'
  • #is_hydrated ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact.'
    Property Attributes
    • default ⇒ false
    

44
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 44

property :is_hydrated, type: [TrueClass, FalseClass], default: false, description: 'Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact.'
  • #is_targetable ⇒ [TrueClass, FalseClass] (Default Value: false)
    "Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false"
    Property Attributes
    • default ⇒ false
    

45
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 45

property :is_targetable, type: [TrueClass, FalseClass], default: false, description: "Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false"
  • #kms_key_id ⇒ String
    'The OCID of the KMS key which is the master encryption key for the file system.'
    Property Attributes 
    

47
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 47

property :kms_key_id, type: String, description: 'The OCID of the KMS key which is the master encryption key for the file system.'
  • #lifecycle_details ⇒ String
    "Additional information about the current 'lifecycleState'."
    Property Attributes 
    

48
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 48

property :lifecycle_details, type: String, description: "Additional information about the current 'lifecycleState'."
  • #lifecycle_state ⇒ String
    "The current state of the file system."
    Property Attributes 
    

49
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 49

property :lifecycle_state, type: String, description: "The current state of the file system."
  • #metered_bytes ⇒ Integer
    "The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system."
    Property Attributes 
    

50
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 50

property :metered_bytes, type: Integer, description: "The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system."
  • #replication_target_id ⇒ String
    "The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication."
    Property Attributes 
    

51
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 51

property :replication_target_id, type: String, description: "The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication."
  • #source_details ⇒ [OCI::FileStorage::Models::SourceDetails]
    property :source_details, type: [MintPress::InfrastructureOci::FileSystemSourceDetails, OCI::FileStorage::Models::SourceDetails]
    Property Attributes 
    

53
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 53

property :source_details, type: [OCI::FileStorage::Models::SourceDetails]
  • #source_snapshot_id ⇒ String
    'The OCID of the snapshot used to create a cloned file system.'
    Property Attributes 
    

54
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_file_system.rb', line 54

property :source_snapshot_id, type: String, description: 'The OCID of the snapshot used to create a cloned file system.'

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 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 = {}) ⇒ FileSystem

Returns a new instance of FileSystem.

Instance Method Details

#create ⇒ Object

#destroy ⇒ Object

#exists? ⇒ Boolean

Returns:

  • (Boolean)

#harvest ⇒ Object

#update ⇒ Object