Class: Akeyless::GatewayCreateProducerHanaDb

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

Overview

gatewayCreateProducerHanaDb is a command that creates hanadb producer [Deprecated: Use dynamic-secret-create-hanadb command]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayCreateProducerHanaDb

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  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_db_schema')
    self.secure_access_db_schema = attributes[:'secure_access_db_schema']
  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_protectionObject

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



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

def delete_protection
  @delete_protection
end

#hana_dbnameObject

HanaDb Name



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

def hana_dbname
  @hana_dbname
end

#hanadb_create_statementsObject

HanaDb Creation statements



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

def hanadb_create_statements
  @hanadb_create_statements
end

#hanadb_hostObject

HanaDb Host



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

def hanadb_host
  @hanadb_host
end

#hanadb_passwordObject

HanaDb Password



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

def hanadb_password
  @hanadb_password
end

#hanadb_portObject

HanaDb Port



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

def hanadb_port
  @hanadb_port
end

#hanadb_revocation_statementsObject

HanaDb Revocation statements



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

def hanadb_revocation_statements
  @hanadb_revocation_statements
end

#hanadb_usernameObject

HanaDb Username



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

def hanadb_username
  @hanadb_username
end

#jsonObject

Set output format to JSON



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

def json
  @json
end

#nameObject

Dynamic secret name



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

def name
  @name
end

#password_lengthObject

The length of the password to be generated



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

def password_length
  @password_length
end

#producer_encryption_key_nameObject

Dynamic producer encryption key



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

def producer_encryption_key_name
  @producer_encryption_key_name
end

#secure_access_bastion_issuerObject

Path to the SSH Certificate Issuer for your Akeyless Bastion



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

def secure_access_bastion_issuer
  @secure_access_bastion_issuer
end

#secure_access_db_schemaObject

The DB schema



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

def secure_access_db_schema
  @secure_access_db_schema
end

#secure_access_enableObject

Enable/Disable secure remote access [true/false]



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

def secure_access_enable
  @secure_access_enable
end

#secure_access_hostObject

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



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

def secure_access_host
  @secure_access_host
end

#secure_access_webObject

Enable Web Secure Remote Access



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

def secure_access_web
  @secure_access_web
end

#tagsObject

Add tags attached to this object



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

def tags
  @tags
end

#target_nameObject

Target name



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

def target_name
  @target_name
end

#tokenObject

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



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

def token
  @token
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
end

#user_ttlObject

User TTL



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

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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 360

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_attributesObject

Returns all the JSON keys this model knows about



114
115
116
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 114

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 86

def self.attribute_map
  {
    :'delete_protection' => :'delete_protection',
    :'hana_dbname' => :'hana-dbname',
    :'hanadb_create_statements' => :'hanadb-create-statements',
    :'hanadb_host' => :'hanadb-host',
    :'hanadb_password' => :'hanadb-password',
    :'hanadb_port' => :'hanadb-port',
    :'hanadb_revocation_statements' => :'hanadb-revocation-statements',
    :'hanadb_username' => :'hanadb-username',
    :'json' => :'json',
    :'name' => :'name',
    :'password_length' => :'password-length',
    :'producer_encryption_key_name' => :'producer-encryption-key-name',
    :'secure_access_bastion_issuer' => :'secure-access-bastion-issuer',
    :'secure_access_db_schema' => :'secure-access-db-schema',
    :'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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 336

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_nullableObject

List of attributes with nullable: true



147
148
149
150
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 147

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'delete_protection' => :'String',
    :'hana_dbname' => :'String',
    :'hanadb_create_statements' => :'String',
    :'hanadb_host' => :'String',
    :'hanadb_password' => :'String',
    :'hanadb_port' => :'String',
    :'hanadb_revocation_statements' => :'String',
    :'hanadb_username' => :'String',
    :'json' => :'Boolean',
    :'name' => :'String',
    :'password_length' => :'String',
    :'producer_encryption_key_name' => :'String',
    :'secure_access_bastion_issuer' => :'String',
    :'secure_access_db_schema' => :'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



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      delete_protection == o.delete_protection &&
      hana_dbname == o.hana_dbname &&
      hanadb_create_statements == o.hanadb_create_statements &&
      hanadb_host == o.hanadb_host &&
      hanadb_password == o.hanadb_password &&
      hanadb_port == o.hanadb_port &&
      hanadb_revocation_statements == o.hanadb_revocation_statements &&
      hanadb_username == o.hanadb_username &&
      json == o.json &&
      name == o.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_db_schema == o.secure_access_db_schema &&
      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



431
432
433
434
435
436
437
438
439
440
441
442
443
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 431

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


323
324
325
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 323

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



329
330
331
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 329

def hash
  [delete_protection, hana_dbname, hanadb_create_statements, hanadb_host, hanadb_password, hanadb_port, hanadb_revocation_statements, hanadb_username, json, name, password_length, producer_encryption_key_name, secure_access_bastion_issuer, secure_access_db_schema, secure_access_enable, secure_access_host, secure_access_web, tags, target_name, token, uid_token, user_ttl].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



274
275
276
277
278
279
280
281
282
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 274

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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



407
408
409
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 407

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



413
414
415
416
417
418
419
420
421
422
423
424
425
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 413

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



401
402
403
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 401

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



286
287
288
289
290
# File 'lib/akeyless/models/gateway_create_producer_hana_db.rb', line 286

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