Class: NetworkApi::PrivateNetwork

Inherits:
Object
  • Object
show all
Defined in:
lib/pnap_network_api/models/private_network.rb

Overview

Private Network details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PrivateNetwork

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
184
185
186
187
 
# File 'lib/pnap_network_api/models/private_network.rb', line 103

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `NetworkApi::PrivateNetwork` 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 `NetworkApi::PrivateNetwork`. 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?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

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

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

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

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

  if attributes.key?(:'location')
    self.location = attributes[:'location']
  else
    self.location = nil
  end

  if attributes.key?(:'location_default')
    self.location_default = attributes[:'location_default']
  else
    self.location_default = nil
  end

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

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'created_on')
    self.created_on = attributes[:'created_on']
  else
    self.created_on = nil
  end
end

Instance Attribute Details

#cidr ⇒ Object

IP range associated with this private network in CIDR notation.



41
42
43
 
# File 'lib/pnap_network_api/models/private_network.rb', line 41

def cidr
  @cidr
end

#created_on ⇒ Object

Date and time when this private network was created.



52
53
54
 
# File 'lib/pnap_network_api/models/private_network.rb', line 52

def created_on
  @created_on
end

#description ⇒ Object

The description of this private network.



26
27
28
 
# File 'lib/pnap_network_api/models/private_network.rb', line 26

def description
  @description
end

#id ⇒ Object

The private network identifier.



20
21
22
 
# File 'lib/pnap_network_api/models/private_network.rb', line 20

def id
  @id
end

#location ⇒ Object

The location of this private network.



35
36
37
 
# File 'lib/pnap_network_api/models/private_network.rb', line 35

def location
  @location
end

#location_default ⇒ Object

Identifies network as the default private network for the specified location.



38
39
40
 
# File 'lib/pnap_network_api/models/private_network.rb', line 38

def location_default
  @location_default
end

#memberships ⇒ Object

A list of resources that are members of this private network.



46
47
48
 
# File 'lib/pnap_network_api/models/private_network.rb', line 46

def memberships
  @memberships
end

#name ⇒ Object

The friendly name of this private network.



23
24
25
 
# File 'lib/pnap_network_api/models/private_network.rb', line 23

def name
  @name
end

#servers ⇒ Object

Returns the value of attribute servers.



43
44
45
 
# File 'lib/pnap_network_api/models/private_network.rb', line 43

def servers
  @servers
end

#status ⇒ Object

The status of the private network. Can have one of the following values: ‘BUSY`, `READY`, `DELETING` or `ERROR`.



49
50
51
 
# File 'lib/pnap_network_api/models/private_network.rb', line 49

def status
  @status
end

#type ⇒ Object

The type of the private network.



32
33
34
 
# File 'lib/pnap_network_api/models/private_network.rb', line 32

def type
  @type
end

#vlan_id ⇒ Object

The VLAN of this private network.



29
30
31
 
# File 'lib/pnap_network_api/models/private_network.rb', line 29

def vlan_id
  @vlan_id
end

Class Method Details

._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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/pnap_network_api/models/private_network.rb', line 359

def self._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 = NetworkApi.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/pnap_network_api/models/private_network.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/pnap_network_api/models/private_network.rb', line 55

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'vlan_id' => :'vlanId',
    :'type' => :'type',
    :'location' => :'location',
    :'location_default' => :'locationDefault',
    :'cidr' => :'cidr',
    :'servers' => :'servers',
    :'memberships' => :'memberships',
    :'status' => :'status',
    :'created_on' => :'createdOn'
  }
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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/pnap_network_api/models/private_network.rb', line 335

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/pnap_network_api/models/private_network.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/pnap_network_api/models/private_network.rb', line 78

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'vlan_id' => :'Integer',
    :'type' => :'String',
    :'location' => :'String',
    :'location_default' => :'Boolean',
    :'cidr' => :'String',
    :'servers' => :'Array<PrivateNetworkServer>',
    :'memberships' => :'Array<NetworkMembership>',
    :'status' => :'String',
    :'created_on' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/pnap_network_api/models/private_network.rb', line 303

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      vlan_id == o.vlan_id &&
      type == o.type &&
      location == o.location &&
      location_default == o.location_default &&
      cidr == o.cidr &&
      servers == o.servers &&
      memberships == o.memberships &&
      status == o.status &&
      created_on == o.created_on
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



430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/pnap_network_api/models/private_network.rb', line 430

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


322
323
324
 
# File 'lib/pnap_network_api/models/private_network.rb', line 322

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



328
329
330
 
# File 'lib/pnap_network_api/models/private_network.rb', line 328

def hash
  [id, name, description, vlan_id, type, location, location_default, cidr, servers, memberships, status, created_on].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



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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/pnap_network_api/models/private_network.rb', line 191

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

  if @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if !@description.nil? && @description.to_s.length > 250
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 250.')
  end

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

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

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

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

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

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

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

  if @created_on.nil?
    invalid_properties.push('invalid value for "created_on", created_on 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



406
407
408
 
# File 'lib/pnap_network_api/models/private_network.rb', line 406

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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/pnap_network_api/models/private_network.rb', line 412

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



400
401
402
 
# File 'lib/pnap_network_api/models/private_network.rb', line 400

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/pnap_network_api/models/private_network.rb', line 251

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 100
  return false if @name.to_s.length < 1
  return false if !@description.nil? && @description.to_s.length > 250
  return false if @vlan_id.nil?
  return false if @type.nil?
  return false if @location.nil?
  return false if @location_default.nil?
  return false if @servers.nil?
  return false if @memberships.nil?
  return false if @status.nil?
  return false if @created_on.nil?
  true
end