Class: Akeyless::UpdateDBTargetDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDBTargetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

Instance Attribute Details

#db_typeObject

Returns the value of attribute db_type.



18
19
20
# File 'lib/akeyless/models/update_db_target_details.rb', line 18

def db_type
  @db_type
end

#host_nameObject

Returns the value of attribute host_name.



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

def host_name
  @host_name
end

#jsonObject

Set output format to JSON



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

def json
  @json
end

#keep_prev_versionObject

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



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

def keep_prev_version
  @keep_prev_version
end

#mongo_db_nameObject

Returns the value of attribute mongo_db_name.



28
29
30
# File 'lib/akeyless/models/update_db_target_details.rb', line 28

def mongo_db_name
  @mongo_db_name
end

#mongo_uriObject

Returns the value of attribute mongo_uri.



30
31
32
# File 'lib/akeyless/models/update_db_target_details.rb', line 30

def mongo_uri
  @mongo_uri
end

#nameObject

Target name



33
34
35
# File 'lib/akeyless/models/update_db_target_details.rb', line 33

def name
  @name
end

#new_versionObject

Deprecated



36
37
38
# File 'lib/akeyless/models/update_db_target_details.rb', line 36

def new_version
  @new_version
end

#portObject

Returns the value of attribute port.



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

def port
  @port
end

#protection_keyObject

The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)



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

def protection_key
  @protection_key
end

#pwdObject

Returns the value of attribute pwd.



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

def pwd
  @pwd
end

#tokenObject

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



46
47
48
# File 'lib/akeyless/models/update_db_target_details.rb', line 46

def token
  @token
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



49
50
51
# File 'lib/akeyless/models/update_db_target_details.rb', line 49

def uid_token
  @uid_token
end

#user_nameObject

Returns the value of attribute user_name.



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

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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/akeyless/models/update_db_target_details.rb', line 54

def self.attribute_map
  {
    :'db_type' => :'db_type',
    :'host_name' => :'host_name',
    :'json' => :'json',
    :'keep_prev_version' => :'keep-prev-version',
    :'mongo_db_name' => :'mongo_db_name',
    :'mongo_uri' => :'mongo_uri',
    :'name' => :'name',
    :'new_version' => :'new-version',
    :'port' => :'port',
    :'protection_key' => :'protection_key',
    :'pwd' => :'pwd',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/akeyless/models/update_db_target_details.rb', line 236

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



99
100
101
102
# File 'lib/akeyless/models/update_db_target_details.rb', line 99

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

.openapi_typesObject

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/akeyless/models/update_db_target_details.rb', line 79

def self.openapi_types
  {
    :'db_type' => :'String',
    :'host_name' => :'String',
    :'json' => :'Boolean',
    :'keep_prev_version' => :'String',
    :'mongo_db_name' => :'String',
    :'mongo_uri' => :'String',
    :'name' => :'String',
    :'new_version' => :'Boolean',
    :'port' => :'String',
    :'protection_key' => :'String',
    :'pwd' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'user_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/akeyless/models/update_db_target_details.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      db_type == o.db_type &&
      host_name == o.host_name &&
      json == o.json &&
      keep_prev_version == o.keep_prev_version &&
      mongo_db_name == o.mongo_db_name &&
      mongo_uri == o.mongo_uri &&
      name == o.name &&
      new_version == o.new_version &&
      port == o.port &&
      protection_key == o.protection_key &&
      pwd == o.pwd &&
      token == o.token &&
      uid_token == o.uid_token &&
      user_name == o.user_name
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



331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/akeyless/models/update_db_target_details.rb', line 331

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


223
224
225
# File 'lib/akeyless/models/update_db_target_details.rb', line 223

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



229
230
231
# File 'lib/akeyless/models/update_db_target_details.rb', line 229

def hash
  [db_type, host_name, json, keep_prev_version, mongo_db_name, mongo_uri, name, new_version, port, protection_key, pwd, token, uid_token, user_name].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



182
183
184
185
186
187
188
189
190
# File 'lib/akeyless/models/update_db_target_details.rb', line 182

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



307
308
309
# File 'lib/akeyless/models/update_db_target_details.rb', line 307

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



313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/akeyless/models/update_db_target_details.rb', line 313

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



301
302
303
# File 'lib/akeyless/models/update_db_target_details.rb', line 301

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



194
195
196
197
198
# File 'lib/akeyless/models/update_db_target_details.rb', line 194

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