Class: NetworkApi::PublicNetworkCreate

Inherits:
ApiModelBase show all
Defined in:
lib/pnap_network_api/models/public_network_create.rb

Overview

Details of Public Network to be created.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ PublicNetworkCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
118
119
120
121
122
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 79

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

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

  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?(:'location')
    self.location = attributes[:'location']
  else
    self.location = nil
  end

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

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

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

Instance Attribute Details

#description ⇒ Object

The description of this public network.



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

def description
  @description
end

#ip_blocks ⇒ Object

A list of IP Blocks that will be associated with this public network. Supported maximum of 10 IPv4 Blocks and 1 IPv6 Block.



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

def ip_blocks
  @ip_blocks
end

#location ⇒ Object

The location of this public network. Supported values are PHX, ASH, SGP, NLD, CHI and SEA.



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

def location
  @location
end

#name ⇒ Object

The friendly name of this public network. This name should be unique.



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

def name
  @name
end

#ra_enabled ⇒ Object

Boolean indicating whether Router Advertisement is enabled. Only applicable for Network with IPv6 Blocks.



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

def ra_enabled
  @ra_enabled
end

#vlan_id ⇒ Object

The VLAN that will be assigned to this network.



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

def vlan_id
  @vlan_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



50
51
52
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 50

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 55

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 38

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'location' => :'location',
    :'vlan_id' => :'vlanId',
    :'ip_blocks' => :'ipBlocks',
    :'ra_enabled' => :'raEnabled'
  }
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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 292

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 60

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'location' => :'String',
    :'vlan_id' => :'Integer',
    :'ip_blocks' => :'Array<PublicNetworkIpBlockCreate>',
    :'ra_enabled' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      location == o.location &&
      vlan_id == o.vlan_id &&
      ip_blocks == o.ip_blocks &&
      ra_enabled == o.ra_enabled
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


279
280
281
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



285
286
287
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 285

def hash
  [name, description, location, vlan_id, ip_blocks, ra_enabled].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



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
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 126

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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 greater than or equal to 1.')
  end

  pattern = Regexp.new(/^(?=.*[a-zA-Z])([a-zA-Z0-9(). -])+$/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  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 @location.nil?
    invalid_properties.push('invalid value for "location", location cannot be nil.')
  end

  if !@vlan_id.nil? && @vlan_id > 4094
    invalid_properties.push('invalid value for "vlan_id", must be smaller than or equal to 4094.')
  end

  if !@vlan_id.nil? && @vlan_id < 2
    invalid_properties.push('invalid value for "vlan_id", must be greater than or equal to 2.')
  end

  if !@ip_blocks.nil? && @ip_blocks.length > 11
    invalid_properties.push('invalid value for "ip_blocks", number of items must be less than or equal to 11.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 314

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/pnap_network_api/models/public_network_create.rb', line 171

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 100
  return false if @name.to_s.length < 1
  return false if @name !~ Regexp.new(/^(?=.*[a-zA-Z])([a-zA-Z0-9(). -])+$/)
  return false if !@description.nil? && @description.to_s.length > 250
  return false if @location.nil?
  return false if !@vlan_id.nil? && @vlan_id > 4094
  return false if !@vlan_id.nil? && @vlan_id < 2
  return false if !@ip_blocks.nil? && @ip_blocks.length > 11
  true
end