Class: IntersightClient::IamLdapPolicy

Inherits:
PolicyAbstractPolicy show all
Defined in:
lib/intersight_client/models/iam_ldap_policy.rb

Overview

LDAP Policy configurations.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PolicyAbstractPolicy

#description, #name

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

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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

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

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

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

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

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

  if attributes.key?(:'enabled')
    self.enabled = attributes[:'enabled']
  else
    self.enabled = true
  end

  if attributes.key?(:'user_search_precedence')
    self.user_search_precedence = attributes[:'user_search_precedence']
  else
    self.user_search_precedence = 'LocalUserDb'
  end

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

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

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

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

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

Instance Attribute Details

#appliance_account ⇒ Object

Returns the value of attribute appliance_account.



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

def 
  
end

#base_properties ⇒ Object

Returns the value of attribute base_properties.



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

def base_properties
  @base_properties
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_ldap_policy.rb', line 20

def class_id
  @class_id
end

#dns_parameters ⇒ Object

Returns the value of attribute dns_parameters.



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

def dns_parameters
  @dns_parameters
end

#enable_dns ⇒ Object

Enables DNS to access LDAP servers.



30
31
32
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 30

def enable_dns
  @enable_dns
end

#enabled ⇒ Object

LDAP server performs authentication.



33
34
35
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 33

def enabled
  @enabled
end

#groups ⇒ Object

An array of relationships to iamLdapGroup resources.



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

def groups
  @groups
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_ldap_policy.rb', line 23

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



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

def organization
  @organization
end

#profiles ⇒ Object

An array of relationships to policyAbstractConfigProfile resources.



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

def profiles
  @profiles
end

#providers ⇒ Object

An array of relationships to iamLdapProvider resources.



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

def providers
  @providers
end

#user_search_precedence ⇒ Object

Search precedence between local user database and LDAP user database. * LocalUserDb - Precedence is given to local user database while searching. * LDAPUserDb - Precedence is given to LADP user database while searching.



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

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



97
98
99
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 97

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)



92
93
94
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 92

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'base_properties' => :'BaseProperties',
    :'dns_parameters' => :'DnsParameters',
    :'enable_dns' => :'EnableDns',
    :'enabled' => :'Enabled',
    :'user_search_precedence' => :'UserSearchPrecedence',
    :'appliance_account' => :'ApplianceAccount',
    :'groups' => :'Groups',
    :'organization' => :'Organization',
    :'profiles' => :'Profiles',
    :'providers' => :'Providers'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



317
318
319
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 317

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



131
132
133
134
135
136
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 131

def self.openapi_all_of
  [
  :'IamLdapPolicyAllOf',
  :'PolicyAbstractPolicy'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



139
140
141
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 139

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



120
121
122
123
124
125
126
127
128
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 120

def self.openapi_nullable
  Set.new([
    :'base_properties',
    :'dns_parameters',
    :'groups',
    :'profiles',
    :'providers'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'base_properties' => :'IamLdapBaseProperties',
    :'dns_parameters' => :'IamLdapDnsParameters',
    :'enable_dns' => :'Boolean',
    :'enabled' => :'Boolean',
    :'user_search_precedence' => :'String',
    :'appliance_account' => :'IamAccountRelationship',
    :'groups' => :'Array<IamLdapGroupRelationship>',
    :'organization' => :'OrganizationOrganizationRelationship',
    :'profiles' => :'Array<PolicyAbstractConfigProfileRelationship>',
    :'providers' => :'Array<IamLdapProviderRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 285

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      base_properties == o.base_properties &&
      dns_parameters == o.dns_parameters &&
      enable_dns == o.enable_dns &&
      enabled == o.enabled &&
      user_search_precedence == o.user_search_precedence &&
       == o. &&
      groups == o.groups &&
      organization == o.organization &&
      profiles == o.profiles &&
      providers == o.providers && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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
384
385
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 348

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 419

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


304
305
306
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 304

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



310
311
312
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 310

def hash
  [class_id, object_type, base_properties, dns_parameters, enable_dns, enabled, user_search_precedence, , groups, organization, profiles, providers].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



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

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:

  • Returns the object in the form of hash



395
396
397
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 395

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 401

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



389
390
391
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 389

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/intersight_client/models/iam_ldap_policy.rb', line 241

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