Class: OCI::Core::Models::CreateVcnDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/create_vcn_details.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVcnDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 61

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes[:'cidrBlock']
    self.cidr_block = attributes[:'cidrBlock']
  end

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

  if attributes[:'dnsLabel']
    self.dns_label = attributes[:'dnsLabel']
  end

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

end

Instance Attribute Details

#cidr_block ⇒ String

The CIDR IP address block of the VCN.

Example: ‘172.16.0.0/16`

Returns:

  • (String) 


12
13
14
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 12

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

The OCID of the compartment to contain the VCN.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 16

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


24
25
26
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 24

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 28

def display_name
  @display_name
end

#dns_label ⇒ String

A DNS label for the VCN, used in conjunction with the VNIC’s hostname and subnet’s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, ‘bminstance-1.subnet123.vcn1.oraclevcn.com`). Not required to be unique, but it’s a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. The value cannot be changed.

You must set this value if you want instances to be able to use hostnames to resolve other instances in the VCN. Otherwise the Internet and VCN Resolver will not work.

For more information, see [DNS in Your Virtual Cloud Network](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

Example: ‘vcn1`

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 47

def dns_label
  @dns_label
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


56
57
58
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 56

def freeform_tags
  @freeform_tags
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 95

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      cidr_block == other_object.cidr_block &&
      compartment_id == other_object.compartment_id &&
      defined_tags == other_object.defined_tags &&
      display_name == other_object.display_name &&
      dns_label == other_object.dns_label &&
      freeform_tags == other_object.freeform_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 121

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.public_method("#{key}=").call(OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


108
109
110
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 108

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



114
115
116
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 114

def hash
  [cidr_block, compartment_id, defined_tags, display_name, dns_label, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 146

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



140
141
142
 
# File 'lib/oci/core/models/create_vcn_details.rb', line 140

def to_s
  to_hash.to_s
end