Class: IntersightClient::FabricVsan

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/fabric_vsan.rb

Overview

Configuration object sent by user to create VSAN configurations.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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 = {}) ⇒ FabricVsan

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'default_zoning')
    self.default_zoning = attributes[:'default_zoning']
  else
    self.default_zoning = 'Enabled'
  end

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

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

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

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

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

Instance Attribute Details

#class_idObject

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/fabric_vsan.rb', line 20

def class_id
  @class_id
end

#default_zoningObject

Enables or Disables the default zoning state. * Enabled - Admin configured Enabled State. * Disabled - Admin configured Disabled State.



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

def default_zoning
  @default_zoning
end

#fc_network_policyObject

Returns the value of attribute fc_network_policy.



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

def fc_network_policy
  @fc_network_policy
end

#fc_zone_sharing_modeObject

Logical grouping mode for fc ports.



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

def fc_zone_sharing_mode
  @fc_zone_sharing_mode
end

#fcoe_vlanObject

FCOE Vlan associated to the VSAN configuration.



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

def fcoe_vlan
  @fcoe_vlan
end

#nameObject

User given name for the VSAN configuration.



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

def name
  @name
end

#object_typeObject

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/fabric_vsan.rb', line 23

def object_type
  @object_type
end

#vsan_idObject

Virtual San Identifier in the switch.



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

def vsan_id
  @vsan_id
end

Class Method Details

.acceptable_attribute_mapObject

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



84
85
86
# File 'lib/intersight_client/models/fabric_vsan.rb', line 84

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

.acceptable_attributesObject

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



79
80
81
# File 'lib/intersight_client/models/fabric_vsan.rb', line 79

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

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'default_zoning' => :'DefaultZoning',
    :'fc_zone_sharing_mode' => :'FcZoneSharingMode',
    :'fcoe_vlan' => :'FcoeVlan',
    :'name' => :'Name',
    :'vsan_id' => :'VsanId',
    :'fc_network_policy' => :'FcNetworkPolicy'
  }
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



315
316
317
# File 'lib/intersight_client/models/fabric_vsan.rb', line 315

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'FabricVsanAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



117
118
119
# File 'lib/intersight_client/models/fabric_vsan.rb', line 117

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



103
104
105
106
# File 'lib/intersight_client/models/fabric_vsan.rb', line 103

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'default_zoning' => :'String',
    :'fc_zone_sharing_mode' => :'String',
    :'fcoe_vlan' => :'Integer',
    :'name' => :'String',
    :'vsan_id' => :'Integer',
    :'fc_network_policy' => :'FabricFcNetworkPolicyRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/intersight_client/models/fabric_vsan.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      default_zoning == o.default_zoning &&
      fc_zone_sharing_mode == o.fc_zone_sharing_mode &&
      fcoe_vlan == o.fcoe_vlan &&
      name == o.name &&
      vsan_id == o.vsan_id &&
      fc_network_policy == o.fc_network_policy && 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



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
378
379
380
381
382
383
# File 'lib/intersight_client/models/fabric_vsan.rb', line 346

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



417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'lib/intersight_client/models/fabric_vsan.rb', line 417

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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/intersight_client/models/fabric_vsan.rb', line 322

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



308
309
310
# File 'lib/intersight_client/models/fabric_vsan.rb', line 308

def hash
  [class_id, object_type, default_zoning, fc_zone_sharing_mode, fcoe_vlan, name, vsan_id, fc_network_policy].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



393
394
395
# File 'lib/intersight_client/models/fabric_vsan.rb', line 393

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



399
400
401
402
403
404
405
406
407
408
409
410
411
# File 'lib/intersight_client/models/fabric_vsan.rb', line 399

def to_hash
  hash = super
  FabricVsan.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = FabricVsan.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



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

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/intersight_client/models/fabric_vsan.rb', line 211

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["fabric.Vsan"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["fabric.Vsan"])
  return false unless object_type_validator.valid?(@object_type)
  default_zoning_validator = EnumAttributeValidator.new('String', ["Enabled", "Disabled"])
  return false unless default_zoning_validator.valid?(@default_zoning)
  return false if !@fcoe_vlan.nil? && @fcoe_vlan > 4093
  return false if !@fcoe_vlan.nil? && @fcoe_vlan < 1
  return false if !@vsan_id.nil? && @vsan_id > 4093
  return false if !@vsan_id.nil? && @vsan_id < 1
  true && super
end