Class: IntersightClient::IppoolShadowPool

Inherits:
PoolAbstractPool show all
Defined in:
lib/intersight_client/models/ippool_shadow_pool.rb

Overview

Shadow Pool is a tracking object created on behalf of an IP pool, for each VRF.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PoolAbstractPool

#assigned, #assignment_order, #size

Attributes inherited from PolicyAbstractPolicy

#description, #name

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IppoolShadowPool

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 148

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::IppoolShadowPool` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'ippool.ShadowPool'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'ippool.ShadowPool'
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 20

def class_id
  @class_id
end

#ip_block_heads ⇒ Object

An array of relationships to ippoolShadowBlock resources.



46
47
48
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 46

def ip_block_heads
  @ip_block_heads
end

#ip_v4_blocks ⇒ Object

Returns the value of attribute ip_v4_blocks.



25
26
27
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 25

def ip_v4_blocks
  @ip_v4_blocks
end

#ip_v4_config ⇒ Object

Returns the value of attribute ip_v4_config.



27
28
29
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 27

def ip_v4_config
  @ip_v4_config
end

#ip_v6_blocks ⇒ Object

Returns the value of attribute ip_v6_blocks.



29
30
31
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 29

def ip_v6_blocks
  @ip_v6_blocks
end

#ip_v6_config ⇒ Object

Returns the value of attribute ip_v6_config.



31
32
33
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 31

def ip_v6_config
  @ip_v6_config
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 23

def object_type
  @object_type
end

#pool ⇒ Object

Returns the value of attribute pool.



48
49
50
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 48

def pool
  @pool
end

#v4_assigned ⇒ Object

Number of IPv4 addresses currently in use.



34
35
36
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 34

def v4_assigned
  @v4_assigned
end

#v4_size ⇒ Object

Number of IPv4 addresses in this pool.



37
38
39
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 37

def v4_size
  @v4_size
end

#v6_assigned ⇒ Object

Number of IPv6 addresses currently in use.



40
41
42
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 40

def v6_assigned
  @v6_assigned
end

#v6_size ⇒ Object

Number of IPv6 addresses in this pool.



43
44
45
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 43

def v6_size
  @v6_size
end

#vrf ⇒ Object

Returns the value of attribute vrf.



50
51
52
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 50

def vrf
  @vrf
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



99
100
101
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 99

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



94
95
96
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 94

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 75

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'ip_v4_blocks' => :'IpV4Blocks',
    :'ip_v4_config' => :'IpV4Config',
    :'ip_v6_blocks' => :'IpV6Blocks',
    :'ip_v6_config' => :'IpV6Config',
    :'v4_assigned' => :'V4Assigned',
    :'v4_size' => :'V4Size',
    :'v6_assigned' => :'V6Assigned',
    :'v6_size' => :'V6Size',
    :'ip_block_heads' => :'IpBlockHeads',
    :'pool' => :'Pool',
    :'vrf' => :'Vrf'
  }
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



309
310
311
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 309

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



134
135
136
137
138
139
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 134

def self.openapi_all_of
  [
  :'IppoolShadowPoolAllOf',
  :'PoolAbstractPool'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



142
143
144
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 142

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



123
124
125
126
127
128
129
130
131
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 123

def self.openapi_nullable
  Set.new([
    :'ip_v4_blocks',
    :'ip_v4_config',
    :'ip_v6_blocks',
    :'ip_v6_config',
    :'ip_block_heads',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 104

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'ip_v4_blocks' => :'Array<IppoolIpV4Block>',
    :'ip_v4_config' => :'IppoolIpV4Config',
    :'ip_v6_blocks' => :'Array<IppoolIpV6Block>',
    :'ip_v6_config' => :'IppoolIpV6Config',
    :'v4_assigned' => :'Integer',
    :'v4_size' => :'Integer',
    :'v6_assigned' => :'Integer',
    :'v6_size' => :'Integer',
    :'ip_block_heads' => :'Array<IppoolShadowBlockRelationship>',
    :'pool' => :'IppoolPoolRelationship',
    :'vrf' => :'VrfVrfRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 276

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      ip_v4_blocks == o.ip_v4_blocks &&
      ip_v4_config == o.ip_v4_config &&
      ip_v6_blocks == o.ip_v6_blocks &&
      ip_v6_config == o.ip_v6_config &&
      v4_assigned == o.v4_assigned &&
      v4_size == o.v4_size &&
      v6_assigned == o.v6_assigned &&
      v6_size == o.v6_size &&
      ip_block_heads == o.ip_block_heads &&
      pool == o.pool &&
      vrf == o.vrf && super(o)
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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 340

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 = IntersightClient.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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 411

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 316

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


296
297
298
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 296

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



302
303
304
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 302

def hash
  [class_id, object_type, ip_v4_blocks, ip_v4_config, ip_v6_blocks, ip_v6_config, v4_assigned, v4_size, v6_assigned, v6_size, ip_block_heads, pool, vrf].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



229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 229

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

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



387
388
389
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 387

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 393

def to_hash
  hash = super
  IppoolShadowPool.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = IppoolShadowPool.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



381
382
383
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 381

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



244
245
246
247
248
249
250
251
252
 
# File 'lib/intersight_client/models/ippool_shadow_pool.rb', line 244

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["ippool.ShadowPool"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["ippool.ShadowPool"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end