Class: MintPress::InfrastructureOci::PublicIp

Inherits:

Object

• Object
• MintPress::InfrastructureOci::PublicIp

Includes:

MintLogger, TagUtils, Mixins::Properties

Defined in:

src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_public_ip.rb

Properties (Read/Write)

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

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_public_ip.rb', line 23
  
  property :name, type: String, description: 'The name of the Public IP', 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 }

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_public_ip.rb', line 25
  
  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 }

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_public_ip.rb', line 33
  
  property :compartment_id, type: String, default: Proc.new { self.platform.compartment }

• #id ⇒ String
  'ID for the Public IP'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_public_ip.rb', line 39
  
  property :id, type: String, description: 'ID for the Public IP'

• #public_ip_pool_id ⇒ String
  'The OCID of the public IP Pool.'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_public_ip.rb', line 40
  
  property :public_ip_pool_id, type: String, description: 'The OCID of the public IP Pool.'

• #private_ip_id ⇒ String
  'The OCID of the private IP to assign the public IP to.'
  Property Attributes

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_public_ip.rb', line 41
  
  property :private_ip_id, type: String, description: 'The OCID of the private IP to assign the public IP to.'

• #lifetime ⇒ String (Default Value: 'EPHEMERAL')
  'Defines when the public IP is deleted and released back to the Oracle Cloud Infrastructure public IP pool.'
  Property Attributes
  • default ⇒ 'EPHEMERAL'
  • required ⇒ true

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_public_ip.rb', line 42
  
  property :lifetime, type: String, default: 'EPHEMERAL', required: true, description: 'Defines when the public IP is deleted and released back to the Oracle Cloud Infrastructure public IP pool.'

• #ip ⇒ String
  'IP that was created/reserved.'
  Property Attributes
  • alias ⇒ :ip_address

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_public_ip.rb', line 43
  
  property :ip, type: String, alias: :ip_address, description: 'IP that was created/reserved.'

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

• #create ⇒ Object
• #destroy ⇒ Object
• #exists? ⇒ Boolean
• #harvest ⇒ Object
• #initialize(opts = {}) ⇒ PublicIp constructor
  A new instance of PublicIp.
• #list ⇒ Object
• #update ⇒ Object

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

Returns a new instance of PublicIp.

Instance Method Details

#create ⇒ Object

#destroy ⇒ Object

#exists? ⇒ Boolean

Returns:

• (Boolean)

#harvest ⇒ Object

#list ⇒ Object

#update ⇒ Object