Class: SmplkitGeneratedClient::Audit::ForwarderDelivery

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

Overview

Read-only delivery log row. All fields are server-populated. Headers in “request“ always show redacted values, regardless of who configured them.

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



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

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

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

Returns the value of attribute attempt_number.



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

def attempt_number
  @attempt_number
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#error ⇒ Object

Returns the value of attribute error.



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

def error
  @error
end

#event_id ⇒ Object

Returns the value of attribute event_id.



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

def event_id
  @event_id
end

#forwarder_id ⇒ Object

Returns the value of attribute forwarder_id.



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

def forwarder_id
  @forwarder_id
end

#latency_ms ⇒ Object

Returns the value of attribute latency_ms.



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

def latency_ms
  @latency_ms
end

#request ⇒ Object

Returns the value of attribute request.



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

def request
  @request
end

#response_body ⇒ Object

Returns the value of attribute response_body.



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

def response_body
  @response_body
end

#response_status ⇒ Object

Returns the value of attribute response_status.



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

def response_status
  @response_status
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 83

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 62

def self.attribute_map
  {
    :'forwarder_id' => :'forwarder_id',
    :'event_id' => :'event_id',
    :'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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 291

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



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 104

def self.openapi_nullable
  Set.new([
    :'request',
    :'response_status',
    :'response_body',
    :'latency_ms',
    :'error',
    :'created_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 88

def self.openapi_types
  {
    :'forwarder_id' => :'String',
    :'event_id' => :'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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      forwarder_id == o.forwarder_id &&
      event_id == o.event_id &&
      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


278
279
280
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



284
285
286
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 284

def hash
  [forwarder_id, event_id, 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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 184

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

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 313

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



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb', line 208

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @forwarder_id.nil?
  return false if @event_id.nil?
  return false if @attempt_number.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["succeeded", "failed", "filtered_out", "skipped_do_not_forward"])
  return false unless status_validator.valid?(@status)
  true
end