Class: Akeyless::EventForwarderCreateWebhook

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

Overview

eventForwarderCreateWebhook is a command that creates webhook event forwarder

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EventForwarderCreateWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth_methods_event_source_locations ⇒ Object

Auth Method Event sources



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

def auth_methods_event_source_locations
  @auth_methods_event_source_locations
end

#auth_token ⇒ Object

Base64 encoded Token string for authentication type Token



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

def auth_token
  @auth_token
end

#auth_type ⇒ Object

The Webhook authentication type [user-pass, bearer-token, certificate]



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

def auth_type
  @auth_type
end

#client_cert_data ⇒ Object

Base64 encoded PEM certificate, relevant for certificate auth-type



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

def client_cert_data
  @client_cert_data
end

#description ⇒ Object

Description of the object



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

def description
  @description
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, next-automatic-rotation, 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, rate-limiting, usage-report]



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

def event_types
  @event_types
end

#every ⇒ Object

Rate of periodic runner repetition in hours



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

def every
  @every
end

#gateways_event_source_locations ⇒ Object

Event sources



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

def gateways_event_source_locations
  @gateways_event_source_locations
end

#items_event_source_locations ⇒ Object

Items Event sources



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

def items_event_source_locations
  @items_event_source_locations
end

#json ⇒ Object

Set output format to JSON



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

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)



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

def key
  @key
end

#name ⇒ Object

EventForwarder name



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

def name
  @name
end

#password ⇒ Object

Password for authentication relevant for user-pass auth-type



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

def password
  @password
end

#private_key_data ⇒ Object

Base64 encoded PEM RSA Private Key, relevant for certificate auth-type



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

def private_key_data
  @private_key_data
end

#runner_type ⇒ Object

Returns the value of attribute runner_type.



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

def runner_type
  @runner_type
end

#server_certificates ⇒ Object

Base64 encoded PEM certificate of the Webhook



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

def server_certificates
  @server_certificates
end

#targets_event_source_locations ⇒ Object

Targets Event sources



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

def targets_event_source_locations
  @targets_event_source_locations
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



73
74
75
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 73

def uid_token
  @uid_token
end

#url ⇒ Object

Webhook URL



76
77
78
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 76

def url
  @url
end

#username ⇒ Object

Username for authentication relevant for user-pass auth-type



79
80
81
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 79

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



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

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



109
110
111
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 109

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'auth_methods_event_source_locations' => :'auth-methods-event-source-locations',
    :'auth_token' => :'auth-token',
    :'auth_type' => :'auth-type',
    :'client_cert_data' => :'client-cert-data',
    :'description' => :'description',
    :'event_types' => :'event-types',
    :'every' => :'every',
    :'gateways_event_source_locations' => :'gateways-event-source-locations',
    :'items_event_source_locations' => :'items-event-source-locations',
    :'json' => :'json',
    :'key' => :'key',
    :'name' => :'name',
    :'password' => :'password',
    :'private_key_data' => :'private-key-data',
    :'runner_type' => :'runner-type',
    :'server_certificates' => :'server-certificates',
    :'targets_event_source_locations' => :'targets-event-source-locations',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'url' => :'url',
    :'username' => :'username'
  }
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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 339

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 114

def self.openapi_types
  {
    :'auth_methods_event_source_locations' => :'Array<String>',
    :'auth_token' => :'String',
    :'auth_type' => :'String',
    :'client_cert_data' => :'String',
    :'description' => :'String',
    :'event_types' => :'Array<String>',
    :'every' => :'String',
    :'gateways_event_source_locations' => :'Array<String>',
    :'items_event_source_locations' => :'Array<String>',
    :'json' => :'Boolean',
    :'key' => :'String',
    :'name' => :'String',
    :'password' => :'String',
    :'private_key_data' => :'String',
    :'runner_type' => :'String',
    :'server_certificates' => :'String',
    :'targets_event_source_locations' => :'Array<String>',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'url' => :'String',
    :'username' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_methods_event_source_locations == o.auth_methods_event_source_locations &&
      auth_token == o.auth_token &&
      auth_type == o.auth_type &&
      client_cert_data == o.client_cert_data &&
      description == o.description &&
      event_types == o.event_types &&
      every == o.every &&
      gateways_event_source_locations == o.gateways_event_source_locations &&
      items_event_source_locations == o.items_event_source_locations &&
      json == o.json &&
      key == o.key &&
      name == o.name &&
      password == o.password &&
      private_key_data == o.private_key_data &&
      runner_type == o.runner_type &&
      server_certificates == o.server_certificates &&
      targets_event_source_locations == o.targets_event_source_locations &&
      token == o.token &&
      uid_token == o.uid_token &&
      url == o.url &&
      username == o.username
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



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 434

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


326
327
328
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 326

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



332
333
334
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 332

def hash
  [auth_methods_event_source_locations, auth_token, auth_type, client_cert_data, description, event_types, every, gateways_event_source_locations, items_event_source_locations, json, key, name, password, private_key_data, runner_type, server_certificates, targets_event_source_locations, token, uid_token, url, username].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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 268

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @gateways_event_source_locations.nil?
    invalid_properties.push('invalid value for "gateways_event_source_locations", gateways_event_source_locations 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



410
411
412
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 410

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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 416

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



404
405
406
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 404

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



288
289
290
291
292
293
294
 
# File 'lib/akeyless/models/event_forwarder_create_webhook.rb', line 288

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