Class: CloudReactorAPIClient::AlertMethod

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudreactor_api_client/models/alert_method.rb

Overview

An AlertMethod specifies one or more configured methods of notifying users or external sources of events that trigger when one or more conditions are satisfied.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlertMethod

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 119

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#created_at ⇒ Object

Returns the value of attribute created_at.



52
53
54
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 52

def created_at
  @created_at
end

#created_by_group ⇒ Object

Returns the value of attribute created_by_group.



48
49
50
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 48

def created_by_group
  @created_by_group
end

#created_by_user ⇒ Object

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.



46
47
48
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 46

def created_by_user
  @created_by_user
end

#dashboard_url ⇒ Object

Returns the value of attribute dashboard_url.



27
28
29
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 27

def dashboard_url
  @dashboard_url
end

#description ⇒ Object

Returns the value of attribute description.



25
26
27
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 25

def description
  @description
end

#enabled ⇒ Object

Returns the value of attribute enabled.



29
30
31
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 29

def enabled
  @enabled
end

#error_severity_on_missing_execution ⇒ Object

Returns the value of attribute error_severity_on_missing_execution.



39
40
41
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 39

def error_severity_on_missing_execution
  @error_severity_on_missing_execution
end

#error_severity_on_missing_heartbeat ⇒ Object

Returns the value of attribute error_severity_on_missing_heartbeat.



41
42
43
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 41

def error_severity_on_missing_heartbeat
  @error_severity_on_missing_heartbeat
end

#error_severity_on_service_down ⇒ Object

Returns the value of attribute error_severity_on_service_down.



43
44
45
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 43

def error_severity_on_service_down
  @error_severity_on_service_down
end

#method_details ⇒ Object

Returns the value of attribute method_details.



31
32
33
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 31

def method_details
  @method_details
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 23

def name
  @name
end

#notify_on_failure ⇒ Object

Returns the value of attribute notify_on_failure.



35
36
37
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 35

def notify_on_failure
  @notify_on_failure
end

#notify_on_success ⇒ Object

Returns the value of attribute notify_on_success.



33
34
35
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 33

def notify_on_success
  @notify_on_success
end

#notify_on_timeout ⇒ Object

Returns the value of attribute notify_on_timeout.



37
38
39
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 37

def notify_on_timeout
  @notify_on_timeout
end

#run_environment ⇒ Object

Returns the value of attribute run_environment.



50
51
52
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 50

def run_environment
  @run_environment
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



54
55
56
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 54

def updated_at
  @updated_at
end

#url ⇒ Object

Returns the value of attribute url.



19
20
21
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 19

def url
  @url
end

#uuid ⇒ Object

Returns the value of attribute uuid.



21
22
23
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 21

def uuid
  @uuid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 57

def self.attribute_map
  {
    :'url' => :'url',
    :'uuid' => :'uuid',
    :'name' => :'name',
    :'description' => :'description',
    :'dashboard_url' => :'dashboard_url',
    :'enabled' => :'enabled',
    :'method_details' => :'method_details',
    :'notify_on_success' => :'notify_on_success',
    :'notify_on_failure' => :'notify_on_failure',
    :'notify_on_timeout' => :'notify_on_timeout',
    :'error_severity_on_missing_execution' => :'error_severity_on_missing_execution',
    :'error_severity_on_missing_heartbeat' => :'error_severity_on_missing_heartbeat',
    :'error_severity_on_service_down' => :'error_severity_on_service_down',
    :'created_by_user' => :'created_by_user',
    :'created_by_group' => :'created_by_group',
    :'run_environment' => :'run_environment',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_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



299
300
301
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 299

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
114
115
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 110

def self.openapi_nullable
  Set.new([
    :'created_by_group',
    :'run_environment',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 86

def self.openapi_types
  {
    :'url' => :'String',
    :'uuid' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'dashboard_url' => :'String',
    :'enabled' => :'Boolean',
    :'method_details' => :'Hash<String, Object>',
    :'notify_on_success' => :'Boolean',
    :'notify_on_failure' => :'Boolean',
    :'notify_on_timeout' => :'Boolean',
    :'error_severity_on_missing_execution' => :'NotificationSeverity',
    :'error_severity_on_missing_heartbeat' => :'NotificationSeverity',
    :'error_severity_on_service_down' => :'NotificationSeverity',
    :'created_by_user' => :'String',
    :'created_by_group' => :'Group',
    :'run_environment' => :'NameAndUuid',
    :'created_at' => :'Time',
    :'updated_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
275
276
277
278
279
280
281
282
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      uuid == o.uuid &&
      name == o.name &&
      description == o.description &&
      dashboard_url == o.dashboard_url &&
      enabled == o.enabled &&
      method_details == o.method_details &&
      notify_on_success == o.notify_on_success &&
      notify_on_failure == o.notify_on_failure &&
      notify_on_timeout == o.notify_on_timeout &&
      error_severity_on_missing_execution == o.error_severity_on_missing_execution &&
      error_severity_on_missing_heartbeat == o.error_severity_on_missing_heartbeat &&
      error_severity_on_service_down == o.error_severity_on_service_down &&
      created_by_user == o.created_by_user &&
      created_by_group == o.created_by_group &&
      run_environment == o.run_environment &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 329

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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 400

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

#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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 306

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


286
287
288
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



292
293
294
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 292

def hash
  [url, uuid, name, description, dashboard_url, enabled, method_details, notify_on_success, notify_on_failure, notify_on_timeout, error_severity_on_missing_execution, error_severity_on_missing_heartbeat, error_severity_on_service_down, created_by_user, created_by_group, run_environment, 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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 209

def list_invalid_properties
  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 !@description.nil? && @description.to_s.length > 5000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 5000.')
  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



376
377
378
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 376

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 382

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



370
371
372
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 370

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



228
229
230
231
232
233
 
# File 'lib/cloudreactor_api_client/models/alert_method.rb', line 228

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 200
  return false if !@description.nil? && @description.to_s.length > 5000
  true
end