Class: TogaiClient::Alert

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Alert

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/togai_client/models/alert.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#alert_template_id ⇒ Object

Alert Template Id



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

def alert_template_id
  @alert_template_id
end

#created_at ⇒ Object

Created At



45
46
47
 
# File 'lib/togai_client/models/alert.rb', line 45

def created_at
  @created_at
end

#description ⇒ Object

Alert Description



25
26
27
 
# File 'lib/togai_client/models/alert.rb', line 25

def description
  @description
end

#entity_details ⇒ Object

Returns the value of attribute entity_details.



38
39
40
 
# File 'lib/togai_client/models/alert.rb', line 38

def entity_details
  @entity_details
end

#id ⇒ Object

Alert ID



19
20
21
 
# File 'lib/togai_client/models/alert.rb', line 19

def id
  @id
end

#interval ⇒ Object

Interval



36
37
38
 
# File 'lib/togai_client/models/alert.rb', line 36

def interval
  @interval
end

#owner_details ⇒ Object

Returns the value of attribute owner_details.



40
41
42
 
# File 'lib/togai_client/models/alert.rb', line 40

def owner_details
  @owner_details
end

#parameters ⇒ Object

Returns the value of attribute parameters.



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

def parameters
  @parameters
end

#status ⇒ Object

Returns the value of attribute status.



27
28
29
 
# File 'lib/togai_client/models/alert.rb', line 27

def status
  @status
end

#updated_at ⇒ Object

Updated At



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

def updated_at
  @updated_at
end

#validity ⇒ Object

Validity of the alert in minutes, if null then alert will be valid forever



30
31
32
 
# File 'lib/togai_client/models/alert.rb', line 30

def validity
  @validity
end

#version ⇒ Object

Alert Version



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

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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/togai_client/models/alert.rb', line 304

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



91
92
93
 
# File 'lib/togai_client/models/alert.rb', line 91

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

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'description' => :'description',
    :'status' => :'status',
    :'validity' => :'validity',
    :'alert_template_id' => :'alertTemplateId',
    :'interval' => :'interval',
    :'entity_details' => :'entityDetails',
    :'owner_details' => :'ownerDetails',
    :'parameters' => :'parameters',
    :'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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/togai_client/models/alert.rb', line 280

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



114
115
116
117
 
# File 'lib/togai_client/models/alert.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'version' => :'Integer',
    :'description' => :'String',
    :'status' => :'AlertStatus',
    :'validity' => :'Integer',
    :'alert_template_id' => :'String',
    :'interval' => :'Integer',
    :'entity_details' => :'Hash<String, Object>',
    :'owner_details' => :'Hash<String, Object>',
    :'parameters' => :'Hash<String, Object>',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/togai_client/models/alert.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      description == o.description &&
      status == o.status &&
      validity == o.validity &&
      alert_template_id == o.alert_template_id &&
      interval == o.interval &&
      entity_details == o.entity_details &&
      owner_details == o.owner_details &&
      parameters == o.parameters &&
      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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/togai_client/models/alert.rb', line 375

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


267
268
269
 
# File 'lib/togai_client/models/alert.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



273
274
275
 
# File 'lib/togai_client/models/alert.rb', line 273

def hash
  [id, version, description, status, validity, alert_template_id, interval, entity_details, owner_details, parameters, 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



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

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

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

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

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

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

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



351
352
353
 
# File 'lib/togai_client/models/alert.rb', line 351

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



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

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



345
346
347
 
# File 'lib/togai_client/models/alert.rb', line 345

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



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/togai_client/models/alert.rb', line 235

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @version.nil?
  return false if @status.nil?
  return false if @alert_template_id.nil?
  return false if @interval.nil?
  return false if @created_at.nil?
  true
end