Class: Akeyless::TargetCreateLdap

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/target_create_ldap.rb

Overview

targetCreateLdap is a command that creates a new ldap target

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TargetCreateLdap

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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
183
184
185
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 109

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::TargetCreateLdap` 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.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::TargetCreateLdap`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'bind_dn')
    self.bind_dn = attributes[:'bind_dn']
  else
    self.bind_dn = nil
  end

  if attributes.key?(:'bind_dn_password')
    self.bind_dn_password = attributes[:'bind_dn_password']
  else
    self.bind_dn_password = nil
  end

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

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

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

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

  if attributes.key?(:'ldap_url')
    self.ldap_url = attributes[:'ldap_url']
  else
    self.ldap_url = nil
  end

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

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

  if attributes.key?(:'server_type')
    self.server_type = attributes[:'server_type']
  else
    self.server_type = 'OpenLDAP'
  end

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

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

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

Instance Attribute Details

#bind_dn ⇒ Object

Bind DN



20
21
22
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 20

def bind_dn
  @bind_dn
end

#bind_dn_password ⇒ Object

Bind DN Password



23
24
25
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 23

def bind_dn_password
  @bind_dn_password
end

#description ⇒ Object

Description of the object



26
27
28
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 26

def description
  @description
end

#json ⇒ Object

Set output format to JSON



29
30
31
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 29

def json
  @json
end

#key ⇒ Object

The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)



32
33
34
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 32

def key
  @key
end

#ldap_ca_cert ⇒ Object

CA Certificate File Content



35
36
37
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 35

def ldap_ca_cert
  @ldap_ca_cert
end

#ldap_url ⇒ Object

LDAP Server URL



38
39
40
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 38

def ldap_url
  @ldap_url
end

#max_versions ⇒ Object

Set the maximum number of versions, limited by the account settings defaults.



41
42
43
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 41

def max_versions
  @max_versions
end

#name ⇒ Object

Target name



44
45
46
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 44

def name
  @name
end

#server_type ⇒ Object

Set Ldap server type, Options:[OpenLDAP, ActiveDirectory]. Default is OpenLDAP



47
48
49
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 47

def server_type
  @server_type
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



50
51
52
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 50

def token
  @token
end

#token_expiration ⇒ Object

Token expiration



53
54
55
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 53

def token_expiration
  @token_expiration
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



56
57
58
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 56

def uid_token
  @uid_token
end

Class Method Details

._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



281
282
283
284
285
286
287
288
289
290
291
292
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
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 281

def self._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 = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 59

def self.attribute_map
  {
    :'bind_dn' => :'bind-dn',
    :'bind_dn_password' => :'bind-dn-password',
    :'description' => :'description',
    :'json' => :'json',
    :'key' => :'key',
    :'ldap_ca_cert' => :'ldap-ca-cert',
    :'ldap_url' => :'ldap-url',
    :'max_versions' => :'max-versions',
    :'name' => :'name',
    :'server_type' => :'server-type',
    :'token' => :'token',
    :'token_expiration' => :'token-expiration',
    :'uid_token' => :'uid-token'
  }
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 257

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 83

def self.openapi_types
  {
    :'bind_dn' => :'String',
    :'bind_dn_password' => :'String',
    :'description' => :'String',
    :'json' => :'Boolean',
    :'key' => :'String',
    :'ldap_ca_cert' => :'String',
    :'ldap_url' => :'String',
    :'max_versions' => :'String',
    :'name' => :'String',
    :'server_type' => :'String',
    :'token' => :'String',
    :'token_expiration' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bind_dn == o.bind_dn &&
      bind_dn_password == o.bind_dn_password &&
      description == o.description &&
      json == o.json &&
      key == o.key &&
      ldap_ca_cert == o.ldap_ca_cert &&
      ldap_url == o.ldap_url &&
      max_versions == o.max_versions &&
      name == o.name &&
      server_type == o.server_type &&
      token == o.token &&
      token_expiration == o.token_expiration &&
      uid_token == o.uid_token
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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 352

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


244
245
246
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 250

def hash
  [bind_dn, bind_dn_password, description, json, key, ldap_ca_cert, ldap_url, max_versions, name, server_type, token, token_expiration, uid_token].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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 189

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @bind_dn.nil?
    invalid_properties.push('invalid value for "bind_dn", bind_dn cannot be nil.')
  end

  if @bind_dn_password.nil?
    invalid_properties.push('invalid value for "bind_dn_password", bind_dn_password cannot be nil.')
  end

  if @ldap_url.nil?
    invalid_properties.push('invalid value for "ldap_url", ldap_url cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



328
329
330
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 328

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 334

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



322
323
324
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 322

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



213
214
215
216
217
218
219
220
 
# File 'lib/akeyless/models/target_create_ldap.rb', line 213

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @bind_dn.nil?
  return false if @bind_dn_password.nil?
  return false if @ldap_url.nil?
  return false if @name.nil?
  true
end