Class: OracleBMC::Core::Models::CreateSubnetDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/core/models/create_subnet_details.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSubnetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 74

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[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end
  
  if attributes[:'cidrBlock']
    self.cidr_block = attributes[:'cidrBlock']
  end
  
  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end
  
  if attributes[:'dhcpOptionsId']
    self.dhcp_options_id = attributes[:'dhcpOptionsId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'dnsLabel']
    self.dns_label = attributes[:'dnsLabel']
  end
  
  if attributes[:'routeTableId']
    self.route_table_id = attributes[:'routeTableId']
  end
  
  if attributes[:'securityListIds']
    self.security_list_ids = attributes[:'securityListIds']
  end
  
  if attributes[:'vcnId']
    self.vcn_id = attributes[:'vcnId']
  end
  
end

Instance Attribute Details

#availability_domain ⇒ String

The Availability Domain to contain the subnet.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


12
13
14
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 12

def availability_domain
  @availability_domain
end

#cidr_block ⇒ String

The CIDR IP address range of the subnet.

Example: ‘172.16.1.0/24`

Returns:

  • (String) 


19
20
21
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 19

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

The OCID of the compartment to contain the subnet.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 23

def compartment_id
  @compartment_id
end

#dhcp_options_id ⇒ String

The OCID of the set of DHCP options the subnet will use. If you don’t provide a value, the subnet will use the VCN’s default set of DHCP options.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 29

def dhcp_options_id
  @dhcp_options_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 33

def display_name
  @display_name
end

#dns_label ⇒ String

A DNS label for the subnet, used in conjunction with the VNIC’s hostname and VCN’s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (e.g., ‘bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.

This value must be set if you want to use the Internet and VCN Resolver to resolve the hostnames of instances in the subnet. It can only be set if the VCN itself was created with a DNS label.

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

Example: ‘subnet123`

Returns:

  • (String) 


51
52
53
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 51

def dns_label
  @dns_label
end

#route_table_id ⇒ String

The OCID of the route table the subnet will use. If you don’t provide a value, the subnet will use the VCN’s default route table.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 57

def route_table_id
  @route_table_id
end

#security_list_ids ⇒ Array<String>

OCIDs for the security lists to associate with the subnet. If you don’t provide a value, the VCN’s default security list will be associated with the subnet. Remember that security lists are associated at the subnet level, but the rules are applied to the individual VNICs in the subnet.

Returns:

  • (Array<String>) 


65
66
67
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 65

def security_list_ids
  @security_list_ids
end

#vcn_id ⇒ String

The OCID of the VCN to contain the subnet.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 69

def vcn_id
  @vcn_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 121

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      cidr_block == other_object.cidr_block &&
      compartment_id == other_object.compartment_id &&
      dhcp_options_id == other_object.dhcp_options_id &&
      display_name == other_object.display_name &&
      dns_label == other_object.dns_label &&
      route_table_id == other_object.route_table_id &&
      security_list_ids == other_object.security_list_ids &&
      vcn_id == other_object.vcn_id
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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 150

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.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OracleBMC::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OracleBMC::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


137
138
139
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 137

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 143

def hash
  [availability_domain, cidr_block, compartment_id, dhcp_options_id, display_name, dns_label, route_table_id, security_list_ids, vcn_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 175

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



169
170
171
 
# File 'lib/oraclebmc/core/models/create_subnet_details.rb', line 169

def to_s
  to_hash.to_s
end