Class: Akeyless::GatewayUpdateItem

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

Overview

gatewayUpdateItem is a command that updates classic key

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayUpdateItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 194

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

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

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

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

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

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

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

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  else
    self.description = 'default_metadata'
  end

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

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

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

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

  if attributes.key?(:'new_metadata')
    self.new_metadata = attributes[:'new_metadata']
  else
    self.new_metadata = 'default_metadata'
  end

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

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

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

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

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

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

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

  if attributes.key?(:'rotation_hour')
    self.rotation_hour = attributes[:'rotation_hour']
  else
    self.rotation_hour = 0
  end

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

  if attributes.key?(:'rotator_creds_type')
    self.rotator_creds_type = attributes[:'rotator_creds_type']
  else
    self.rotator_creds_type = 'use-self-creds'
  end

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

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

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

Instance Attribute Details

#add_tag ⇒ Object

List of the new tags that will be attached to this item



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

def add_tag
  @add_tag
end

#api_id ⇒ Object

API ID to rotate (relevant only for rotator-type=api-key)



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

def api_id
  @api_id
end

#api_key ⇒ Object

API key to rotate (relevant only for rotator-type=api-key)



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

def api_key
  @api_key
end

#app_id ⇒ Object

ApplicationId (used in azure)



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

def app_id
  @app_id
end

#auto_rotate ⇒ Object

Whether to automatically rotate every –rotation-interval days, or disable existing automatic rotation [true/false]



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

def auto_rotate
  @auto_rotate
end

#custom_payload ⇒ Object

Secret payload to be sent with rotation request (relevant only for rotator-type=custom)



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

def custom_payload
  @custom_payload
end

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#gcp_key ⇒ Object

Base64-encoded service account private key text



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

def gcp_key
  @gcp_key
end

#gcp_service_account_email ⇒ Object

The email of the gcp service account to rotate



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

def 
  @gcp_service_account_email
end

#gcp_service_account_key_id ⇒ Object

The key id of the gcp service account to rotate



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

def 
  @gcp_service_account_key_id
end

#grace_rotation ⇒ Object

Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]



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

def grace_rotation
  @grace_rotation
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#keep_prev_version ⇒ Object

Whether to keep previous version [true/false]. (relevant only for –type=rotated-secret). If not set, use default according to account settings



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

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)



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

def key
  @key
end

#name ⇒ Object

Item name



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

def name
  @name
end

#new_metadata ⇒ Object

Deprecated - use description



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

def new_metadata
  @new_metadata
end

#new_name ⇒ Object

New item name



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

def new_name
  @new_name
end

#new_version ⇒ Object

Deprecated



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

def new_version
  @new_version
end

#password_length ⇒ Object

The length of the password to be generated



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

def password_length
  @password_length
end

#rm_tag ⇒ Object

List of the existent tags that will be removed from this item



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

def rm_tag
  @rm_tag
end

#rotated_password ⇒ Object

rotated-username password (relevant only for rotator-type=password)



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

def rotated_password
  @rotated_password
end

#rotated_username ⇒ Object

username to be rotated, if selected \"use-self-creds\" at rotator-creds-type, this username will try to rotate it’s own password, if \"use-target-creds\" is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)



86
87
88
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 86

def rotated_username
  @rotated_username
end

#rotation_event_in ⇒ Object

How many days before the rotation of the item would you like to be notified



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

def rotation_event_in
  @rotation_event_in
end

#rotation_hour ⇒ Object

The Rotation Hour



92
93
94
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 92

def rotation_hour
  @rotation_hour
end

#rotation_interval ⇒ Object

The number of days to wait between every automatic key rotation (1-365)



95
96
97
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 95

def rotation_interval
  @rotation_interval
end

#rotator_creds_type ⇒ Object

The rotation credentials type



98
99
100
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 98

def rotator_creds_type
  @rotator_creds_type
end

#token ⇒ Object

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



101
102
103
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 101

def token
  @token
end

#type ⇒ Object

Item type



104
105
106
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 104

def type
  @type
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



107
108
109
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 107

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



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 449

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



146
147
148
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 146

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'add_tag' => :'add-tag',
    :'api_id' => :'api-id',
    :'api_key' => :'api-key',
    :'app_id' => :'app-id',
    :'auto_rotate' => :'auto-rotate',
    :'custom_payload' => :'custom-payload',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'gcp_key' => :'gcp-key',
    :'gcp_service_account_email' => :'gcp-service-account-email',
    :'gcp_service_account_key_id' => :'gcp-service-account-key-id',
    :'grace_rotation' => :'grace-rotation',
    :'json' => :'json',
    :'keep_prev_version' => :'keep-prev-version',
    :'key' => :'key',
    :'name' => :'name',
    :'new_metadata' => :'new-metadata',
    :'new_name' => :'new-name',
    :'new_version' => :'new-version',
    :'password_length' => :'password-length',
    :'rm_tag' => :'rm-tag',
    :'rotated_password' => :'rotated-password',
    :'rotated_username' => :'rotated-username',
    :'rotation_event_in' => :'rotation-event-in',
    :'rotation_hour' => :'rotation-hour',
    :'rotation_interval' => :'rotation-interval',
    :'rotator_creds_type' => :'rotator-creds-type',
    :'token' => :'token',
    :'type' => :'type',
    :'uid_token' => :'uid-token'
  }
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



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 425

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



187
188
189
190
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 187

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'add_tag' => :'Array<String>',
    :'api_id' => :'String',
    :'api_key' => :'String',
    :'app_id' => :'String',
    :'auto_rotate' => :'String',
    :'custom_payload' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'gcp_key' => :'String',
    :'gcp_service_account_email' => :'String',
    :'gcp_service_account_key_id' => :'String',
    :'grace_rotation' => :'String',
    :'json' => :'Boolean',
    :'keep_prev_version' => :'String',
    :'key' => :'String',
    :'name' => :'String',
    :'new_metadata' => :'String',
    :'new_name' => :'String',
    :'new_version' => :'Boolean',
    :'password_length' => :'String',
    :'rm_tag' => :'Array<String>',
    :'rotated_password' => :'String',
    :'rotated_username' => :'String',
    :'rotation_event_in' => :'Array<String>',
    :'rotation_hour' => :'Integer',
    :'rotation_interval' => :'String',
    :'rotator_creds_type' => :'String',
    :'token' => :'String',
    :'type' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 375

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      add_tag == o.add_tag &&
      api_id == o.api_id &&
      api_key == o.api_key &&
      app_id == o.app_id &&
      auto_rotate == o.auto_rotate &&
      custom_payload == o.custom_payload &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      gcp_key == o.gcp_key &&
       == o. &&
       == o. &&
      grace_rotation == o.grace_rotation &&
      json == o.json &&
      keep_prev_version == o.keep_prev_version &&
      key == o.key &&
      name == o.name &&
      new_metadata == o.new_metadata &&
      new_name == o.new_name &&
      new_version == o.new_version &&
      password_length == o.password_length &&
      rm_tag == o.rm_tag &&
      rotated_password == o.rotated_password &&
      rotated_username == o.rotated_username &&
      rotation_event_in == o.rotation_event_in &&
      rotation_hour == o.rotation_hour &&
      rotation_interval == o.rotation_interval &&
      rotator_creds_type == o.rotator_creds_type &&
      token == o.token &&
      type == o.type &&
      uid_token == o.uid_token
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



520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 520

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


412
413
414
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 412

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



418
419
420
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 418

def hash
  [add_tag, api_id, api_key, app_id, auto_rotate, custom_payload, delete_protection, description, gcp_key, , , grace_rotation, json, keep_prev_version, key, name, new_metadata, new_name, new_version, password_length, rm_tag, rotated_password, rotated_username, rotation_event_in, rotation_hour, rotation_interval, rotator_creds_type, token, type, uid_token].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



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

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



496
497
498
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 496

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



502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 502

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



490
491
492
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 490

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



366
367
368
369
370
371
 
# File 'lib/akeyless/models/gateway_update_item.rb', line 366

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