Class: IntersightClient::VnicFcErrorRecoverySettings

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

Overview

Fibre Channel Error Recovery Settings.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VnicFcErrorRecoverySettings

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

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

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

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

  if attributes.key?(:'io_retry_count')
    self.io_retry_count = attributes[:'io_retry_count']
  else
    self.io_retry_count = 8
  end

  if attributes.key?(:'io_retry_timeout')
    self.io_retry_timeout = attributes[:'io_retry_timeout']
  else
    self.io_retry_timeout = 5
  end

  if attributes.key?(:'link_down_timeout')
    self.link_down_timeout = attributes[:'link_down_timeout']
  else
    self.link_down_timeout = 30000
  end

  if attributes.key?(:'port_down_timeout')
    self.port_down_timeout = attributes[:'port_down_timeout']
  else
    self.port_down_timeout = 10000
  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_fc_error_recovery_settings.rb', line 20

def class_id
  @class_id
end

#enabled ⇒ Object

Enables Fibre Channel Error recovery.



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

def enabled
  @enabled
end

#io_retry_count ⇒ Object

The number of times an I/O request to a port is retried because the port is busy before the system decides the port is unavailable.



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

def io_retry_count
  @io_retry_count
end

#io_retry_timeout ⇒ Object

The number of seconds the adapter waits before aborting the pending command and resending the same IO request.



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

def io_retry_timeout
  @io_retry_timeout
end

#link_down_timeout ⇒ Object

The number of milliseconds the port should actually be down before it is marked down and fabric connectivity is lost.



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

def link_down_timeout
  @link_down_timeout
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_fc_error_recovery_settings.rb', line 23

def object_type
  @object_type
end

#port_down_timeout ⇒ Object

The number of milliseconds a remote Fibre Channel port should be offline before informing the SCSI upper layer that the port is unavailable. For a server with a VIC adapter running ESXi, the recommended value is 10000. For a server with a port used to boot a Windows OS from the SAN, the recommended value is 5000 milliseconds.



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

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



81
82
83
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 81

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)



76
77
78
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 76

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.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 63

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'enabled' => :'Enabled',
    :'io_retry_count' => :'IoRetryCount',
    :'io_retry_timeout' => :'IoRetryTimeout',
    :'link_down_timeout' => :'LinkDownTimeout',
    :'port_down_timeout' => :'PortDownTimeout'
  }
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



348
349
350
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 348

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



105
106
107
108
109
110
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 105

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



113
114
115
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 113

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 86

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'enabled' => :'Boolean',
    :'io_retry_count' => :'Integer',
    :'io_retry_timeout' => :'Integer',
    :'link_down_timeout' => :'Integer',
    :'port_down_timeout' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 321

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      enabled == o.enabled &&
      io_retry_count == o.io_retry_count &&
      io_retry_timeout == o.io_retry_timeout &&
      link_down_timeout == o.link_down_timeout &&
      port_down_timeout == o.port_down_timeout && 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



379
380
381
382
383
384
385
386
387
388
389
390
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
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 379

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



450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 450

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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 355

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


335
336
337
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 335

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



341
342
343
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 341

def hash
  [class_id, object_type, enabled, io_retry_count, io_retry_timeout, link_down_timeout, port_down_timeout].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



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

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 !@io_retry_count.nil? && @io_retry_count > 255
    invalid_properties.push('invalid value for "io_retry_count", must be smaller than or equal to 255.')
  end

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

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

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

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

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

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

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



426
427
428
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 426

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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 432

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



420
421
422
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 420

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/intersight_client/models/vnic_fc_error_recovery_settings.rb', line 225

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["vnic.FcErrorRecoverySettings"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["vnic.FcErrorRecoverySettings"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@io_retry_count.nil? && @io_retry_count > 255
  return false if !@io_retry_count.nil? && @io_retry_count < 0
  return false if !@io_retry_timeout.nil? && @io_retry_timeout > 59
  return false if !@io_retry_timeout.nil? && @io_retry_timeout < 1
  return false if !@link_down_timeout.nil? && @link_down_timeout > 240000
  return false if !@link_down_timeout.nil? && @link_down_timeout < 0
  return false if !@port_down_timeout.nil? && @port_down_timeout > 240000
  return false if !@port_down_timeout.nil? && @port_down_timeout < 0
  true && super
end