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



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
179
180
181
182
183
184
185
186
 
# File 'lib/akeyless/models/update_secret_val.rb', line 112

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

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

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

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

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

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

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

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#keep_prev_version ⇒ Object

Returns the value of attribute keep_prev_version.



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

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)



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

def key
  @key
end

#multiline ⇒ Object

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



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

def multiline
  @multiline
end

#name ⇒ Object

Secret name



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

def name
  @name
end

#new_version ⇒ Object

Deprecated



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

def new_version
  @new_version
end

#password_manager_custom_field ⇒ Object

For Password Management use, additional fields



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

def password_manager_custom_field
  @password_manager_custom_field
end

#password_manager_inject_url ⇒ Object

For Password Management use, reflect the website context



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

def password_manager_inject_url
  @password_manager_inject_url
end

#password_manager_password ⇒ Object

For Password Management use, additional fields



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

def password_manager_password
  @password_manager_password
end

#password_manager_username ⇒ Object

For Password Management use



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

def password_manager_username
  @password_manager_username
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
end

#value ⇒ Object

The new secret value



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

def value
  @value
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/akeyless/models/update_secret_val.rb', line 60

def self.attribute_map
  {
    :'accessibility' => :'accessibility',
    :'json' => :'json',
    :'keep_prev_version' => :'keep-prev-version',
    :'key' => :'key',
    :'multiline' => :'multiline',
    :'name' => :'name',
    :'new_version' => :'new-version',
    :'password_manager_custom_field' => :'password-manager-custom-field',
    :'password_manager_inject_url' => :'password-manager-inject-url',
    :'password_manager_password' => :'password-manager-password',
    :'password_manager_username' => :'password-manager-username',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'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



247
248
249
 
# File 'lib/akeyless/models/update_secret_val.rb', line 247

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
 
# File 'lib/akeyless/models/update_secret_val.rb', line 105

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/akeyless/models/update_secret_val.rb', line 85

def self.openapi_types
  {
    :'accessibility' => :'String',
    :'json' => :'Boolean',
    :'keep_prev_version' => :'String',
    :'key' => :'String',
    :'multiline' => :'Boolean',
    :'name' => :'String',
    :'new_version' => :'Boolean',
    :'password_manager_custom_field' => :'Hash<String, String>',
    :'password_manager_inject_url' => :'Array<String>',
    :'password_manager_password' => :'String',
    :'password_manager_username' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accessibility == o.accessibility &&
      json == o.json &&
      keep_prev_version == o.keep_prev_version &&
      key == o.key &&
      multiline == o.multiline &&
      name == o.name &&
      new_version == o.new_version &&
      password_manager_custom_field == o.password_manager_custom_field &&
      password_manager_inject_url == o.password_manager_inject_url &&
      password_manager_password == o.password_manager_password &&
      password_manager_username == o.password_manager_username &&
      token == o.token &&
      uid_token == o.uid_token &&
      value == o.value
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



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

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/akeyless/models/update_secret_val.rb', line 349

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/akeyless/models/update_secret_val.rb', line 254

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/akeyless/models/update_secret_val.rb', line 240

def hash
  [accessibility, json, keep_prev_version, key, multiline, name, new_version, password_manager_custom_field, password_manager_inject_url, password_manager_password, password_manager_username, token, uid_token, 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



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/akeyless/models/update_secret_val.rb', line 190

def list_invalid_properties
  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



325
326
327
 
# File 'lib/akeyless/models/update_secret_val.rb', line 325

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



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

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



319
320
321
 
# File 'lib/akeyless/models/update_secret_val.rb', line 319

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



205
206
207
208
209
 
# File 'lib/akeyless/models/update_secret_val.rb', line 205

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