Class: TogaiClient::EventSchema

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/models/event_schema.rb

Overview

Structure of an event schema

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EventSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/togai_client/models/event_schema.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attributes ⇒ Object

Returns the value of attribute attributes.



31
32
33
 
# File 'lib/togai_client/models/event_schema.rb', line 31

def attributes
  @attributes
end

#created_at ⇒ Object

Returns the value of attribute created_at.



46
47
48
 
# File 'lib/togai_client/models/event_schema.rb', line 46

def created_at
  @created_at
end

#description ⇒ Object

Description of the event



23
24
25
 
# File 'lib/togai_client/models/event_schema.rb', line 23

def description
  @description
end

#dimensions ⇒ Object

Returns the value of attribute dimensions.



33
34
35
 
# File 'lib/togai_client/models/event_schema.rb', line 33

def dimensions
  @dimensions
end

#enrichments ⇒ Object

Returns the value of attribute enrichments.



39
40
41
 
# File 'lib/togai_client/models/event_schema.rb', line 39

def enrichments
  @enrichments
end

#event_id_template ⇒ Object

Template used to generate event id based on event payload



42
43
44
 
# File 'lib/togai_client/models/event_schema.rb', line 42

def event_id_template
  @event_id_template
end

#event_level_revenue ⇒ Object

Returns the value of attribute event_level_revenue.



44
45
46
 
# File 'lib/togai_client/models/event_schema.rb', line 44

def event_level_revenue
  @event_level_revenue
end

#feature_details ⇒ Object

Returns the value of attribute feature_details.



37
38
39
 
# File 'lib/togai_client/models/event_schema.rb', line 37

def feature_details
  @feature_details
end

#filter_fields ⇒ Object

Returns the value of attribute filter_fields.



35
36
37
 
# File 'lib/togai_client/models/event_schema.rb', line 35

def filter_fields
  @filter_fields
end

#name ⇒ Object

Name of the event. Must be unique for an organization.



20
21
22
 
# File 'lib/togai_client/models/event_schema.rb', line 20

def name
  @name
end

#status ⇒ Object

Status of event schema * DRAFT - Schema is in draft state * ACTIVE - Schema is currently active * INACTIVE - Schema is currently inactive * ARCHIVED - Older version of event schema



29
30
31
 
# File 'lib/togai_client/models/event_schema.rb', line 29

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



48
49
50
 
# File 'lib/togai_client/models/event_schema.rb', line 48

def updated_at
  @updated_at
end

#version ⇒ Object

Version of event schema



26
27
28
 
# File 'lib/togai_client/models/event_schema.rb', line 26

def version
  @version
end

Class Method Details

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



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/togai_client/models/event_schema.rb', line 411

def self._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 = TogaiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/togai_client/models/event_schema.rb', line 92

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/togai_client/models/event_schema.rb', line 73

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'version' => :'version',
    :'status' => :'status',
    :'attributes' => :'attributes',
    :'dimensions' => :'dimensions',
    :'filter_fields' => :'filterFields',
    :'feature_details' => :'featureDetails',
    :'enrichments' => :'enrichments',
    :'event_id_template' => :'eventIdTemplate',
    :'event_level_revenue' => :'eventLevelRevenue',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt'
  }
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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/togai_client/models/event_schema.rb', line 387

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



116
117
118
119
 
# File 'lib/togai_client/models/event_schema.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/togai_client/models/event_schema.rb', line 97

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'version' => :'Integer',
    :'status' => :'String',
    :'attributes' => :'Array<EventAttributeSchema>',
    :'dimensions' => :'Array<DimensionsSchema>',
    :'filter_fields' => :'Array<String>',
    :'feature_details' => :'FeatureDetails',
    :'enrichments' => :'Enrichments',
    :'event_id_template' => :'String',
    :'event_level_revenue' => :'Boolean',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/togai_client/models/event_schema.rb', line 354

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      version == o.version &&
      status == o.status &&
      attributes == o.attributes &&
      dimensions == o.dimensions &&
      filter_fields == o.filter_fields &&
      feature_details == o.feature_details &&
      enrichments == o.enrichments &&
      event_id_template == o.event_id_template &&
      event_level_revenue == o.event_level_revenue &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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



482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/togai_client/models/event_schema.rb', line 482

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


374
375
376
 
# File 'lib/togai_client/models/event_schema.rb', line 374

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



380
381
382
 
# File 'lib/togai_client/models/event_schema.rb', line 380

def hash
  [name, description, version, status, attributes, dimensions, filter_fields, feature_details, enrichments, event_id_template, event_level_revenue, created_at, updated_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



201
202
203
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
233
234
235
236
237
238
 
# File 'lib/togai_client/models/event_schema.rb', line 201

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

  pattern = Regexp.new(/^[\sa-zA-Z0-9_-]*$/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

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

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

  if @version < 1
    invalid_properties.push('invalid value for "version", must be greater than or equal to 1.')
  end

  if !@attributes.nil? && @attributes.length > 50
    invalid_properties.push('invalid value for "attributes", number of items must be less than or equal to 50.')
  end

  if !@dimensions.nil? && @dimensions.length > 50
    invalid_properties.push('invalid value for "dimensions", number of items must be less than or equal to 50.')
  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



458
459
460
 
# File 'lib/togai_client/models/event_schema.rb', line 458

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



464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/togai_client/models/event_schema.rb', line 464

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



452
453
454
 
# File 'lib/togai_client/models/event_schema.rb', line 452

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/togai_client/models/event_schema.rb', line 242

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 50
  return false if @name !~ Regexp.new(/^[\sa-zA-Z0-9_-]*$/)
  return false if !@description.nil? && @description.to_s.length > 255
  return false if @version.nil?
  return false if @version < 1
  status_validator = EnumAttributeValidator.new('String', ["DRAFT", "ACTIVE", "INACTIVE", "ARCHIVED"])
  return false unless status_validator.valid?(@status)
  return false if !@attributes.nil? && @attributes.length > 50
  return false if !@dimensions.nil? && @dimensions.length > 50
  true
end