Class: Akeyless::CreateEventForwarder

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

Overview

createEventForwarder is a command that creates a new event forwarder [Deprecated - please use event-forwarder-create-* command]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEventForwarder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 152

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

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

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

  if attributes.key?(:'auth_type')
    self.auth_type = attributes[:'auth_type']
  else
    self.auth_type = 'user-pass'
  end

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

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

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

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

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

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

  if attributes.key?(:'event_source_type')
    self.event_source_type = attributes[:'event_source_type']
  else
    self.event_source_type = 'item'
  end

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

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

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

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

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

Instance Attribute Details

#admin_name ⇒ Object

Workstation Admin Name



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

def admin_name
  @admin_name
end

#admin_pwd ⇒ Object

Workstation Admin password



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

def admin_pwd
  @admin_pwd
end

#app_private_key_base64 ⇒ Object

The RSA Private Key PEM formatted in base64 to use when connecting to ServiceNow with jwt authentication



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

def app_private_key_base64
  @app_private_key_base64
end

#auth_type ⇒ Object

The authentication type to use when connecting to ServiceNow (user-pass / jwt)



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

def auth_type
  @auth_type
end

#client_id ⇒ Object

The client ID to use when connecting to ServiceNow with jwt authentication



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

def client_id
  @client_id
end

#client_secret ⇒ Object

The client secret to use when connecting to ServiceNow with jwt authentication



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

def client_secret
  @client_secret
end

#comment ⇒ Object

Deprecated - use description



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

def comment
  @comment
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#email_to ⇒ Object

A comma seperated list of email addresses to send event to (relevant only for "email" Event Forwarder)



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

def email_to
  @email_to
end

#event_source_locations ⇒ Object

Event sources



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

def event_source_locations
  @event_source_locations
end

#event_source_type ⇒ Object

Event Source type [item, target, auth_method, gateway]



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

def event_source_type
  @event_source_type
end

#event_types ⇒ Object

List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated]



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

def event_types
  @event_types
end

#every ⇒ Object

Rate of periodic runner repetition in hours



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

def every
  @every
end

#forwarder_type ⇒ Object

Returns the value of attribute forwarder_type.



58
59
60
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 58

def forwarder_type
  @forwarder_type
end

#host ⇒ Object

Workstation Host



61
62
63
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 61

def host
  @host
end

#json ⇒ Object

Set output format to JSON



64
65
66
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 64

def json
  @json
end

#key ⇒ Object

The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)



67
68
69
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 67

def key
  @key
end

#name ⇒ Object

EventForwarder name



70
71
72
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 70

def name
  @name
end

#runner_type ⇒ Object

Returns the value of attribute runner_type.



72
73
74
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 72

def runner_type
  @runner_type
end

#token ⇒ Object

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



75
76
77
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 75

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



78
79
80
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 78

def uid_token
  @uid_token
end

#user_email ⇒ Object

The user email to use when connecting to ServiceNow with jwt authentication



81
82
83
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 81

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



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

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



112
113
114
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 112

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 84

def self.attribute_map
  {
    :'admin_name' => :'admin-name',
    :'admin_pwd' => :'admin-pwd',
    :'app_private_key_base64' => :'app-private-key-base64',
    :'auth_type' => :'auth-type',
    :'client_id' => :'client-id',
    :'client_secret' => :'client-secret',
    :'comment' => :'comment',
    :'description' => :'description',
    :'email_to' => :'email-to',
    :'event_source_locations' => :'event-source-locations',
    :'event_source_type' => :'event-source-type',
    :'event_types' => :'event-types',
    :'every' => :'every',
    :'forwarder_type' => :'forwarder-type',
    :'host' => :'host',
    :'json' => :'json',
    :'key' => :'key',
    :'name' => :'name',
    :'runner_type' => :'runner-type',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'user_email' => :'user-email'
  }
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



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

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'admin_name' => :'String',
    :'admin_pwd' => :'String',
    :'app_private_key_base64' => :'String',
    :'auth_type' => :'String',
    :'client_id' => :'String',
    :'client_secret' => :'String',
    :'comment' => :'String',
    :'description' => :'String',
    :'email_to' => :'String',
    :'event_source_locations' => :'Array<String>',
    :'event_source_type' => :'String',
    :'event_types' => :'Array<String>',
    :'every' => :'String',
    :'forwarder_type' => :'String',
    :'host' => :'String',
    :'json' => :'Boolean',
    :'key' => :'String',
    :'name' => :'String',
    :'runner_type' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'user_email' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      admin_name == o.admin_name &&
      admin_pwd == o.admin_pwd &&
      app_private_key_base64 == o.app_private_key_base64 &&
      auth_type == o.auth_type &&
      client_id == o.client_id &&
      client_secret == o.client_secret &&
      comment == o.comment &&
      description == o.description &&
      email_to == o.email_to &&
      event_source_locations == o.event_source_locations &&
      event_source_type == o.event_source_type &&
      event_types == o.event_types &&
      every == o.every &&
      forwarder_type == o.forwarder_type &&
      host == o.host &&
      json == o.json &&
      key == o.key &&
      name == o.name &&
      runner_type == o.runner_type &&
      token == o.token &&
      uid_token == o.uid_token &&
      user_email == o.user_email
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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 446

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


338
339
340
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 344

def hash
  [admin_name, admin_pwd, app_private_key_base64, auth_type, client_id, client_secret, comment, description, email_to, event_source_locations, event_source_type, event_types, every, forwarder_type, host, json, key, name, runner_type, token, uid_token, user_email].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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 274

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @event_source_locations.nil?
    invalid_properties.push('invalid value for "event_source_locations", event_source_locations cannot be nil.')
  end

  if @forwarder_type.nil?
    invalid_properties.push('invalid value for "forwarder_type", forwarder_type cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

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



422
423
424
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 422

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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 428

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



416
417
418
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 416

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



298
299
300
301
302
303
304
305
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 298

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