Class: SmplkitGeneratedClient::Audit::Forwarder

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb

Overview

A destination that receives audit events recorded for the account. Each event recorded for the account is evaluated against every enabled forwarder. If the filter expression evaluates truthy — or is absent — the event is delivered to the destination using the configured HTTP request. The slug, derived from ‘name` at create time, is the stable identifier used by the console and other tooling.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Forwarder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 133

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::Forwarder` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::Forwarder`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

When the forwarder was created.



41
42
43
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 41

def created_at
  @created_at
end

#deleted_at ⇒ Object

When the forwarder was deleted. ‘null` for active forwarders.



47
48
49
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 47

def deleted_at
  @deleted_at
end

#enabled ⇒ Object

Whether the forwarder is currently delivering events. Set to ‘false` to pause deliveries without deleting the forwarder.



26
27
28
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 26

def enabled
  @enabled
end

#filter ⇒ Object

JSON Logic expression evaluated against each event. The event is delivered only if the expression returns truthy. Omit to deliver every event.



29
30
31
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 29

def filter
  @filter
end

#forwarder_type ⇒ Object

Destination type.



23
24
25
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 23

def forwarder_type
  @forwarder_type
end

#http ⇒ Object

HTTP request used to deliver each event to the destination.



35
36
37
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 35

def http
  @http
end

#name ⇒ Object

Human-readable name for the forwarder.



20
21
22
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 20

def name
  @name
end

#slug ⇒ Object

URL-safe identifier derived from ‘name` at create time. Stable for the lifetime of the forwarder.



38
39
40
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 38

def slug
  @slug
end

#transform ⇒ Object

JSONata template applied to each event before delivery. Omit to deliver the event unchanged.



32
33
34
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 32

def transform
  @transform
end

#updated_at ⇒ Object

When the forwarder was last modified.



44
45
46
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 44

def updated_at
  @updated_at
end

#version ⇒ Object

Monotonic counter incremented on every update, starting at 1.



50
51
52
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 50

def version
  @version
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



92
93
94
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 92

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 97

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 75

def self.attribute_map
  {
    :'name' => :'name',
    :'forwarder_type' => :'forwarder_type',
    :'enabled' => :'enabled',
    :'filter' => :'filter',
    :'transform' => :'transform',
    :'http' => :'http',
    :'slug' => :'slug',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'deleted_at' => :'deleted_at',
    :'version' => :'version'
  }
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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 328

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



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 119

def self.openapi_nullable
  Set.new([
    :'filter',
    :'transform',
    :'slug',
    :'created_at',
    :'updated_at',
    :'deleted_at',
    :'version'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 102

def self.openapi_types
  {
    :'name' => :'String',
    :'forwarder_type' => :'ForwarderType',
    :'enabled' => :'Boolean',
    :'filter' => :'Hash<String, Object>',
    :'transform' => :'String',
    :'http' => :'ForwarderHttp',
    :'slug' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'deleted_at' => :'Time',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 297

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      forwarder_type == o.forwarder_type &&
      enabled == o.enabled &&
      filter == o.filter &&
      transform == o.transform &&
      http == o.http &&
      slug == o.slug &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      deleted_at == o.deleted_at &&
      version == o.version
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


315
316
317
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 315

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



321
322
323
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 321

def hash
  [name, forwarder_type, enabled, filter, transform, http, slug, created_at, updated_at, deleted_at, version].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



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
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 204

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 @name.to_s.length > 200
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
  end

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

  if !@transform.nil? && @transform.to_s.length > 16384
    invalid_properties.push('invalid value for "transform", the character length must be smaller than or equal to 16384.')
  end

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 350

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 236

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 200
  return false if @name.to_s.length < 1
  return false if @forwarder_type.nil?
  return false if !@transform.nil? && @transform.to_s.length > 16384
  return false if @http.nil?
  true
end