Class: Akeyless::GatewayUpdateProducerLdap

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

Overview

gatewayUpdateProducerLdap is a command that updates ldap producer

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayUpdateProducerLdap

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 134

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

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

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

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

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  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']
  end

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

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

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

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

  if attributes.key?(:'target_name')
    self.target_name = attributes[:'target_name']
  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

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

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

  if attributes.key?(:'user_ttl')
    self.user_ttl = attributes[:'user_ttl']
  else
    self.user_ttl = '60m'
  end
end

Instance Attribute Details

#bind_dn ⇒ Object

Bind DN



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

def bind_dn
  @bind_dn
end

#bind_dn_password ⇒ Object

Bind DN Password



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

def bind_dn_password
  @bind_dn_password
end

#delete_protection ⇒ Object

Protection from accidental deletion of this item [true/false]



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

def delete_protection
  @delete_protection
end

#external_username ⇒ Object

Externally provided username [true/false]



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

def external_username
  @external_username
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#ldap_ca_cert ⇒ Object

CA Certificate File Content



35
36
37
 
# File 'lib/akeyless/models/gateway_update_producer_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/gateway_update_producer_ldap.rb', line 38

def ldap_url
  @ldap_url
end

#name ⇒ Object

Producer name



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

def name
  @name
end

#new_name ⇒ Object

Producer name



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

def new_name
  @new_name
end

#producer_encryption_key_name ⇒ Object

Dynamic producer encryption key



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

def producer_encryption_key_name
  @producer_encryption_key_name
end

#tags ⇒ Object

List of the tags attached to this secret



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

def tags
  @tags
end

#target_name ⇒ Object

Target name



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

def target_name
  @target_name
end

#token ⇒ Object

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



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

def token
  @token
end

#token_expiration ⇒ Object

Token expiration



59
60
61
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 59

def token_expiration
  @token_expiration
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



62
63
64
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 62

def uid_token
  @uid_token
end

#user_attribute ⇒ Object

User Attribute



65
66
67
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 65

def user_attribute
  @user_attribute
end

#user_dn ⇒ Object

User DN



68
69
70
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 68

def user_dn
  @user_dn
end

#user_ttl ⇒ Object

User TTL



71
72
73
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 71

def user_ttl
  @user_ttl
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 98

def self.acceptable_attributes
  attribute_map.values
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
90
91
92
93
94
95
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 74

def self.attribute_map
  {
    :'bind_dn' => :'bind-dn',
    :'bind_dn_password' => :'bind-dn-password',
    :'delete_protection' => :'delete_protection',
    :'external_username' => :'external-username',
    :'json' => :'json',
    :'ldap_ca_cert' => :'ldap-ca-cert',
    :'ldap_url' => :'ldap-url',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'producer_encryption_key_name' => :'producer-encryption-key-name',
    :'tags' => :'tags',
    :'target_name' => :'target-name',
    :'token' => :'token',
    :'token_expiration' => :'token-expiration',
    :'uid_token' => :'uid-token',
    :'user_attribute' => :'user-attribute',
    :'user_dn' => :'user-dn',
    :'user_ttl' => :'user-ttl'
  }
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



286
287
288
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 286

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 103

def self.openapi_types
  {
    :'bind_dn' => :'String',
    :'bind_dn_password' => :'String',
    :'delete_protection' => :'String',
    :'external_username' => :'String',
    :'json' => :'Boolean',
    :'ldap_ca_cert' => :'String',
    :'ldap_url' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'producer_encryption_key_name' => :'String',
    :'tags' => :'Array<String>',
    :'target_name' => :'String',
    :'token' => :'String',
    :'token_expiration' => :'String',
    :'uid_token' => :'String',
    :'user_attribute' => :'String',
    :'user_dn' => :'String',
    :'user_ttl' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bind_dn == o.bind_dn &&
      bind_dn_password == o.bind_dn_password &&
      delete_protection == o.delete_protection &&
      external_username == o.external_username &&
      json == o.json &&
      ldap_ca_cert == o.ldap_ca_cert &&
      ldap_url == o.ldap_url &&
      name == o.name &&
      new_name == o.new_name &&
      producer_encryption_key_name == o.producer_encryption_key_name &&
      tags == o.tags &&
      target_name == o.target_name &&
      token == o.token &&
      token_expiration == o.token_expiration &&
      uid_token == o.uid_token &&
      user_attribute == o.user_attribute &&
      user_dn == o.user_dn &&
      user_ttl == o.user_ttl
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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 317

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 = Akeyless.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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 388

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 293

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


273
274
275
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



279
280
281
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 279

def hash
  [bind_dn, bind_dn_password, delete_protection, external_username, json, ldap_ca_cert, ldap_url, name, new_name, producer_encryption_key_name, tags, target_name, token, token_expiration, uid_token, user_attribute, user_dn, user_ttl].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



230
231
232
233
234
235
236
237
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 230

def list_invalid_properties
  invalid_properties = Array.new
  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



364
365
366
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 364

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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 370

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



358
359
360
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 358

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



241
242
243
244
 
# File 'lib/akeyless/models/gateway_update_producer_ldap.rb', line 241

def valid?
  return false if @name.nil?
  true
end