Class: Akeyless::UpdateDBTarget

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDBTarget

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#comment ⇒ Object

Deprecated - use description



19
20
21
 
# File 'lib/akeyless/models/update_db_target.rb', line 19

def comment
  @comment
end

#db_name ⇒ Object

Returns the value of attribute db_name.



21
22
23
 
# File 'lib/akeyless/models/update_db_target.rb', line 21

def db_name
  @db_name
end

#db_server_certificates ⇒ Object

(Optional) DB server certificates



24
25
26
 
# File 'lib/akeyless/models/update_db_target.rb', line 24

def db_server_certificates
  @db_server_certificates
end

#db_server_name ⇒ Object

(Optional) Server name for certificate verification



27
28
29
 
# File 'lib/akeyless/models/update_db_target.rb', line 27

def db_server_name
  @db_server_name
end

#db_type ⇒ Object

Returns the value of attribute db_type.



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

def db_type
  @db_type
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#host ⇒ Object

Returns the value of attribute host.



34
35
36
 
# File 'lib/akeyless/models/update_db_target.rb', line 34

def host
  @host
end

#json ⇒ Object

Set output format to JSON



37
38
39
 
# File 'lib/akeyless/models/update_db_target.rb', line 37

def json
  @json
end

#keep_prev_version ⇒ Object

Whether to keep previous version [true/false]. If not set, use default according to account settings



40
41
42
 
# File 'lib/akeyless/models/update_db_target.rb', line 40

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



43
44
45
 
# File 'lib/akeyless/models/update_db_target.rb', line 43

def key
  @key
end

#mongodb_atlas ⇒ Object

Returns the value of attribute mongodb_atlas.



45
46
47
 
# File 'lib/akeyless/models/update_db_target.rb', line 45

def mongodb_atlas
  @mongodb_atlas
end

#mongodb_atlas_api_private_key ⇒ Object

MongoDB Atlas private key



48
49
50
 
# File 'lib/akeyless/models/update_db_target.rb', line 48

def mongodb_atlas_api_private_key
  @mongodb_atlas_api_private_key
end

#mongodb_atlas_api_public_key ⇒ Object

MongoDB Atlas public key



51
52
53
 
# File 'lib/akeyless/models/update_db_target.rb', line 51

def mongodb_atlas_api_public_key
  @mongodb_atlas_api_public_key
end

#mongodb_atlas_project_id ⇒ Object

MongoDB Atlas project ID



54
55
56
 
# File 'lib/akeyless/models/update_db_target.rb', line 54

def mongodb_atlas_project_id
  @mongodb_atlas_project_id
end

#mongodb_default_auth_db ⇒ Object

MongoDB server default authentication database



57
58
59
 
# File 'lib/akeyless/models/update_db_target.rb', line 57

def mongodb_default_auth_db
  @mongodb_default_auth_db
end

#mongodb_uri_options ⇒ Object

MongoDB server URI options



60
61
62
 
# File 'lib/akeyless/models/update_db_target.rb', line 60

def mongodb_uri_options
  @mongodb_uri_options
end

#name ⇒ Object

Target name



63
64
65
 
# File 'lib/akeyless/models/update_db_target.rb', line 63

def name
  @name
end

#new_name ⇒ Object

New target name



66
67
68
 
# File 'lib/akeyless/models/update_db_target.rb', line 66

def new_name
  @new_name
end

#oracle_service_name ⇒ Object

Returns the value of attribute oracle_service_name.



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

def oracle_service_name
  @oracle_service_name
end

#port ⇒ Object

Returns the value of attribute port.



70
71
72
 
# File 'lib/akeyless/models/update_db_target.rb', line 70

def port
  @port
end

#pwd ⇒ Object

Returns the value of attribute pwd.



72
73
74
 
# File 'lib/akeyless/models/update_db_target.rb', line 72

def pwd
  @pwd
end

#snowflake_account ⇒ Object

Returns the value of attribute snowflake_account.



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

def 
  @snowflake_account
end

#snowflake_api_private_key ⇒ Object

RSA Private key (base64 encoded)



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

def snowflake_api_private_key
  @snowflake_api_private_key
end

#snowflake_api_private_key_password ⇒ Object

The Private key passphrase



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

def snowflake_api_private_key_password
  @snowflake_api_private_key_password
end

#ssl ⇒ Object

Enable/Disable SSL [true/false]



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

def ssl
  @ssl
end

#ssl_certificate ⇒ Object

SSL connection certificate



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

def ssl_certificate
  @ssl_certificate
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
end

#update_version ⇒ Object

Deprecated



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

def update_version
  @update_version
end

#user_name ⇒ Object

Returns the value of attribute user_name.



97
98
99
 
# File 'lib/akeyless/models/update_db_target.rb', line 97

def user_name
  @user_name
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



136
137
138
 
# File 'lib/akeyless/models/update_db_target.rb', line 136

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



100
101
102
103
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
 
# File 'lib/akeyless/models/update_db_target.rb', line 100

def self.attribute_map
  {
    :'comment' => :'comment',
    :'db_name' => :'db-name',
    :'db_server_certificates' => :'db-server-certificates',
    :'db_server_name' => :'db-server-name',
    :'db_type' => :'db-type',
    :'description' => :'description',
    :'host' => :'host',
    :'json' => :'json',
    :'keep_prev_version' => :'keep-prev-version',
    :'key' => :'key',
    :'mongodb_atlas' => :'mongodb-atlas',
    :'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_default_auth_db' => :'mongodb-default-auth-db',
    :'mongodb_uri_options' => :'mongodb-uri-options',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'oracle_service_name' => :'oracle-service-name',
    :'port' => :'port',
    :'pwd' => :'pwd',
    :'snowflake_account' => :'snowflake-account',
    :'snowflake_api_private_key' => :'snowflake-api-private-key',
    :'snowflake_api_private_key_password' => :'snowflake-api-private-key-password',
    :'ssl' => :'ssl',
    :'ssl_certificate' => :'ssl-certificate',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'update_version' => :'update-version',
    :'user_name' => :'user-name'
  }
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



397
398
399
 
# File 'lib/akeyless/models/update_db_target.rb', line 397

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'comment' => :'String',
    :'db_name' => :'String',
    :'db_server_certificates' => :'String',
    :'db_server_name' => :'String',
    :'db_type' => :'String',
    :'description' => :'String',
    :'host' => :'String',
    :'json' => :'Boolean',
    :'keep_prev_version' => :'String',
    :'key' => :'String',
    :'mongodb_atlas' => :'Boolean',
    :'mongodb_atlas_api_private_key' => :'String',
    :'mongodb_atlas_api_public_key' => :'String',
    :'mongodb_atlas_project_id' => :'String',
    :'mongodb_default_auth_db' => :'String',
    :'mongodb_uri_options' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'oracle_service_name' => :'String',
    :'port' => :'String',
    :'pwd' => :'String',
    :'snowflake_account' => :'String',
    :'snowflake_api_private_key' => :'String',
    :'snowflake_api_private_key_password' => :'String',
    :'ssl' => :'Boolean',
    :'ssl_certificate' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'update_version' => :'Boolean',
    :'user_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
378
379
380
 
# File 'lib/akeyless/models/update_db_target.rb', line 347

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      comment == o.comment &&
      db_name == o.db_name &&
      db_server_certificates == o.db_server_certificates &&
      db_server_name == o.db_server_name &&
      db_type == o.db_type &&
      description == o.description &&
      host == o.host &&
      json == o.json &&
      keep_prev_version == o.keep_prev_version &&
      key == o.key &&
      mongodb_atlas == o.mongodb_atlas &&
      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_default_auth_db == o.mongodb_default_auth_db &&
      mongodb_uri_options == o.mongodb_uri_options &&
      name == o.name &&
      new_name == o.new_name &&
      oracle_service_name == o.oracle_service_name &&
      port == o.port &&
      pwd == o.pwd &&
       == o. &&
      snowflake_api_private_key == o.snowflake_api_private_key &&
      snowflake_api_private_key_password == o.snowflake_api_private_key_password &&
      ssl == o.ssl &&
      ssl_certificate == o.ssl_certificate &&
      token == o.token &&
      uid_token == o.uid_token &&
      update_version == o.update_version &&
      user_name == o.user_name
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



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
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/akeyless/models/update_db_target.rb', line 428

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



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/akeyless/models/update_db_target.rb', line 499

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



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/akeyless/models/update_db_target.rb', line 404

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


384
385
386
 
# File 'lib/akeyless/models/update_db_target.rb', line 384

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



390
391
392
 
# File 'lib/akeyless/models/update_db_target.rb', line 390

def hash
  [comment, db_name, db_server_certificates, db_server_name, db_type, description, host, json, keep_prev_version, key, mongodb_atlas, mongodb_atlas_api_private_key, mongodb_atlas_api_public_key, mongodb_atlas_project_id, mongodb_default_auth_db, mongodb_uri_options, name, new_name, oracle_service_name, port, pwd, , snowflake_api_private_key, snowflake_api_private_key_password, ssl, ssl_certificate, token, uid_token, update_version, user_name].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @db_type.nil?
    invalid_properties.push('invalid value for "db_type", db_type 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



475
476
477
 
# File 'lib/akeyless/models/update_db_target.rb', line 475

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



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/akeyless/models/update_db_target.rb', line 481

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



469
470
471
 
# File 'lib/akeyless/models/update_db_target.rb', line 469

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



339
340
341
342
343
 
# File 'lib/akeyless/models/update_db_target.rb', line 339

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