Class: Akeyless::DynamicSecretUpdateMsSql

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

Overview

dynamicSecretUpdateMsSql is a command that updates mssql dynamic secret

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DynamicSecretUpdateMsSql

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

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

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

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

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

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

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

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

  if attributes.key?(:'mssql_username')
    self.mssql_username = attributes[:'mssql_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_certificate_issuer')
    self.secure_access_certificate_issuer = attributes[:'secure_access_certificate_issuer']
  end

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

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

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

#custom_username_template ⇒ Object

Customize how temporary usernames are generated using go template



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

def custom_username_template
  @custom_username_template
end

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#mssql_create_statements ⇒ Object

MSSQL Creation statements



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

def mssql_create_statements
  @mssql_create_statements
end

#mssql_dbname ⇒ Object

MSSQL Name



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

def mssql_dbname
  @mssql_dbname
end

#mssql_host ⇒ Object

MSSQL Host



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

def mssql_host
  @mssql_host
end

#mssql_password ⇒ Object

MSSQL Password



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

def mssql_password
  @mssql_password
end

#mssql_port ⇒ Object

MSSQL Port



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

def mssql_port
  @mssql_port
end

#mssql_revocation_statements ⇒ Object

MSSQL Revocation statements



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

def mssql_revocation_statements
  @mssql_revocation_statements
end

#mssql_username ⇒ Object

MSSQL Username



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

def mssql_username
  @mssql_username
end

#name ⇒ Object

Dynamic secret name



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

def name
  @name
end

#new_name ⇒ Object

Dynamic secret name



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

def new_name
  @new_name
end

#password_length ⇒ Object

The length of the password to be generated



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

def password_length
  @password_length
end

#producer_encryption_key_name ⇒ Object

Dynamic producer encryption key



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

def producer_encryption_key_name
  @producer_encryption_key_name
end

#secure_access_bastion_issuer ⇒ Object

Deprecated. use secure-access-certificate-issuer



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

def secure_access_bastion_issuer
  @secure_access_bastion_issuer
end

#secure_access_certificate_issuer ⇒ Object

Path to the SSH Certificate Issuer for your Akeyless Secure Access



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

def secure_access_certificate_issuer
  @secure_access_certificate_issuer
end

#secure_access_db_name ⇒ Object

The DB name (relevant only for DB Dynamic-Secret)



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

def secure_access_db_name
  @secure_access_db_name
end

#secure_access_db_schema ⇒ Object

The DB schema



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

def secure_access_db_schema
  @secure_access_db_schema
end

#secure_access_delay ⇒ Object

The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds



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

def secure_access_delay
  @secure_access_delay
end

#secure_access_enable ⇒ Object

Enable/Disable secure remote access [true/false]



80
81
82
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.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_ms_sql.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_ms_sql.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_ms_sql.rb', line 89

def tags
  @tags
end

#target_name ⇒ Object

Target name



92
93
94
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.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_ms_sql.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_ms_sql.rb', line 98

def uid_token
  @uid_token
end

#user_ttl ⇒ Object

User TTL



101
102
103
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.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



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
456
457
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.rb', line 420

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_ms_sql.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_ms_sql.rb', line 104

def self.attribute_map
  {
    :'custom_username_template' => :'custom-username-template',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'json' => :'json',
    :'mssql_create_statements' => :'mssql-create-statements',
    :'mssql_dbname' => :'mssql-dbname',
    :'mssql_host' => :'mssql-host',
    :'mssql_password' => :'mssql-password',
    :'mssql_port' => :'mssql-port',
    :'mssql_revocation_statements' => :'mssql-revocation-statements',
    :'mssql_username' => :'mssql-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_certificate_issuer' => :'secure-access-certificate-issuer',
    :'secure_access_db_name' => :'secure-access-db-name',
    :'secure_access_db_schema' => :'secure-access-db-schema',
    :'secure_access_delay' => :'secure-access-delay',
    :'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



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

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_ms_sql.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_ms_sql.rb', line 143

def self.openapi_types
  {
    :'custom_username_template' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'json' => :'Boolean',
    :'mssql_create_statements' => :'String',
    :'mssql_dbname' => :'String',
    :'mssql_host' => :'String',
    :'mssql_password' => :'String',
    :'mssql_port' => :'String',
    :'mssql_revocation_statements' => :'String',
    :'mssql_username' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'password_length' => :'String',
    :'producer_encryption_key_name' => :'String',
    :'secure_access_bastion_issuer' => :'String',
    :'secure_access_certificate_issuer' => :'String',
    :'secure_access_db_name' => :'String',
    :'secure_access_db_schema' => :'String',
    :'secure_access_delay' => :'Integer',
    :'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



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      custom_username_template == o.custom_username_template &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      json == o.json &&
      mssql_create_statements == o.mssql_create_statements &&
      mssql_dbname == o.mssql_dbname &&
      mssql_host == o.mssql_host &&
      mssql_password == o.mssql_password &&
      mssql_port == o.mssql_port &&
      mssql_revocation_statements == o.mssql_revocation_statements &&
      mssql_username == o.mssql_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_certificate_issuer == o.secure_access_certificate_issuer &&
      secure_access_db_name == o.secure_access_db_name &&
      secure_access_db_schema == o.secure_access_db_schema &&
      secure_access_delay == o.secure_access_delay &&
      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



491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.rb', line 491

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


383
384
385
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.rb', line 383

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



389
390
391
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.rb', line 389

def hash
  [custom_username_template, delete_protection, description, json, mssql_create_statements, mssql_dbname, mssql_host, mssql_password, mssql_port, mssql_revocation_statements, mssql_username, name, new_name, password_length, producer_encryption_key_name, secure_access_bastion_issuer, secure_access_certificate_issuer, secure_access_db_name, secure_access_db_schema, secure_access_delay, 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



328
329
330
331
332
333
334
335
336
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.rb', line 328

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



467
468
469
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.rb', line 467

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



473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.rb', line 473

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



461
462
463
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.rb', line 461

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



340
341
342
343
344
 
# File 'lib/akeyless/models/dynamic_secret_update_ms_sql.rb', line 340

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