Class: Akeyless::UpdateSecretVal

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSecretVal

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'inject_url')
    if (value = attributes[:'inject_url']).is_a?(Array)
      self.inject_url = value
    end
  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?(:'last_version')
    self.last_version = attributes[:'last_version']
  end

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

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

Instance Attribute Details

#accessibility ⇒ Object

for personal password manager



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

def accessibility
  @accessibility
end

#custom_field ⇒ Object

For Password Management use, additional fields



22
23
24
 
# File 'lib/akeyless/models/update_secret_val.rb', line 22

def custom_field
  @custom_field
end

#format ⇒ Object

Secret format [text/json/key-value] (relevant only for type ‘generic’)



25
26
27
 
# File 'lib/akeyless/models/update_secret_val.rb', line 25

def format
  @format
end

#inject_url ⇒ Object

For Password Management use, reflect the website context



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

def inject_url
  @inject_url
end

#json ⇒ Object

Set output format to JSON



31
32
33
 
# File 'lib/akeyless/models/update_secret_val.rb', line 31

def json
  @json
end

#keep_prev_version ⇒ Object

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



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

def keep_prev_version
  @keep_prev_version
end

#key ⇒ Object

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



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

def key
  @key
end

#last_version ⇒ Object

The last version number before the update



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

def last_version
  @last_version
end

#multiline ⇒ Object

The provided value is a multiline value (separated by ‘\n’)



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

def multiline
  @multiline
end

#name ⇒ Object

Secret name



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

def name
  @name
end

#new_version ⇒ Object

Deprecated



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

def new_version
  @new_version
end

#password ⇒ Object

For Password Management use, additional fields



52
53
54
 
# File 'lib/akeyless/models/update_secret_val.rb', line 52

def password
  @password
end

#token ⇒ Object

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



55
56
57
 
# File 'lib/akeyless/models/update_secret_val.rb', line 55

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



58
59
60
 
# File 'lib/akeyless/models/update_secret_val.rb', line 58

def uid_token
  @uid_token
end

#username ⇒ Object

For Password Management use



61
62
63
 
# File 'lib/akeyless/models/update_secret_val.rb', line 61

def username
  @username
end

#value ⇒ Object

The secret value (relevant only for type ‘generic’)



64
65
66
 
# File 'lib/akeyless/models/update_secret_val.rb', line 64

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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/akeyless/models/update_secret_val.rb', line 302

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/akeyless/models/update_secret_val.rb', line 67

def self.attribute_map
  {
    :'accessibility' => :'accessibility',
    :'custom_field' => :'custom-field',
    :'format' => :'format',
    :'inject_url' => :'inject-url',
    :'json' => :'json',
    :'keep_prev_version' => :'keep-prev-version',
    :'key' => :'key',
    :'last_version' => :'last-version',
    :'multiline' => :'multiline',
    :'name' => :'name',
    :'new_version' => :'new-version',
    :'password' => :'password',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'username' => :'username',
    :'value' => :'value'
  }
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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/akeyless/models/update_secret_val.rb', line 278

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



116
117
118
119
 
# File 'lib/akeyless/models/update_secret_val.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/akeyless/models/update_secret_val.rb', line 94

def self.openapi_types
  {
    :'accessibility' => :'String',
    :'custom_field' => :'Hash<String, String>',
    :'format' => :'String',
    :'inject_url' => :'Array<String>',
    :'json' => :'Boolean',
    :'keep_prev_version' => :'String',
    :'key' => :'String',
    :'last_version' => :'Integer',
    :'multiline' => :'Boolean',
    :'name' => :'String',
    :'new_version' => :'Boolean',
    :'password' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'username' => :'String',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/akeyless/models/update_secret_val.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accessibility == o.accessibility &&
      custom_field == o.custom_field &&
      format == o.format &&
      inject_url == o.inject_url &&
      json == o.json &&
      keep_prev_version == o.keep_prev_version &&
      key == o.key &&
      last_version == o.last_version &&
      multiline == o.multiline &&
      name == o.name &&
      new_version == o.new_version &&
      password == o.password &&
      token == o.token &&
      uid_token == o.uid_token &&
      username == o.username &&
      value == o.value
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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/akeyless/models/update_secret_val.rb', line 373

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


265
266
267
 
# File 'lib/akeyless/models/update_secret_val.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



271
272
273
 
# File 'lib/akeyless/models/update_secret_val.rb', line 271

def hash
  [accessibility, custom_field, format, inject_url, json, keep_prev_version, key, last_version, multiline, name, new_version, password, token, uid_token, username, value].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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/akeyless/models/update_secret_val.rb', line 217

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

  if @value.nil?
    invalid_properties.push('invalid value for "value", value 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



349
350
351
 
# File 'lib/akeyless/models/update_secret_val.rb', line 349

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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/akeyless/models/update_secret_val.rb', line 355

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



343
344
345
 
# File 'lib/akeyless/models/update_secret_val.rb', line 343

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



233
234
235
236
237
238
 
# File 'lib/akeyless/models/update_secret_val.rb', line 233

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