Class: TogaiClient::UpdateEventSchemaRequest

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

Overview

Request to update event schema

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateEventSchemaRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 71

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

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

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

Instance Attribute Details

#attributes ⇒ Object

Returns the value of attribute attributes.



22
23
24
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 22

def attributes
  @attributes
end

#description ⇒ Object

Description of the event



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

def description
  @description
end

#dimensions ⇒ Object

Returns the value of attribute dimensions.



24
25
26
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 24

def dimensions
  @dimensions
end

#enrichments ⇒ Object

Returns the value of attribute enrichments.



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

def enrichments
  @enrichments
end

#event_id_template ⇒ Object

Template used to generate event id based on event payload



32
33
34
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 32

def event_id_template
  @event_id_template
end

#filter_fields ⇒ Object

List of fields that can be used for filtering in usage meter



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

def filter_fields
  @filter_fields
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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 249

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



47
48
49
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 47

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 35

def self.attribute_map
  {
    :'description' => :'description',
    :'attributes' => :'attributes',
    :'dimensions' => :'dimensions',
    :'enrichments' => :'enrichments',
    :'filter_fields' => :'filterFields',
    :'event_id_template' => :'eventIdTemplate'
  }
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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 225

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



64
65
66
67
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 52

def self.openapi_types
  {
    :'description' => :'String',
    :'attributes' => :'Array<EventAttributeSchema>',
    :'dimensions' => :'Array<DimensionsSchema>',
    :'enrichments' => :'Enrichments',
    :'filter_fields' => :'Array<String>',
    :'event_id_template' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 199

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 320

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


212
213
214
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



218
219
220
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 218

def hash
  [description, attributes, dimensions, enrichments, filter_fields, event_id_template].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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 117

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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 !@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



296
297
298
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 302

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



290
291
292
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 290

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



137
138
139
140
141
142
143
 
# File 'lib/togai_client/models/update_event_schema_request.rb', line 137

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@description.nil? && @description.to_s.length > 255
  return false if !@attributes.nil? && @attributes.length > 50
  return false if !@dimensions.nil? && @dimensions.length > 50
  true
end