Class: SmplkitGeneratedClient::Audit::ForwarderDelivery

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

Overview

A log entry for one attempt to deliver an event to a forwarder.

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 = {}) ⇒ ForwarderDelivery

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attempt_number ⇒ Object

1 for the initial delivery, incremented for each retry.



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

def attempt_number
  @attempt_number
end

#created_at ⇒ Object

When the delivery attempt was recorded.



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

def created_at
  @created_at
end

#environment ⇒ Object

Environment the delivered event occurred in. Deliveries are scoped to one environment.



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

def environment
  @environment
end

#error ⇒ Object

Error message if the delivery did not complete.



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

def error
  @error
end

#event ⇒ Object

Event that was being delivered.



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

def event
  @event
end

#forwarder ⇒ Object

Forwarder the delivery belongs to.



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

def forwarder
  @forwarder
end

#latency_ms ⇒ Object

Elapsed time of the delivery attempt in milliseconds.



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

def latency_ms
  @latency_ms
end

#request ⇒ Object

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



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

def request
  @request
end

#response_body ⇒ Object

Response body returned by the destination.



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

def response_body
  @response_body
end

#response_status ⇒ Object

HTTP status code returned by the destination.



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

def response_status
  @response_status
end

#status ⇒ Object

Delivery outcome. ‘SUCCEEDED` when the destination accepted the event, `FAILED` when the delivery attempt did not succeed. Events that a forwarder’s filter rejected are not recorded as deliveries.



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

def status
  @status
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_delivery.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_delivery.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_delivery.rb', line 75

def self.attribute_map
  {
    :'environment' => :'environment',
    :'forwarder' => :'forwarder',
    :'event' => :'event',
    :'attempt_number' => :'attempt_number',
    :'status' => :'status',
    :'request' => :'request',
    :'response_status' => :'response_status',
    :'response_body' => :'response_body',
    :'latency_ms' => :'latency_ms',
    :'error' => :'error',
    :'created_at' => :'created_at'
  }
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_delivery.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
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 119

def self.openapi_nullable
  Set.new([
    :'request',
    :'response_status',
    :'response_body',
    :'latency_ms',
    :'error',
    :'created_at'
  ])
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_delivery.rb', line 102

def self.openapi_types
  {
    :'environment' => :'String',
    :'forwarder' => :'String',
    :'event' => :'String',
    :'attempt_number' => :'Integer',
    :'status' => :'String',
    :'request' => :'Hash<String, Object>',
    :'response_status' => :'Integer',
    :'response_body' => :'String',
    :'latency_ms' => :'Integer',
    :'error' => :'String',
    :'created_at' => :'Time'
  }
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_delivery.rb', line 297

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      environment == o.environment &&
      forwarder == o.forwarder &&
      event == o.event &&
      attempt_number == o.attempt_number &&
      status == o.status &&
      request == o.request &&
      response_status == o.response_status &&
      response_body == o.response_body &&
      latency_ms == o.latency_ms &&
      error == o.error &&
      created_at == o.created_at
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_delivery.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_delivery.rb', line 321

def hash
  [environment, forwarder, event, attempt_number, status, request, response_status, response_body, latency_ms, error, created_at].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



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

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

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

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

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

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



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 233

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @environment.nil?
  return false if @forwarder.nil?
  return false if @event.nil?
  return false if @attempt_number.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["SUCCEEDED", "FAILED"])
  return false unless status_validator.valid?(@status)
  true
end