Class: Akeyless::CreateEventForwarder

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

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



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

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

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

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

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

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

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

#admin_name ⇒ Object

Workstation Admin Name



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

def admin_name
  @admin_name
end

#admin_pwd ⇒ Object

Workstation Admin password



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

def admin_pwd
  @admin_pwd
end

#comment ⇒ Object

Comment about the EventForwarder



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

def comment
  @comment
end

#email_to ⇒ Object

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



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

def email_to
  @email_to
end

#event_source_locations ⇒ Object

Event sources



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

def event_source_locations
  @event_source_locations
end

#event_source_type ⇒ Object

Event Source type [item, target]



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

def event_source_type
  @event_source_type
end

#event_types ⇒ Object

Event types



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

def event_types
  @event_types
end

#every ⇒ Object

Rate of periodic runner repetition in hours



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

def every
  @every
end

#forwarder_type ⇒ Object

Returns the value of attribute forwarder_type.



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

def forwarder_type
  @forwarder_type
end

#host ⇒ Object

Workstation Host



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

def host
  @host
end

#json ⇒ Object

Set output format to JSON



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

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)



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

def key
  @key
end

#name ⇒ Object

EventForwarder name



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

def name
  @name
end

#runner_type ⇒ Object

Returns the value of attribute runner_type.



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

def runner_type
  @runner_type
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 65

def self.attribute_map
  {
    :'admin_name' => :'admin-name',
    :'admin_pwd' => :'admin-pwd',
    :'comment' => :'comment',
    :'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'
  }
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



276
277
278
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 276

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 92

def self.openapi_types
  {
    :'admin_name' => :'String',
    :'admin_pwd' => :'String',
    :'comment' => :'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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      admin_name == o.admin_name &&
      admin_pwd == o.admin_pwd &&
      comment == o.comment &&
      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
end

#_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



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

def _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_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 378

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

#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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 283

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


263
264
265
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 263

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



269
270
271
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 269

def hash
  [admin_name, admin_pwd, comment, email_to, event_source_locations, event_source_type, event_types, every, forwarder_type, host, json, key, name, runner_type, token, 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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 207

def list_invalid_properties
  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



354
355
356
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 354

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 360

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



348
349
350
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 348

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



230
231
232
233
234
235
236
 
# File 'lib/akeyless/models/create_event_forwarder.rb', line 230

def valid?
  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