Class: Akeyless::DynamicSecretUpdateMongoDb

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

Overview

dynamicSecretUpdateMongoDb is a command that updates either mongodb dynamic secret or mongodb atlas dynamic secret

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DynamicSecretUpdateMongoDb

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
228
229
230
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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
319
320
321
322
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 184

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#mongodb_atlas_api_private_key ⇒ Object

MongoDB Atlas private key



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

def mongodb_atlas_api_private_key
  @mongodb_atlas_api_private_key
end

#mongodb_atlas_api_public_key ⇒ Object

MongoDB Atlas public key



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

def mongodb_atlas_api_public_key
  @mongodb_atlas_api_public_key
end

#mongodb_atlas_project_id ⇒ Object

MongoDB Atlas project ID



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

def mongodb_atlas_project_id
  @mongodb_atlas_project_id
end

#mongodb_custom_data ⇒ Object

MongoDB custom data



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

def mongodb_custom_data
  @mongodb_custom_data
end

#mongodb_default_auth_db ⇒ Object

MongoDB server default authentication database



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

def mongodb_default_auth_db
  @mongodb_default_auth_db
end

#mongodb_host_port ⇒ Object

MongoDB server host and port



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

def mongodb_host_port
  @mongodb_host_port
end

#mongodb_name ⇒ Object

MongoDB Name



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

def mongodb_name
  @mongodb_name
end

#mongodb_password ⇒ Object

MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters



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

def mongodb_password
  @mongodb_password
end

#mongodb_roles ⇒ Object

MongoDB Roles



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

def mongodb_roles
  @mongodb_roles
end

#mongodb_server_uri ⇒ Object

MongoDB server URI



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

def mongodb_server_uri
  @mongodb_server_uri
end

#mongodb_uri_options ⇒ Object

MongoDB server URI options



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

def mongodb_uri_options
  @mongodb_uri_options
end

#mongodb_username ⇒ Object

MongoDB server username



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

def mongodb_username
  @mongodb_username
end

#name ⇒ Object

Dynamic secret name



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

def name
  @name
end

#new_name ⇒ Object

Dynamic secret name



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

def new_name
  @new_name
end

#password_length ⇒ Object

The length of the password to be generated



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

def password_length
  @password_length
end

#producer_encryption_key_name ⇒ Object

Encrypt producer with following key



74
75
76
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 74

def producer_encryption_key_name
  @producer_encryption_key_name
end

#secure_access_bastion_issuer ⇒ Object

Path to the SSH Certificate Issuer for your Akeyless Bastion



77
78
79
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 77

def secure_access_bastion_issuer
  @secure_access_bastion_issuer
end

#secure_access_enable ⇒ Object

Enable/Disable secure remote access [true/false]



80
81
82
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 80

def secure_access_enable
  @secure_access_enable
end

#secure_access_host ⇒ Object

Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)



83
84
85
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 83

def secure_access_host
  @secure_access_host
end

#secure_access_web ⇒ Object

Enable Web Secure Remote Access



86
87
88
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 86

def secure_access_web
  @secure_access_web
end

#tags ⇒ Object

Add tags attached to this object



89
90
91
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 89

def tags
  @tags
end

#target_name ⇒ Object

Target name



92
93
94
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 92

def target_name
  @target_name
end

#token ⇒ Object

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



95
96
97
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 95

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
end

#user_ttl ⇒ Object

User TTL



101
102
103
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 101

def user_ttl
  @user_ttl
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



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 418

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



138
139
140
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 138

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



104
105
106
107
108
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
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 104

def self.attribute_map
  {
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'json' => :'json',
    :'mongodb_atlas_api_private_key' => :'mongodb-atlas-api-private-key',
    :'mongodb_atlas_api_public_key' => :'mongodb-atlas-api-public-key',
    :'mongodb_atlas_project_id' => :'mongodb-atlas-project-id',
    :'mongodb_custom_data' => :'mongodb-custom-data',
    :'mongodb_default_auth_db' => :'mongodb-default-auth-db',
    :'mongodb_host_port' => :'mongodb-host-port',
    :'mongodb_name' => :'mongodb-name',
    :'mongodb_password' => :'mongodb-password',
    :'mongodb_roles' => :'mongodb-roles',
    :'mongodb_server_uri' => :'mongodb-server-uri',
    :'mongodb_uri_options' => :'mongodb-uri-options',
    :'mongodb_username' => :'mongodb-username',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'password_length' => :'password-length',
    :'producer_encryption_key_name' => :'producer-encryption-key-name',
    :'secure_access_bastion_issuer' => :'secure-access-bastion-issuer',
    :'secure_access_enable' => :'secure-access-enable',
    :'secure_access_host' => :'secure-access-host',
    :'secure_access_web' => :'secure-access-web',
    :'tags' => :'tags',
    :'target_name' => :'target-name',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 394

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



177
178
179
180
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 177

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'json' => :'Boolean',
    :'mongodb_atlas_api_private_key' => :'String',
    :'mongodb_atlas_api_public_key' => :'String',
    :'mongodb_atlas_project_id' => :'String',
    :'mongodb_custom_data' => :'String',
    :'mongodb_default_auth_db' => :'String',
    :'mongodb_host_port' => :'String',
    :'mongodb_name' => :'String',
    :'mongodb_password' => :'String',
    :'mongodb_roles' => :'String',
    :'mongodb_server_uri' => :'String',
    :'mongodb_uri_options' => :'String',
    :'mongodb_username' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'password_length' => :'String',
    :'producer_encryption_key_name' => :'String',
    :'secure_access_bastion_issuer' => :'String',
    :'secure_access_enable' => :'String',
    :'secure_access_host' => :'Array<String>',
    :'secure_access_web' => :'Boolean',
    :'tags' => :'Array<String>',
    :'target_name' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'user_ttl' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



346
347
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
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 346

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      json == o.json &&
      mongodb_atlas_api_private_key == o.mongodb_atlas_api_private_key &&
      mongodb_atlas_api_public_key == o.mongodb_atlas_api_public_key &&
      mongodb_atlas_project_id == o.mongodb_atlas_project_id &&
      mongodb_custom_data == o.mongodb_custom_data &&
      mongodb_default_auth_db == o.mongodb_default_auth_db &&
      mongodb_host_port == o.mongodb_host_port &&
      mongodb_name == o.mongodb_name &&
      mongodb_password == o.mongodb_password &&
      mongodb_roles == o.mongodb_roles &&
      mongodb_server_uri == o.mongodb_server_uri &&
      mongodb_uri_options == o.mongodb_uri_options &&
      mongodb_username == o.mongodb_username &&
      name == o.name &&
      new_name == o.new_name &&
      password_length == o.password_length &&
      producer_encryption_key_name == o.producer_encryption_key_name &&
      secure_access_bastion_issuer == o.secure_access_bastion_issuer &&
      secure_access_enable == o.secure_access_enable &&
      secure_access_host == o.secure_access_host &&
      secure_access_web == o.secure_access_web &&
      tags == o.tags &&
      target_name == o.target_name &&
      token == o.token &&
      uid_token == o.uid_token &&
      user_ttl == o.user_ttl
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



489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 489

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


381
382
383
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 381

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



387
388
389
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 387

def hash
  [delete_protection, description, json, mongodb_atlas_api_private_key, mongodb_atlas_api_public_key, mongodb_atlas_project_id, mongodb_custom_data, mongodb_default_auth_db, mongodb_host_port, mongodb_name, mongodb_password, mongodb_roles, mongodb_server_uri, mongodb_uri_options, mongodb_username, name, new_name, password_length, producer_encryption_key_name, secure_access_bastion_issuer, secure_access_enable, secure_access_host, secure_access_web, tags, target_name, token, uid_token, 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



326
327
328
329
330
331
332
333
334
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 326

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



465
466
467
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 465

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



471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 471

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



459
460
461
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 459

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



338
339
340
341
342
 
# File 'lib/akeyless/models/dynamic_secret_update_mongo_db.rb', line 338

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