Class: Akeyless::UpdateItem

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
347
348
349
350
351
352
353
354
355
356
357
358
359
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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
# File 'lib/akeyless/models/update_item.rb', line 285

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

  if attributes.key?(:'accessibility')
    self.accessibility = attributes[:'accessibility']
  else
    self.accessibility = 'regular'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'secure_access_db_name')
    self.secure_access_db_name = attributes[:'secure_access_db_name']
  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_gateway')
    self.secure_access_gateway = attributes[:'secure_access_gateway']
  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_rd_gateway_server')
    self.secure_access_rd_gateway_server = attributes[:'secure_access_rd_gateway_server']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accessibilityObject

for personal password manager



21
22
23
# File 'lib/akeyless/models/update_item.rb', line 21

def accessibility
  @accessibility
end

#add_tagObject

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



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

def add_tag
  @add_tag
end

#cert_file_dataObject

PEM Certificate in a Base64 format. Used for updating RSA keys’ certificates.



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

def cert_file_data
  @cert_file_data
end

#certificate_formatObject

Returns the value of attribute certificate_format.



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

def certificate_format
  @certificate_format
end

#change_eventObject

Trigger an event when a secret value changed [true/false] (Relevant only for Static Secret)



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

def change_event
  @change_event
end

#delete_protectionObject

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



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

def delete_protection
  @delete_protection
end

#descriptionObject

Description of the object



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

def description
  @description
end

#expiration_event_inObject

How many days before the expiration of the certificate would you like to be notified.



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

def expiration_event_in
  @expiration_event_in
end

#host_providerObject

Host provider type [explicit/target], Default Host provider is explicit, Relevant only for Secure Remote Access of ssh cert issuer, ldap rotated secret and ldap dynamic secret



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

def host_provider
  @host_provider
end

#jsonObject

Set output format to JSON



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

def json
  @json
end

#max_versionsObject

Set the maximum number of versions, limited by the account settings defaults.



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

def max_versions
  @max_versions
end

#nameObject

Current item name



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

def name
  @name
end

#new_metadataObject

Deprecated - use description



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

def 
  @new_metadata
end

#new_nameObject

New item name



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

def new_name
  @new_name
end

#provider_typeObject

Returns the value of attribute provider_type.



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

def provider_type
  @provider_type
end

#rm_tagObject

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



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

def rm_tag
  @rm_tag
end

#rotate_after_disconnectObject

Rotate the value of the secret after SRA session ends [true/false]



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

def rotate_after_disconnect
  @rotate_after_disconnect
end

#secure_access_add_hostObject

List of the new hosts that will be attached to SRA servers host



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

def secure_access_add_host
  @secure_access_add_host
end

#secure_access_allow_external_userObject

Allow providing external user for a domain users [true/false]



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

def secure_access_allow_external_user
  @secure_access_allow_external_user
end

#secure_access_allow_port_forwadingObject

Enable Port forwarding while using CLI access (relevant only for EKS/GKE/K8s Dynamic-Secret)



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

def secure_access_allow_port_forwading
  @secure_access_allow_port_forwading
end

#secure_access_apiObject

Bastion’s SSH control API endpoint. E.g. my.sra-server:9900 (relevant only for ssh cert issuer)



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

def secure_access_api
  @secure_access_api
end

#secure_access_aws_account_idObject

The AWS account id (relevant only for aws)



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

def 
  @secure_access_aws_account_id
end

#secure_access_aws_native_cliObject

The AWS native cli (relevant only for aws)



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

def secure_access_aws_native_cli
  @secure_access_aws_native_cli
end

#secure_access_aws_regionObject

The AWS region (relevant only for aws)



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

def secure_access_aws_region
  @secure_access_aws_region
end

#secure_access_bastion_apiObject

Deprecated. use secure-access-api



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

def secure_access_bastion_api
  @secure_access_bastion_api
end

#secure_access_bastion_issuerObject

Deprecated. use secure-access-certificate-issuer



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

def secure_access_bastion_issuer
  @secure_access_bastion_issuer
end

#secure_access_bastion_sshObject

Deprecated. use secure-access-ssh



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

def secure_access_bastion_ssh
  @secure_access_bastion_ssh
end

#secure_access_certificate_issuerObject

Path to the SSH Certificate Issuer for your Akeyless Secure Access



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

def secure_access_certificate_issuer
  @secure_access_certificate_issuer
end

#secure_access_cluster_endpointObject

The K8s cluster endpoint URL (relevant only for EKS/GKE/K8s Dynamic-Secret)



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

def secure_access_cluster_endpoint
  @secure_access_cluster_endpoint
end

#secure_access_dashboard_urlObject

The K8s dashboard url (relevant only for k8s)



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

def secure_access_dashboard_url
  @secure_access_dashboard_url
end

#secure_access_db_nameObject

The DB name (relevant only for DB Dynamic-Secret)



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

def secure_access_db_name
  @secure_access_db_name
end

#secure_access_db_schemaObject

The DB schema (relevant only for DB Dynamic-Secret)



110
111
112
# File 'lib/akeyless/models/update_item.rb', line 110

def secure_access_db_schema
  @secure_access_db_schema
end

#secure_access_enableObject

Enable/Disable secure remote access [true/false]



113
114
115
# File 'lib/akeyless/models/update_item.rb', line 113

def secure_access_enable
  @secure_access_enable
end

#secure_access_gatewayObject

Returns the value of attribute secure_access_gateway.



115
116
117
# File 'lib/akeyless/models/update_item.rb', line 115

def secure_access_gateway
  @secure_access_gateway
end

#secure_access_hostObject

Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)



118
119
120
# File 'lib/akeyless/models/update_item.rb', line 118

def secure_access_host
  @secure_access_host
end

#secure_access_rd_gateway_serverObject

RD Gateway server (relevant only for rdp)



121
122
123
# File 'lib/akeyless/models/update_item.rb', line 121

def secure_access_rd_gateway_server
  @secure_access_rd_gateway_server
end

#secure_access_rdp_domainObject

Required when the Dynamic Secret is used for a domain user (relevant only for RDP Dynamic-Secret)



124
125
126
# File 'lib/akeyless/models/update_item.rb', line 124

def secure_access_rdp_domain
  @secure_access_rdp_domain
end

#secure_access_rdp_userObject

Override the RDP Domain username



127
128
129
# File 'lib/akeyless/models/update_item.rb', line 127

def secure_access_rdp_user
  @secure_access_rdp_user
end

#secure_access_rm_hostObject

List of the existent hosts that will be removed from SRA servers host



130
131
132
# File 'lib/akeyless/models/update_item.rb', line 130

def secure_access_rm_host
  @secure_access_rm_host
end

#secure_access_sshObject

Bastion’s SSH server. E.g. my.sra-server:22 (relevant only for ssh cert issuer)



133
134
135
# File 'lib/akeyless/models/update_item.rb', line 133

def secure_access_ssh
  @secure_access_ssh
end

#secure_access_ssh_credsObject

Secret values contains SSH Credentials, either Private Key or Password [password/private-key] (relevant only for Static-Secret or Rotated-secret)



136
137
138
# File 'lib/akeyless/models/update_item.rb', line 136

def secure_access_ssh_creds
  @secure_access_ssh_creds
end

#secure_access_ssh_creds_userObject

SSH username to connect to target server, must be in ‘Allowed Users’ list (relevant only for ssh cert issuer)



139
140
141
# File 'lib/akeyless/models/update_item.rb', line 139

def secure_access_ssh_creds_user
  @secure_access_ssh_creds_user
end

#secure_access_urlObject

Destination URL to inject secrets



142
143
144
# File 'lib/akeyless/models/update_item.rb', line 142

def secure_access_url
  @secure_access_url
end

#secure_access_use_internal_bastionObject

Deprecated. Use secure-access-use-internal-ssh-access



145
146
147
# File 'lib/akeyless/models/update_item.rb', line 145

def secure_access_use_internal_bastion
  @secure_access_use_internal_bastion
end

#secure_access_use_internal_ssh_accessObject

Use internal SSH Access



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

def secure_access_use_internal_ssh_access
  @secure_access_use_internal_ssh_access
end

#secure_access_web_browsingObject

Secure browser via Akeyless’s Secure Remote Access (SRA)



151
152
153
# File 'lib/akeyless/models/update_item.rb', line 151

def secure_access_web_browsing
  @secure_access_web_browsing
end

#secure_access_web_proxyObject

Web-Proxy via Akeyless’s Secure Remote Access (SRA)



154
155
156
# File 'lib/akeyless/models/update_item.rb', line 154

def secure_access_web_proxy
  @secure_access_web_proxy
end

#tokenObject

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



157
158
159
# File 'lib/akeyless/models/update_item.rb', line 157

def token
  @token
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



160
161
162
# File 'lib/akeyless/models/update_item.rb', line 160

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



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
# File 'lib/akeyless/models/update_item.rb', line 638

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



218
219
220
# File 'lib/akeyless/models/update_item.rb', line 218

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'provider_type' => :'ProviderType',
    :'accessibility' => :'accessibility',
    :'add_tag' => :'add-tag',
    :'cert_file_data' => :'cert-file-data',
    :'certificate_format' => :'certificate-format',
    :'change_event' => :'change-event',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'expiration_event_in' => :'expiration-event-in',
    :'host_provider' => :'host-provider',
    :'json' => :'json',
    :'max_versions' => :'max-versions',
    :'name' => :'name',
    :'new_metadata' => :'new-metadata',
    :'new_name' => :'new-name',
    :'rm_tag' => :'rm-tag',
    :'rotate_after_disconnect' => :'rotate-after-disconnect',
    :'secure_access_add_host' => :'secure-access-add-host',
    :'secure_access_allow_external_user' => :'secure-access-allow-external-user',
    :'secure_access_allow_port_forwading' => :'secure-access-allow-port-forwading',
    :'secure_access_api' => :'secure-access-api',
    :'secure_access_aws_account_id' => :'secure-access-aws-account-id',
    :'secure_access_aws_native_cli' => :'secure-access-aws-native-cli',
    :'secure_access_aws_region' => :'secure-access-aws-region',
    :'secure_access_bastion_api' => :'secure-access-bastion-api',
    :'secure_access_bastion_issuer' => :'secure-access-bastion-issuer',
    :'secure_access_bastion_ssh' => :'secure-access-bastion-ssh',
    :'secure_access_certificate_issuer' => :'secure-access-certificate-issuer',
    :'secure_access_cluster_endpoint' => :'secure-access-cluster-endpoint',
    :'secure_access_dashboard_url' => :'secure-access-dashboard-url',
    :'secure_access_db_name' => :'secure-access-db-name',
    :'secure_access_db_schema' => :'secure-access-db-schema',
    :'secure_access_enable' => :'secure-access-enable',
    :'secure_access_gateway' => :'secure-access-gateway',
    :'secure_access_host' => :'secure-access-host',
    :'secure_access_rd_gateway_server' => :'secure-access-rd-gateway-server',
    :'secure_access_rdp_domain' => :'secure-access-rdp-domain',
    :'secure_access_rdp_user' => :'secure-access-rdp-user',
    :'secure_access_rm_host' => :'secure-access-rm-host',
    :'secure_access_ssh' => :'secure-access-ssh',
    :'secure_access_ssh_creds' => :'secure-access-ssh-creds',
    :'secure_access_ssh_creds_user' => :'secure-access-ssh-creds-user',
    :'secure_access_url' => :'secure-access-url',
    :'secure_access_use_internal_bastion' => :'secure-access-use-internal-bastion',
    :'secure_access_use_internal_ssh_access' => :'secure-access-use-internal-ssh-access',
    :'secure_access_web_browsing' => :'secure-access-web-browsing',
    :'secure_access_web_proxy' => :'secure-access-web-proxy',
    :'token' => :'token',
    :'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



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
# File 'lib/akeyless/models/update_item.rb', line 614

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



278
279
280
281
# File 'lib/akeyless/models/update_item.rb', line 278

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'provider_type' => :'String',
    :'accessibility' => :'String',
    :'add_tag' => :'Array<String>',
    :'cert_file_data' => :'String',
    :'certificate_format' => :'String',
    :'change_event' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'expiration_event_in' => :'Array<String>',
    :'host_provider' => :'String',
    :'json' => :'Boolean',
    :'max_versions' => :'String',
    :'name' => :'String',
    :'new_metadata' => :'String',
    :'new_name' => :'String',
    :'rm_tag' => :'Array<String>',
    :'rotate_after_disconnect' => :'String',
    :'secure_access_add_host' => :'Array<String>',
    :'secure_access_allow_external_user' => :'String',
    :'secure_access_allow_port_forwading' => :'Boolean',
    :'secure_access_api' => :'String',
    :'secure_access_aws_account_id' => :'String',
    :'secure_access_aws_native_cli' => :'Boolean',
    :'secure_access_aws_region' => :'String',
    :'secure_access_bastion_api' => :'String',
    :'secure_access_bastion_issuer' => :'String',
    :'secure_access_bastion_ssh' => :'String',
    :'secure_access_certificate_issuer' => :'String',
    :'secure_access_cluster_endpoint' => :'String',
    :'secure_access_dashboard_url' => :'String',
    :'secure_access_db_name' => :'String',
    :'secure_access_db_schema' => :'String',
    :'secure_access_enable' => :'String',
    :'secure_access_gateway' => :'String',
    :'secure_access_host' => :'Array<String>',
    :'secure_access_rd_gateway_server' => :'String',
    :'secure_access_rdp_domain' => :'String',
    :'secure_access_rdp_user' => :'String',
    :'secure_access_rm_host' => :'Array<String>',
    :'secure_access_ssh' => :'String',
    :'secure_access_ssh_creds' => :'String',
    :'secure_access_ssh_creds_user' => :'String',
    :'secure_access_url' => :'String',
    :'secure_access_use_internal_bastion' => :'Boolean',
    :'secure_access_use_internal_ssh_access' => :'Boolean',
    :'secure_access_web_browsing' => :'Boolean',
    :'secure_access_web_proxy' => :'Boolean',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
# File 'lib/akeyless/models/update_item.rb', line 545

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      provider_type == o.provider_type &&
      accessibility == o.accessibility &&
      add_tag == o.add_tag &&
      cert_file_data == o.cert_file_data &&
      certificate_format == o.certificate_format &&
      change_event == o.change_event &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      expiration_event_in == o.expiration_event_in &&
      host_provider == o.host_provider &&
      json == o.json &&
      max_versions == o.max_versions &&
      name == o.name &&
       == o. &&
      new_name == o.new_name &&
      rm_tag == o.rm_tag &&
      rotate_after_disconnect == o.rotate_after_disconnect &&
      secure_access_add_host == o.secure_access_add_host &&
      secure_access_allow_external_user == o.secure_access_allow_external_user &&
      secure_access_allow_port_forwading == o.secure_access_allow_port_forwading &&
      secure_access_api == o.secure_access_api &&
       == o. &&
      secure_access_aws_native_cli == o.secure_access_aws_native_cli &&
      secure_access_aws_region == o.secure_access_aws_region &&
      secure_access_bastion_api == o.secure_access_bastion_api &&
      secure_access_bastion_issuer == o.secure_access_bastion_issuer &&
      secure_access_bastion_ssh == o.secure_access_bastion_ssh &&
      secure_access_certificate_issuer == o.secure_access_certificate_issuer &&
      secure_access_cluster_endpoint == o.secure_access_cluster_endpoint &&
      secure_access_dashboard_url == o.secure_access_dashboard_url &&
      secure_access_db_name == o.secure_access_db_name &&
      secure_access_db_schema == o.secure_access_db_schema &&
      secure_access_enable == o.secure_access_enable &&
      secure_access_gateway == o.secure_access_gateway &&
      secure_access_host == o.secure_access_host &&
      secure_access_rd_gateway_server == o.secure_access_rd_gateway_server &&
      secure_access_rdp_domain == o.secure_access_rdp_domain &&
      secure_access_rdp_user == o.secure_access_rdp_user &&
      secure_access_rm_host == o.secure_access_rm_host &&
      secure_access_ssh == o.secure_access_ssh &&
      secure_access_ssh_creds == o.secure_access_ssh_creds &&
      secure_access_ssh_creds_user == o.secure_access_ssh_creds_user &&
      secure_access_url == o.secure_access_url &&
      secure_access_use_internal_bastion == o.secure_access_use_internal_bastion &&
      secure_access_use_internal_ssh_access == o.secure_access_use_internal_ssh_access &&
      secure_access_web_browsing == o.secure_access_web_browsing &&
      secure_access_web_proxy == o.secure_access_web_proxy &&
      token == o.token &&
      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



709
710
711
712
713
714
715
716
717
718
719
720
721
# File 'lib/akeyless/models/update_item.rb', line 709

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


601
602
603
# File 'lib/akeyless/models/update_item.rb', line 601

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



607
608
609
# File 'lib/akeyless/models/update_item.rb', line 607

def hash
  [provider_type, accessibility, add_tag, cert_file_data, certificate_format, change_event, delete_protection, description, expiration_event_in, host_provider, json, max_versions, name, , new_name, rm_tag, rotate_after_disconnect, secure_access_add_host, secure_access_allow_external_user, secure_access_allow_port_forwading, secure_access_api, , secure_access_aws_native_cli, secure_access_aws_region, secure_access_bastion_api, secure_access_bastion_issuer, secure_access_bastion_ssh, secure_access_certificate_issuer, secure_access_cluster_endpoint, secure_access_dashboard_url, secure_access_db_name, secure_access_db_schema, secure_access_enable, secure_access_gateway, secure_access_host, secure_access_rd_gateway_server, secure_access_rdp_domain, secure_access_rdp_user, secure_access_rm_host, secure_access_ssh, secure_access_ssh_creds, secure_access_ssh_creds_user, secure_access_url, secure_access_use_internal_bastion, secure_access_use_internal_ssh_access, secure_access_web_browsing, secure_access_web_proxy, token, uid_token].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



525
526
527
528
529
530
531
532
533
# File 'lib/akeyless/models/update_item.rb', line 525

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



685
686
687
# File 'lib/akeyless/models/update_item.rb', line 685

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



691
692
693
694
695
696
697
698
699
700
701
702
703
# File 'lib/akeyless/models/update_item.rb', line 691

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



679
680
681
# File 'lib/akeyless/models/update_item.rb', line 679

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



537
538
539
540
541
# File 'lib/akeyless/models/update_item.rb', line 537

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