Class: Akeyless::AssocTargetItem

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

Overview

assocTargetItem is a command that creates an association between target and item.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssocTargetItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'protection_level')
    self.protection_level = attributes[:'protection_level']
  else
    self.protection_level = 'software'
  end

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

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

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

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

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

Instance Attribute Details

#certificate_path ⇒ Object

A path on the target to store the certificate pem file (relevant only for certificate provisioning)



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

def certificate_path
  @certificate_path
end

#chain_path ⇒ Object

A path on the target to store the full chain pem file (relevant only for certificate provisioning)



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

def chain_path
  @chain_path
end

#disable_previous_key_version ⇒ Object

Automatically disable previous key version (required for azure targets)



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

def disable_previous_key_version
  @disable_previous_key_version
end

#external_key_name ⇒ Object

The external key name to associate with the classic key (Relevant only for Classic Key AWS/Azure/GCP targets)



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

def external_key_name
  @external_key_name
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#key_operations ⇒ Object

A list of allowed operations for the key (required for azure targets)



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

def key_operations
  @key_operations
end

#keyring_name ⇒ Object

Keyring name of the GCP KMS (required for gcp targets)



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

def keyring_name
  @keyring_name
end

#kms_algorithm ⇒ Object

Algorithm of the key in GCP KMS (required for gcp targets)



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

def kms_algorithm
  @kms_algorithm
end

#location_id ⇒ Object

Location id of the GCP KMS (required for gcp targets)



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

def location_id
  @location_id
end

#multi_region ⇒ Object

Set to ‘true’ to create a multi-region managed key. (Relevant only for Classic Key AWS targets)



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

def multi_region
  @multi_region
end

#name ⇒ Object

The item to associate



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

def name
  @name
end

#post_provision_command ⇒ Object

A custom command to run on the remote target after successful provisioning (relevant only for certificate provisioning)



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

def post_provision_command
  @post_provision_command
end

#private_key_path ⇒ Object

A path on the target to store the private key (relevant only for certificate provisioning)



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

def private_key_path
  @private_key_path
end

#project_id ⇒ Object

Project id of the GCP KMS (required for gcp targets)



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

def project_id
  @project_id
end

#protection_level ⇒ Object

Protection level of the key [software/hardware] (relevant for gcp targets)



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

def protection_level
  @protection_level
end

#purpose ⇒ Object

Purpose of the key in GCP KMS (required for gcp targets)



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

def purpose
  @purpose
end

#regions ⇒ Object

The list of regions to create a copy of the key in (relevant for aws targets)



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

def regions
  @regions
end

#sra_association ⇒ Object

Is the target to associate is for sra, relevant only for linked target association for ldap rotated secret



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

def sra_association
  @sra_association
end

#target_name ⇒ Object

The target to associate



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

def target_name
  @target_name
end

#tenant_secret_type ⇒ Object

The tenant secret type [Data/SearchIndex/Analytics] (required for salesforce targets)



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

def tenant_secret_type
  @tenant_secret_type
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
end

#vault_name ⇒ Object

Name of the vault used (required for azure targets)



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

def vault_name
  @vault_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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 89

def self.attribute_map
  {
    :'certificate_path' => :'certificate-path',
    :'chain_path' => :'chain-path',
    :'disable_previous_key_version' => :'disable-previous-key-version',
    :'external_key_name' => :'external-key-name',
    :'json' => :'json',
    :'key_operations' => :'key-operations',
    :'keyring_name' => :'keyring-name',
    :'kms_algorithm' => :'kms-algorithm',
    :'location_id' => :'location-id',
    :'multi_region' => :'multi-region',
    :'name' => :'name',
    :'post_provision_command' => :'post-provision-command',
    :'private_key_path' => :'private-key-path',
    :'project_id' => :'project-id',
    :'protection_level' => :'protection-level',
    :'purpose' => :'purpose',
    :'regions' => :'regions',
    :'sra_association' => :'sra-association',
    :'target_name' => :'target-name',
    :'tenant_secret_type' => :'tenant-secret-type',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'vault_name' => :'vault-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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 353

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



152
153
154
155
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 152

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'certificate_path' => :'String',
    :'chain_path' => :'String',
    :'disable_previous_key_version' => :'Boolean',
    :'external_key_name' => :'String',
    :'json' => :'Boolean',
    :'key_operations' => :'Array<String>',
    :'keyring_name' => :'String',
    :'kms_algorithm' => :'String',
    :'location_id' => :'String',
    :'multi_region' => :'String',
    :'name' => :'String',
    :'post_provision_command' => :'String',
    :'private_key_path' => :'String',
    :'project_id' => :'String',
    :'protection_level' => :'String',
    :'purpose' => :'String',
    :'regions' => :'Array<String>',
    :'sra_association' => :'Boolean',
    :'target_name' => :'String',
    :'tenant_secret_type' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'vault_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      certificate_path == o.certificate_path &&
      chain_path == o.chain_path &&
      disable_previous_key_version == o.disable_previous_key_version &&
      external_key_name == o.external_key_name &&
      json == o.json &&
      key_operations == o.key_operations &&
      keyring_name == o.keyring_name &&
      kms_algorithm == o.kms_algorithm &&
      location_id == o.location_id &&
      multi_region == o.multi_region &&
      name == o.name &&
      post_provision_command == o.post_provision_command &&
      private_key_path == o.private_key_path &&
      project_id == o.project_id &&
      protection_level == o.protection_level &&
      purpose == o.purpose &&
      regions == o.regions &&
      sra_association == o.sra_association &&
      target_name == o.target_name &&
      tenant_secret_type == o.tenant_secret_type &&
      token == o.token &&
      uid_token == o.uid_token &&
      vault_name == o.vault_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



448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 448

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


340
341
342
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 340

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



346
347
348
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 346

def hash
  [certificate_path, chain_path, disable_previous_key_version, external_key_name, json, key_operations, keyring_name, kms_algorithm, location_id, multi_region, name, post_provision_command, private_key_path, project_id, protection_level, purpose, regions, sra_association, target_name, tenant_secret_type, token, uid_token, vault_name].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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 285

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



424
425
426
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 424

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



430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 430

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



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

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



301
302
303
304
305
306
 
# File 'lib/akeyless/models/assoc_target_item.rb', line 301

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