Class: IntersightClient::IamPermission

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

Overview

Permission provides a way to assign roles to a user or user group to perform operations on object hierarchy.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



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

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

def class_id
  @class_id
end

#description ⇒ Object

The informative description about each permission.



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

def description
  @description
end

#end_point_roles ⇒ Object

An array of relationships to iamEndPointRole resources.



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

def end_point_roles
  @end_point_roles
end

#name ⇒ Object

The name of the permission which has to be granted to user.



29
30
31
 
# File 'lib/intersight_client/models/iam_permission.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/iam_permission.rb', line 23

def object_type
  @object_type
end

#privilege_sets ⇒ Object

An array of relationships to iamPrivilegeSet resources.



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

def privilege_sets
  @privilege_sets
end

#resource_roles ⇒ Object

An array of relationships to iamResourceRoles resources.



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

def resource_roles
  @resource_roles
end

#roles ⇒ Object

An array of relationships to iamRole resources.



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

def roles
  @roles
end

#session_limits ⇒ Object

Returns the value of attribute session_limits.



45
46
47
 
# File 'lib/intersight_client/models/iam_permission.rb', line 45

def session_limits
  @session_limits
end

#user_groups ⇒ Object

An array of relationships to iamUserGroup resources.



48
49
50
 
# File 'lib/intersight_client/models/iam_permission.rb', line 48

def user_groups
  @user_groups
end

#users ⇒ Object

An array of relationships to iamUser resources.



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

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



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

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)



94
95
96
 
# File 'lib/intersight_client/models/iam_permission.rb', line 94

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.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/intersight_client/models/iam_permission.rb', line 76

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'description' => :'Description',
    :'name' => :'Name',
    :'account' => :'Account',
    :'end_point_roles' => :'EndPointRoles',
    :'privilege_sets' => :'PrivilegeSets',
    :'resource_roles' => :'ResourceRoles',
    :'roles' => :'Roles',
    :'session_limits' => :'SessionLimits',
    :'user_groups' => :'UserGroups',
    :'users' => :'Users'
  }
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



345
346
347
 
# File 'lib/intersight_client/models/iam_permission.rb', line 345

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



134
135
136
137
138
139
 
# File 'lib/intersight_client/models/iam_permission.rb', line 134

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



142
143
144
 
# File 'lib/intersight_client/models/iam_permission.rb', line 142

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
127
128
129
130
131
 
# File 'lib/intersight_client/models/iam_permission.rb', line 122

def self.openapi_nullable
  Set.new([
    :'end_point_roles',
    :'privilege_sets',
    :'resource_roles',
    :'roles',
    :'user_groups',
    :'users'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/intersight_client/models/iam_permission.rb', line 104

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'description' => :'String',
    :'name' => :'String',
    :'account' => :'IamAccountRelationship',
    :'end_point_roles' => :'Array<IamEndPointRoleRelationship>',
    :'privilege_sets' => :'Array<IamPrivilegeSetRelationship>',
    :'resource_roles' => :'Array<IamResourceRolesRelationship>',
    :'roles' => :'Array<IamRoleRelationship>',
    :'session_limits' => :'IamSessionLimitsRelationship',
    :'user_groups' => :'Array<IamUserGroupRelationship>',
    :'users' => :'Array<IamUserRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/intersight_client/models/iam_permission.rb', line 313

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 &&
       == o. &&
      end_point_roles == o.end_point_roles &&
      privilege_sets == o.privilege_sets &&
      resource_roles == o.resource_roles &&
      roles == o.roles &&
      session_limits == o.session_limits &&
      user_groups == o.user_groups &&
      users == o.users && 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



376
377
378
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
 
# File 'lib/intersight_client/models/iam_permission.rb', line 376

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



447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/intersight_client/models/iam_permission.rb', line 447

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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/intersight_client/models/iam_permission.rb', line 352

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


332
333
334
 
# File 'lib/intersight_client/models/iam_permission.rb', line 332

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



338
339
340
 
# File 'lib/intersight_client/models/iam_permission.rb', line 338

def hash
  [class_id, object_type, description, name, , end_point_roles, privilege_sets, resource_roles, roles, session_limits, user_groups, users].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



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

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 > 64
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 64.')
  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,64}$/)
  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



423
424
425
 
# File 'lib/intersight_client/models/iam_permission.rb', line 423

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



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/intersight_client/models/iam_permission.rb', line 429

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



417
418
419
 
# File 'lib/intersight_client/models/iam_permission.rb', line 417

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



259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/intersight_client/models/iam_permission.rb', line 259

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