Class: IntersightClient::IamPrivilege

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

Overview

Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 127

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



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

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

def class_id
  @class_id
end

#hostname_prefix ⇒ Object

The hostname prefix of the resource corresponding to this privilege. For example \‘sentry\’ in sentry.intersight.com .



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

def hostname_prefix
  @hostname_prefix
end

#method ⇒ Object

The API method on the rest resource corresponding to privilege. For example READ, CREATE, UPDATE etc.



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

def method
  @method
end

#name ⇒ Object

The name of the privilege reported by microservice.



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

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

def object_type
  @object_type
end

#rest_path ⇒ Object

The REST API path of the resource corresponding to this privilege. For example /v1/iam/Accounts, /v1/iam/Sessions.



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

def rest_path
  @rest_path
end

#system ⇒ Object

Returns the value of attribute system.



42
43
44
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 42

def system
  @system
end

#url_prefix ⇒ Object

The URL path prefix of the resource corresponding to this privilege. For example /devops/kibana, /devops/grafana etc.



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

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



87
88
89
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 87

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)



82
83
84
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 82

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.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 67

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'hostname_prefix' => :'HostnamePrefix',
    :'method' => :'Method',
    :'name' => :'Name',
    :'rest_path' => :'RestPath',
    :'url_prefix' => :'UrlPrefix',
    :'account' => :'Account',
    :'system' => :'System'
  }
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



262
263
264
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 262

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



113
114
115
116
117
118
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 113

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



121
122
123
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 121

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'hostname_prefix' => :'String',
    :'method' => :'String',
    :'name' => :'String',
    :'rest_path' => :'String',
    :'url_prefix' => :'String',
    :'account' => :'IamAccountRelationship',
    :'system' => :'IamSystemRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      hostname_prefix == o.hostname_prefix &&
      method == o.method &&
      name == o.name &&
      rest_path == o.rest_path &&
      url_prefix == o.url_prefix &&
       == o. &&
      system == o.system && 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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 293

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 364

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 269

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


249
250
251
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 255

def hash
  [class_id, object_type, hostname_prefix, method, name, rest_path, url_prefix, , system].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



186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 186

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



340
341
342
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 340

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 346

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



334
335
336
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 334

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



201
202
203
204
205
206
207
208
209
 
# File 'lib/intersight_client/models/iam_privilege.rb', line 201

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["iam.Privilege"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["iam.Privilege"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end