Class: SmplkitGeneratedClient::Audit::Forwarder

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

Overview

Public-facing forwarder resource. Attribute set on POST /api/v1/forwarders: - name (required) - forwarder_type (required) - http (required) - enabled (optional, defaults true) - filter (optional, JSON Logic) - transform (optional, JSONata) The slug is server-derived from name on create; it is immutable on update because consumers (UI, observability) key off it.

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



104
105
106
107
108
109
110
111
112
113
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
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
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 104

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#data ⇒ Object

Returns the value of attribute data.



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

def data
  @data
end

#deleted_at ⇒ Object

Returns the value of attribute deleted_at.



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

def deleted_at
  @deleted_at
end

#enabled ⇒ Object

Returns the value of attribute enabled.



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

def enabled
  @enabled
end

#filter ⇒ Object

Returns the value of attribute filter.



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

def filter
  @filter
end

#forwarder_type ⇒ Object

Returns the value of attribute forwarder_type.



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

def forwarder_type
  @forwarder_type
end

#http ⇒ Object

Returns the value of attribute http.



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

def http
  @http
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#slug ⇒ Object

Returns the value of attribute slug.



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

def slug
  @slug
end

#transform ⇒ Object

Returns the value of attribute transform.



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

def transform
  @transform
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



62
63
64
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 62

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 44

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',
    :'data' => :'data'
  }
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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 315

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 283

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 &&
      data == o.data
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


302
303
304
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 308

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



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

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 337

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



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb', line 217

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 @forwarder_type.to_s.length < 1
  return false if !@transform.nil? && @transform.to_s.length > 16384
  return false if @http.nil?
  true
end