Class: IntersightClient::MetaDefinition

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

Overview

The meta-data of managed objects and complex types.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/intersight_client/models/meta_definition.rb', line 174

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

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

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

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

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

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

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

  if attributes.key?(:'meta_type')
    self.meta_type = attributes[:'meta_type']
  else
    self.meta_type = 'ManagedObject'
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_privileges ⇒ Object

Returns the value of attribute access_privileges.



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

def access_privileges
  @access_privileges
end

#ancestor_classes ⇒ Object

Returns the value of attribute ancestor_classes.



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

def ancestor_classes
  @ancestor_classes
end

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

def class_id
  @class_id
end

#display_name_metas ⇒ Object

Returns the value of attribute display_name_metas.



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

def display_name_metas
  @display_name_metas
end

#identity_constraints ⇒ Object

Returns the value of attribute identity_constraints.



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

def identity_constraints
  @identity_constraints
end

#is_concrete ⇒ Object

Boolean flag to specify whether the meta class is a concrete class or not.



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

def is_concrete
  @is_concrete
end

#meta_type ⇒ Object

Indicates whether the meta class is a complex type or managed object. * ‘ManagedObject` - The meta.Definition object describes a managed object. * `ComplexType` - The meta.Definition object describes a nested complex type within a managed object.



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

def meta_type
  @meta_type
end

#name ⇒ Object

The fully-qualified class name of the Managed Object or complex type. For example, "compute:Blade" where the Managed Object is "Blade" and the package is ‘compute’.



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

def name
  @name
end

#namespace ⇒ Object

The namespace of the meta.



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

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

def object_type
  @object_type
end

#parent_class ⇒ Object

The fully-qualified name of the parent metaclass in the class inheritance hierarchy.



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

def parent_class
  @parent_class
end

#permission_supported ⇒ Object

Boolean flag to specify whether instances of this class type can be specified in permissions for instance based access control. Permissions can be created for entire Intersight account or to a subset of resources (instance based access control). In the first release, permissions are supported for entire account or for a subset of organizations.



49
50
51
 
# File 'lib/intersight_client/models/meta_definition.rb', line 49

def permission_supported
  @permission_supported
end

#properties ⇒ Object

Returns the value of attribute properties.



51
52
53
 
# File 'lib/intersight_client/models/meta_definition.rb', line 51

def properties
  @properties
end

#rbac_resource ⇒ Object

Boolean flag to specify whether instances of this class type can be assigned to resource groups that are part of an organization for access control. Inventoried physical/logical objects which needs access control should have rbacResource=true. These objects are not part of any organization by default like device registrations and should be assigned to organizations for access control. Profiles, policies, workflow definitions which are created by specifying organization need not have this flag set.



54
55
56
 
# File 'lib/intersight_client/models/meta_definition.rb', line 54

def rbac_resource
  @rbac_resource
end

#relationships ⇒ Object

Returns the value of attribute relationships.



56
57
58
 
# File 'lib/intersight_client/models/meta_definition.rb', line 56

def relationships
  @relationships
end

#resource_pool_types ⇒ Object

Returns the value of attribute resource_pool_types.



58
59
60
 
# File 'lib/intersight_client/models/meta_definition.rb', line 58

def resource_pool_types
  @resource_pool_types
end

#rest_path ⇒ Object

Restful URL path for the meta.



61
62
63
 
# File 'lib/intersight_client/models/meta_definition.rb', line 61

def rest_path
  @rest_path
end

#version ⇒ Object

The version of the service that defines the meta-data.



64
65
66
 
# File 'lib/intersight_client/models/meta_definition.rb', line 64

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)



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

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)



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

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.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/intersight_client/models/meta_definition.rb', line 89

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'access_privileges' => :'AccessPrivileges',
    :'ancestor_classes' => :'AncestorClasses',
    :'display_name_metas' => :'DisplayNameMetas',
    :'identity_constraints' => :'IdentityConstraints',
    :'is_concrete' => :'IsConcrete',
    :'meta_type' => :'MetaType',
    :'name' => :'Name',
    :'namespace' => :'Namespace',
    :'parent_class' => :'ParentClass',
    :'permission_supported' => :'PermissionSupported',
    :'properties' => :'Properties',
    :'rbac_resource' => :'RbacResource',
    :'relationships' => :'Relationships',
    :'resource_pool_types' => :'ResourcePoolTypes',
    :'rest_path' => :'RestPath',
    :'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



382
383
384
 
# File 'lib/intersight_client/models/meta_definition.rb', line 382

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



160
161
162
163
164
165
 
# File 'lib/intersight_client/models/meta_definition.rb', line 160

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



168
169
170
 
# File 'lib/intersight_client/models/meta_definition.rb', line 168

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/intersight_client/models/meta_definition.rb', line 147

def self.openapi_nullable
  Set.new([
    :'access_privileges',
    :'ancestor_classes',
    :'display_name_metas',
    :'identity_constraints',
    :'properties',
    :'relationships',
    :'resource_pool_types',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/intersight_client/models/meta_definition.rb', line 123

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'access_privileges' => :'Array<MetaAccessPrivilege>',
    :'ancestor_classes' => :'Array<String>',
    :'display_name_metas' => :'Array<MetaDisplayNameDefinition>',
    :'identity_constraints' => :'Array<MetaIdentityDefinition>',
    :'is_concrete' => :'Boolean',
    :'meta_type' => :'String',
    :'name' => :'String',
    :'namespace' => :'String',
    :'parent_class' => :'String',
    :'permission_supported' => :'Boolean',
    :'properties' => :'Array<MetaPropDefinition>',
    :'rbac_resource' => :'Boolean',
    :'relationships' => :'Array<MetaRelationshipDefinition>',
    :'resource_pool_types' => :'Array<String>',
    :'rest_path' => :'String',
    :'version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/intersight_client/models/meta_definition.rb', line 344

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      access_privileges == o.access_privileges &&
      ancestor_classes == o.ancestor_classes &&
      display_name_metas == o.display_name_metas &&
      identity_constraints == o.identity_constraints &&
      is_concrete == o.is_concrete &&
      meta_type == o.meta_type &&
      name == o.name &&
      namespace == o.namespace &&
      parent_class == o.parent_class &&
      permission_supported == o.permission_supported &&
      properties == o.properties &&
      rbac_resource == o.rbac_resource &&
      relationships == o.relationships &&
      resource_pool_types == o.resource_pool_types &&
      rest_path == o.rest_path &&
      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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/intersight_client/models/meta_definition.rb', line 413

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



484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/intersight_client/models/meta_definition.rb', line 484

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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/intersight_client/models/meta_definition.rb', line 389

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


369
370
371
 
# File 'lib/intersight_client/models/meta_definition.rb', line 369

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



375
376
377
 
# File 'lib/intersight_client/models/meta_definition.rb', line 375

def hash
  [class_id, object_type, access_privileges, ancestor_classes, display_name_metas, identity_constraints, is_concrete, meta_type, name, namespace, parent_class, permission_supported, properties, rbac_resource, relationships, resource_pool_types, rest_path, 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



285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/intersight_client/models/meta_definition.rb', line 285

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



460
461
462
 
# File 'lib/intersight_client/models/meta_definition.rb', line 460

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



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/intersight_client/models/meta_definition.rb', line 466

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



454
455
456
 
# File 'lib/intersight_client/models/meta_definition.rb', line 454

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



300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/intersight_client/models/meta_definition.rb', line 300

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["meta.Definition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["meta.Definition"])
  return false unless object_type_validator.valid?(@object_type)
  meta_type_validator = EnumAttributeValidator.new('String', ["ManagedObject", "ComplexType"])
  return false unless meta_type_validator.valid?(@meta_type)
  true && super
end