Class: IntersightClient::VnicRoceSettings

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/vnic_roce_settings.rb

Overview

Settings for RDMA over Converged Ethernet.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VnicRoceSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::VnicRoceSettings` 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 = 'vnic.RoceSettings'
  end

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

  if attributes.key?(:'class_of_service')
    self.class_of_service = attributes[:'class_of_service']
  else
    self.class_of_service = CLASS_OF_SERVICE::N5
  end

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

  if attributes.key?(:'memory_regions')
    self.memory_regions = attributes[:'memory_regions']
  else
    self.memory_regions = 131072
  end

  if attributes.key?(:'queue_pairs')
    self.queue_pairs = attributes[:'queue_pairs']
  else
    self.queue_pairs = 256
  end

  if attributes.key?(:'resource_groups')
    self.resource_groups = attributes[:'resource_groups']
  else
    self.resource_groups = 4
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  else
    self.version = VERSION::N1
  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/vnic_roce_settings.rb', line 20

def class_id
  @class_id
end

#class_of_service ⇒ Object

The Class of Service for RoCE on this virtual interface. * 5 - RDMA CoS Service Level 5. * 1 - RDMA CoS Service Level 1. * 2 - RDMA CoS Service Level 2. * 4 - RDMA CoS Service Level 4. * 6 - RDMA CoS Service Level 6.



26
27
28
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 26

def class_of_service
  @class_of_service
end

#enabled ⇒ Object

If enabled sets RDMA over Converged Ethernet (RoCE) on this virtual interface.



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

def enabled
  @enabled
end

#memory_regions ⇒ Object

The number of memory regions per adapter. Recommended value = integer power of 2.



32
33
34
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 32

def memory_regions
  @memory_regions
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/vnic_roce_settings.rb', line 23

def object_type
  @object_type
end

#queue_pairs ⇒ Object

The number of queue pairs per adapter. Recommended value = integer power of 2.



35
36
37
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 35

def queue_pairs
  @queue_pairs
end

#resource_groups ⇒ Object

The number of resource groups per adapter. Recommended value = be an integer power of 2 greater than or equal to the number of CPU cores on the system for optimum performance.



38
39
40
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 38

def resource_groups
  @resource_groups
end

#version ⇒ Object

Configure RDMA over Converged Ethernet (RoCE) version on the virtual interface. Only RoCEv1 is supported on Cisco VIC 13xx series adapters and only RoCEv2 is supported on Cisco VIC 14xx series adapters. * 1 - RDMA over Converged Ethernet Protocol Version 1. * 2 - RDMA over Converged Ethernet Protocol Version 2.



41
42
43
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 41

def version
  @version
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)



85
86
87
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 85

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)



80
81
82
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 80

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.



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 66

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'class_of_service' => :'ClassOfService',
    :'enabled' => :'Enabled',
    :'memory_regions' => :'MemoryRegions',
    :'queue_pairs' => :'QueuePairs',
    :'resource_groups' => :'ResourceGroups',
    :'version' => :'Version'
  }
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



360
361
362
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 360

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



110
111
112
113
114
115
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 110

def self.openapi_all_of
  [
  :'MoBaseComplexType',
  :'VnicRoceSettingsAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



118
119
120
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 118

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 90

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'class_of_service' => :'Integer',
    :'enabled' => :'Boolean',
    :'memory_regions' => :'Integer',
    :'queue_pairs' => :'Integer',
    :'resource_groups' => :'Integer',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 332

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      class_of_service == o.class_of_service &&
      enabled == o.enabled &&
      memory_regions == o.memory_regions &&
      queue_pairs == o.queue_pairs &&
      resource_groups == o.resource_groups &&
      version == o.version && 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



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 391

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



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 462

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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 367

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


347
348
349
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 347

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



353
354
355
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 353

def hash
  [class_id, object_type, class_of_service, enabled, memory_regions, queue_pairs, resource_groups, version].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



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

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

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

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

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

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

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

  if !@resource_groups.nil? && @resource_groups < 0
    invalid_properties.push('invalid value for "resource_groups", must be greater than or equal to 0.')
  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



438
439
440
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 438

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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 444

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



432
433
434
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 432

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/intersight_client/models/vnic_roce_settings.rb', line 228

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["vnic.RoceSettings"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["vnic.RoceSettings"])
  return false unless object_type_validator.valid?(@object_type)
  class_of_service_validator = EnumAttributeValidator.new('Integer', [5, 1, 2, 4, 6])
  return false unless class_of_service_validator.valid?(@class_of_service)
  return false if !@memory_regions.nil? && @memory_regions > 524288
  return false if !@memory_regions.nil? && @memory_regions < 0
  return false if !@queue_pairs.nil? && @queue_pairs > 8192
  return false if !@queue_pairs.nil? && @queue_pairs < 0
  return false if !@resource_groups.nil? && @resource_groups > 128
  return false if !@resource_groups.nil? && @resource_groups < 0
  version_validator = EnumAttributeValidator.new('Integer', [1, 2])
  return false unless version_validator.valid?(@version)
  true && super
end