Class: IbmCloudPower::Network

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/models/network.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Network

Initializes the object

Parameters:

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

    Model attributes in the form of hash



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/ibm_cloud_power/models/network.rb', line 119

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::Network` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `IbmCloudPower::Network`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'network_id')
    self.network_id = attributes[:'network_id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'vlan'
  end

  if attributes.key?(:'vlan_id')
    self.vlan_id = attributes[:'vlan_id']
  end

  if attributes.key?(:'cidr')
    self.cidr = attributes[:'cidr']
  end

  if attributes.key?(:'gateway')
    self.gateway = attributes[:'gateway']
  end

  if attributes.key?(:'dns_servers')
    if (value = attributes[:'dns_servers']).is_a?(Array)
      self.dns_servers = value
    end
  end

  if attributes.key?(:'ip_address_ranges')
    if (value = attributes[:'ip_address_ranges']).is_a?(Array)
      self.ip_address_ranges = value
    end
  end

  if attributes.key?(:'ip_address_metrics')
    self.ip_address_metrics = attributes[:'ip_address_metrics']
  end

  if attributes.key?(:'public_ip_address_ranges')
    if (value = attributes[:'public_ip_address_ranges']).is_a?(Array)
      self.public_ip_address_ranges = value
    end
  end

  if attributes.key?(:'jumbo')
    self.jumbo = attributes[:'jumbo']
  end
end

Instance Attribute Details

#cidr ⇒ Object

Network in CIDR notation (192.168.0.0/24)



31
32
33
 
# File 'lib/ibm_cloud_power/models/network.rb', line 31

def cidr
  @cidr
end

#dns_servers ⇒ Object

DNS Servers



37
38
39
 
# File 'lib/ibm_cloud_power/models/network.rb', line 37

def dns_servers
  @dns_servers
end

#gateway ⇒ Object

Gateway IP Address



34
35
36
 
# File 'lib/ibm_cloud_power/models/network.rb', line 34

def gateway
  @gateway
end

#ip_address_metrics ⇒ Object

Returns the value of attribute ip_address_metrics.



42
43
44
 
# File 'lib/ibm_cloud_power/models/network.rb', line 42

def ip_address_metrics
  @ip_address_metrics
end

#ip_address_ranges ⇒ Object

IP Address Ranges



40
41
42
 
# File 'lib/ibm_cloud_power/models/network.rb', line 40

def ip_address_ranges
  @ip_address_ranges
end

#jumbo ⇒ Object

MTU Jumbo Network enabled



48
49
50
 
# File 'lib/ibm_cloud_power/models/network.rb', line 48

def jumbo
  @jumbo
end

#name ⇒ Object

Network Name



22
23
24
 
# File 'lib/ibm_cloud_power/models/network.rb', line 22

def name
  @name
end

#network_id ⇒ Object

Unique Network ID



19
20
21
 
# File 'lib/ibm_cloud_power/models/network.rb', line 19

def network_id
  @network_id
end

#public_ip_address_ranges ⇒ Object

Public IP Address Ranges (for pub-vlan networks)



45
46
47
 
# File 'lib/ibm_cloud_power/models/network.rb', line 45

def public_ip_address_ranges
  @public_ip_address_ranges
end

#type ⇒ Object

Type of Network pub-vlan



25
26
27
 
# File 'lib/ibm_cloud_power/models/network.rb', line 25

def type
  @type
end

#vlan_id ⇒ Object

VLAN ID



28
29
30
 
# File 'lib/ibm_cloud_power/models/network.rb', line 28

def vlan_id
  @vlan_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/ibm_cloud_power/models/network.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/ibm_cloud_power/models/network.rb', line 73

def self.attribute_map
  {
    :'network_id' => :'networkID',
    :'name' => :'name',
    :'type' => :'type',
    :'vlan_id' => :'vlanID',
    :'cidr' => :'cidr',
    :'gateway' => :'gateway',
    :'dns_servers' => :'dnsServers',
    :'ip_address_ranges' => :'ipAddressRanges',
    :'ip_address_metrics' => :'ipAddressMetrics',
    :'public_ip_address_ranges' => :'publicIPAddressRanges',
    :'jumbo' => :'jumbo'
  }
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



288
289
290
 
# File 'lib/ibm_cloud_power/models/network.rb', line 288

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/ibm_cloud_power/models/network.rb', line 112

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ibm_cloud_power/models/network.rb', line 95

def self.openapi_types
  {
    :'network_id' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'vlan_id' => :'Float',
    :'cidr' => :'String',
    :'gateway' => :'String',
    :'dns_servers' => :'Array<String>',
    :'ip_address_ranges' => :'Array<IPAddressRange>',
    :'ip_address_metrics' => :'NetworkIpAddressMetrics',
    :'public_ip_address_ranges' => :'Array<IPAddressRange>',
    :'jumbo' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/ibm_cloud_power/models/network.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      network_id == o.network_id &&
      name == o.name &&
      type == o.type &&
      vlan_id == o.vlan_id &&
      cidr == o.cidr &&
      gateway == o.gateway &&
      dns_servers == o.dns_servers &&
      ip_address_ranges == o.ip_address_ranges &&
      ip_address_metrics == o.ip_address_metrics &&
      public_ip_address_ranges == o.public_ip_address_ranges &&
      jumbo == o.jumbo
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/ibm_cloud_power/models/network.rb', line 319

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = IbmCloudPower.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/ibm_cloud_power/models/network.rb', line 390

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ibm_cloud_power/models/network.rb', line 295

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


275
276
277
 
# File 'lib/ibm_cloud_power/models/network.rb', line 275

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



281
282
283
 
# File 'lib/ibm_cloud_power/models/network.rb', line 281

def hash
  [network_id, name, type, vlan_id, cidr, gateway, dns_servers, ip_address_ranges, ip_address_metrics, public_ip_address_ranges, jumbo].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/ibm_cloud_power/models/network.rb', line 187

def list_invalid_properties
  invalid_properties = Array.new
  if @network_id.nil?
    invalid_properties.push('invalid value for "network_id", network_id cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @vlan_id.nil?
    invalid_properties.push('invalid value for "vlan_id", vlan_id cannot be nil.')
  end

  if @cidr.nil?
    invalid_properties.push('invalid value for "cidr", cidr cannot be nil.')
  end

  if @dns_servers.nil?
    invalid_properties.push('invalid value for "dns_servers", dns_servers cannot be nil.')
  end

  if @ip_address_ranges.nil?
    invalid_properties.push('invalid value for "ip_address_ranges", ip_address_ranges cannot be nil.')
  end

  if @ip_address_metrics.nil?
    invalid_properties.push('invalid value for "ip_address_metrics", ip_address_metrics cannot be nil.')
  end

  if @jumbo.nil?
    invalid_properties.push('invalid value for "jumbo", jumbo cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



366
367
368
 
# File 'lib/ibm_cloud_power/models/network.rb', line 366

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/ibm_cloud_power/models/network.rb', line 372

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



360
361
362
 
# File 'lib/ibm_cloud_power/models/network.rb', line 360

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/ibm_cloud_power/models/network.rb', line 230

def valid?
  return false if @network_id.nil?
  return false if @name.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["pub-vlan", "vlan", "vxlan"])
  return false unless type_validator.valid?(@type)
  return false if @vlan_id.nil?
  return false if @cidr.nil?
  return false if @dns_servers.nil?
  return false if @ip_address_ranges.nil?
  return false if @ip_address_metrics.nil?
  return false if @jumbo.nil?
  true
end