Class: Akeyless::RotatedSecretUpdateSplunk

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

Overview

rotatedSecretUpdateSplunk is a command that updates a rotated secret for a Splunk target. It reuses the rotator type chosen at create time.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RotatedSecretUpdateSplunk

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

  if attributes.key?(:'item_custom_fields')
    if (value = attributes[:'item_custom_fields']).is_a?(Hash)
      self.item_custom_fields = 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?(:'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_name')
    self.new_name = attributes[:'new_name']
  end

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

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

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

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

  if attributes.key?(:'token_owner')
    self.token_owner = attributes[:'token_owner']
  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/rotated_secret_update_splunk.rb', line 20

def add_tag
  @add_tag
end

#audience ⇒ Object

Token audience for Splunk token creation (relevant only for rotator-type=token)



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

def audience
  @audience
end

#authentication_credentials ⇒ Object

The credentials to connect with use-user-creds/use-target-creds



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

def authentication_credentials
  @authentication_credentials
end

#auto_rotate ⇒ Object

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



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

def auto_rotate
  @auto_rotate
end

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#expiration_date ⇒ Object

Token expiration date in YYYY-MM-DD format (relevant only for rotator-type=token when manual rotation is selected). Time will be set to 00:00 UTC.



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

def expiration_date
  @expiration_date
end

#hec_token ⇒ Object

For rotator-type=hec-token, optionally set/replace the stored HEC token value.



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

def hec_token
  @hec_token
end

#input_rule ⇒ Object

Agentic input rule in name=…,rule=… format (e.g. name=rule1,rule=Sanitize input)



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

def input_rule
  @input_rule
end

#item_custom_fields ⇒ Object

Additional custom fields to associate with the item



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

def item_custom_fields
  @item_custom_fields
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#keep_prev_version ⇒ Object

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



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

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)



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

def key
  @key
end

#max_versions ⇒ Object

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



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

def max_versions
  @max_versions
end

#name ⇒ Object

Rotated secret name



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

def name
  @name
end

#new_name ⇒ Object

New item name



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

def new_name
  @new_name
end

#output_rule ⇒ Object

Agentic output rule in name=…,rule=… format (e.g. name=rule1,rule=Mask secrets)



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

def output_rule
  @output_rule
end

#password_length ⇒ Object

The length of the password to be generated



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

def password_length
  @password_length
end

#rm_tag ⇒ Object

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



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

def rm_tag
  @rm_tag
end

#rotation_event_in ⇒ Object

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



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

def rotation_event_in
  @rotation_event_in
end

#rotation_hour ⇒ Object

The Hour of the rotation in UTC



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

def rotation_hour
  @rotation_hour
end

#rotation_interval ⇒ Object

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



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

def rotation_interval
  @rotation_interval
end

#splunk_token ⇒ Object

For rotator-type=token, optionally set/replace the stored Splunk authentication token value.



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

def splunk_token
  @splunk_token
end

#token ⇒ Object

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



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

def token
  @token
end

#token_owner ⇒ Object

For rotator-type=token, specify the Splunk username that the new token should be issued for. (Splunk 10 requires name=<token-owner> when creating auth tokens.)



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

def token_owner
  @token_owner
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 98

def self.attribute_map
  {
    :'add_tag' => :'add-tag',
    :'audience' => :'audience',
    :'authentication_credentials' => :'authentication-credentials',
    :'auto_rotate' => :'auto-rotate',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'expiration_date' => :'expiration-date',
    :'hec_token' => :'hec-token',
    :'input_rule' => :'input-rule',
    :'item_custom_fields' => :'item-custom-fields',
    :'json' => :'json',
    :'keep_prev_version' => :'keep-prev-version',
    :'key' => :'key',
    :'max_versions' => :'max-versions',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'output_rule' => :'output-rule',
    :'password_length' => :'password-length',
    :'rm_tag' => :'rm-tag',
    :'rotation_event_in' => :'rotation-event-in',
    :'rotation_hour' => :'rotation-hour',
    :'rotation_interval' => :'rotation-interval',
    :'splunk_token' => :'splunk-token',
    :'token' => :'token',
    :'token_owner' => :'token-owner',
    :'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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 380

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



167
168
169
170
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 167

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'add_tag' => :'Array<String>',
    :'audience' => :'String',
    :'authentication_credentials' => :'String',
    :'auto_rotate' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'expiration_date' => :'String',
    :'hec_token' => :'String',
    :'input_rule' => :'Array<String>',
    :'item_custom_fields' => :'Hash<String, String>',
    :'json' => :'Boolean',
    :'keep_prev_version' => :'String',
    :'key' => :'String',
    :'max_versions' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'output_rule' => :'Array<String>',
    :'password_length' => :'String',
    :'rm_tag' => :'Array<String>',
    :'rotation_event_in' => :'Array<String>',
    :'rotation_hour' => :'Integer',
    :'rotation_interval' => :'String',
    :'splunk_token' => :'String',
    :'token' => :'String',
    :'token_owner' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      add_tag == o.add_tag &&
      audience == o.audience &&
      authentication_credentials == o.authentication_credentials &&
      auto_rotate == o.auto_rotate &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      expiration_date == o.expiration_date &&
      hec_token == o.hec_token &&
      input_rule == o.input_rule &&
      item_custom_fields == o.item_custom_fields &&
      json == o.json &&
      keep_prev_version == o.keep_prev_version &&
      key == o.key &&
      max_versions == o.max_versions &&
      name == o.name &&
      new_name == o.new_name &&
      output_rule == o.output_rule &&
      password_length == o.password_length &&
      rm_tag == o.rm_tag &&
      rotation_event_in == o.rotation_event_in &&
      rotation_hour == o.rotation_hour &&
      rotation_interval == o.rotation_interval &&
      splunk_token == o.splunk_token &&
      token == o.token &&
      token_owner == o.token_owner &&
      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



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 475

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


367
368
369
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 367

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



373
374
375
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 373

def hash
  [add_tag, audience, authentication_credentials, auto_rotate, delete_protection, description, expiration_date, hec_token, input_rule, item_custom_fields, json, keep_prev_version, key, max_versions, name, new_name, output_rule, password_length, rm_tag, rotation_event_in, rotation_hour, rotation_interval, splunk_token, token, token_owner, 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



314
315
316
317
318
319
320
321
322
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 314

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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



451
452
453
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 451

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



457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 457

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



445
446
447
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 445

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



326
327
328
329
330
 
# File 'lib/akeyless/models/rotated_secret_update_splunk.rb', line 326

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