Class: MintPress::InfrastructureOci::OCIDnsZone

Inherits:

Object

• Object
• MintPress::InfrastructureOci::OCIDnsZone

Includes:

Mixins::GenericProvider, Mixins::Properties

Defined in:

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

Overview

Class to Create and Manage a DNS zone in OCI

Direct Known Subclasses

UsingOCIDnsZone

Properties (Read/Write)

• #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_dns.rb', line 16
  
  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.'

• #name ⇒ String (Default Value: nil)
  'Name of the DNS Zone.'
  Property Attributes
  • default ⇒ nil
  • required ⇒ true

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_dns.rb', line 24
  
  property :name, type: String, default: nil, description: 'Name of the DNS Zone.', required: true

• #zone_type ⇒ String (Default Value: 'Primary')
  'Type of Zone.'
  Property Attributes
  • default ⇒ 'Primary'
  • allowed_values ⇒ ['Primary', 'Secondary']
  • insensitive ⇒ true

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_dns.rb', line 25
  
  property :zone_type, type: String, default: 'Primary', allowed_values: ['Primary', 'Secondary'], insensitive: true, description: 'Type of Zone.'

• #downstream_servers ⇒ Array of ⇒ String (Default Value: nil)
  'List of downstream servers for this Zone. Valid only if zone is Primary.'
  Property Attributes
  • default ⇒ nil

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_dns.rb', line 26
  
  property :downstream_servers, type: String, array: true, default: nil, description: 'List of downstream servers for this Zone. Valid only if zone is Primary.'

• #upstream_servers ⇒ Array of ⇒ String (Default Value: nil)
  'List of upstream servers for this Zone. Valid only if zone is Secondary.'
  Property Attributes
  • default ⇒ nil

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_dns.rb', line 27
  
  property :upstream_servers, type: String, array: true, default: nil, description: 'List of upstream servers for this Zone. Valid only if zone is Secondary.'

• #zone_data (Default Value: nil)
  'All details of the zone once created are stored in this property. Populated when harvest is called.'
  Property Attributes
  • default ⇒ nil

  # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_dns.rb', line 28
  
  property :zone_data, default: nil, description: 'All details of the zone once created are stored in this property. Populated when harvest is called.'

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
  Method to create a DNS zone.
• #exists? ⇒ Boolean
  Method to check if the zone exists.
• #harvest ⇒ Object
  Method to harvest an existing zone.
• #initialize(opts = {}) ⇒ OCIDnsZone constructor
  A new instance of OCIDnsZone.
• #nameservers ⇒ Object
  Method to return the name servers of the zone.
• #remove ⇒ Object
  Method to remove a Zone.

Methods included from Mixins::GenericProvider

included, #register_provider, #register_sub_provider

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

Returns a new instance of OCIDnsZone.

Instance Method Details

#create ⇒ Object

Method to create a DNS zone

#exists? ⇒ Boolean

Method to check if the zone exists

Returns:

• (Boolean)

#harvest ⇒ Object

Method to harvest an existing zone. Details are returned as a Hash

#nameservers ⇒ Object

Method to return the name servers of the zone

#remove ⇒ Object

Method to remove a Zone