Class: IntersightClient::ResourceGroup

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

Overview

A group of REST resources, such as a group of compute.Blade MOs. A ResourceGroup can contain static members which are specified as a set of object references, or it can contain dynamic members, which are specified through OData query filters. A Resource can be part of multiple resource groups.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
191
192
 
# File 'lib/intersight_client/models/resource_group.rb', line 129

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

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

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

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

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

  if attributes.key?(:'qualifier')
    self.qualifier = attributes[:'qualifier']
  else
    self.qualifier = 'Allow-Selectors'
  end

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



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

def 
  @account
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/resource_group.rb', line 20

def class_id
  @class_id
end

#description ⇒ Object

The informative description about the usage of this Resource Group.



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

def description
  @description
end

#name ⇒ Object

The name of this resource group.



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

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

def object_type
  @object_type
end

#organizations ⇒ Object

An array of relationships to organizationOrganization resources.



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

def organizations
  @organizations
end

#per_type_combined_selector ⇒ Object

Returns the value of attribute per_type_combined_selector.



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

def per_type_combined_selector
  @per_type_combined_selector
end

#qualifier ⇒ Object

Qualifier shall be used to specify if we want to organize resources using multiple resource group or single For an account, resource groups can be of only one of the above types. (Both the types are mutually exclusive for an account.). * ‘Allow-Selectors` - Resources will be added to resource groups based on ODATA filter. Multiple resource group can be created to organize resources. * `Allow-All` - All resources will become part of the Resource Group. Only one resource group can be created to organize resources.



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

def qualifier
  @qualifier
end

#selectors ⇒ Object

Returns the value of attribute selectors.



36
37
38
 
# File 'lib/intersight_client/models/resource_group.rb', line 36

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



86
87
88
 
# File 'lib/intersight_client/models/resource_group.rb', line 86

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)



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

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
78
 
# File 'lib/intersight_client/models/resource_group.rb', line 66

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'description' => :'Description',
    :'name' => :'Name',
    :'per_type_combined_selector' => :'PerTypeCombinedSelector',
    :'qualifier' => :'Qualifier',
    :'selectors' => :'Selectors',
    :'account' => :'Account',
    :'organizations' => :'Organizations'
  }
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



319
320
321
 
# File 'lib/intersight_client/models/resource_group.rb', line 319

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



115
116
117
118
119
120
 
# File 'lib/intersight_client/models/resource_group.rb', line 115

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



123
124
125
 
# File 'lib/intersight_client/models/resource_group.rb', line 123

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
110
111
112
 
# File 'lib/intersight_client/models/resource_group.rb', line 106

def self.openapi_nullable
  Set.new([
    :'per_type_combined_selector',
    :'selectors',
    :'organizations'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'description' => :'String',
    :'name' => :'String',
    :'per_type_combined_selector' => :'Array<ResourcePerTypeCombinedSelector>',
    :'qualifier' => :'String',
    :'selectors' => :'Array<ResourceSelector>',
    :'account' => :'IamAccountRelationship',
    :'organizations' => :'Array<OrganizationOrganizationRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/intersight_client/models/resource_group.rb', line 290

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      description == o.description &&
      name == o.name &&
      per_type_combined_selector == o.per_type_combined_selector &&
      qualifier == o.qualifier &&
      selectors == o.selectors &&
       == o. &&
      organizations == o.organizations && 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



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
384
385
386
387
 
# File 'lib/intersight_client/models/resource_group.rb', line 350

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



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/intersight_client/models/resource_group.rb', line 421

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/intersight_client/models/resource_group.rb', line 326

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


306
307
308
 
# File 'lib/intersight_client/models/resource_group.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



312
313
314
 
# File 'lib/intersight_client/models/resource_group.rb', line 312

def hash
  [class_id, object_type, description, name, per_type_combined_selector, qualifier, selectors, , organizations].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



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

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

  if !@name.nil? && @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_.:-]{1,128}$/)
  if !@name.nil? && @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  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



397
398
399
 
# File 'lib/intersight_client/models/resource_group.rb', line 397

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



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/intersight_client/models/resource_group.rb', line 403

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



391
392
393
 
# File 'lib/intersight_client/models/resource_group.rb', line 391

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/intersight_client/models/resource_group.rb', line 224

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["resource.Group"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["resource.Group"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@name.nil? && @name.to_s.length > 128
  return false if !@name.nil? && @name.to_s.length < 1
  return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z0-9_.:-]{1,128}$/)
  qualifier_validator = EnumAttributeValidator.new('String', ["Allow-Selectors", "Allow-All"])
  return false unless qualifier_validator.valid?(@qualifier)
  true && super
end