Class: CloudReactorAPIClient::EmailNotificationProfile

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

Overview

An EmailProfile contains settings for emailing notifications.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailNotificationProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 110

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

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

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

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

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

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

Instance Attribute Details

#bcc_addresses ⇒ Object

Returns the value of attribute bcc_addresses.



44
45
46
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 44

def bcc_addresses
  @bcc_addresses
end

#body_template ⇒ Object

Returns the value of attribute body_template.



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

def body_template
  @body_template
end

#cc_addresses ⇒ Object

Returns the value of attribute cc_addresses.



42
43
44
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 42

def cc_addresses
  @cc_addresses
end

#created_at ⇒ Object

Returns the value of attribute created_at.



36
37
38
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 36

def created_at
  @created_at
end

#created_by_group ⇒ Object

Returns the value of attribute created_by_group.



32
33
34
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 32

def created_by_group
  @created_by_group
end

#created_by_user ⇒ Object

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



30
31
32
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 30

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/email_notification_profile.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/email_notification_profile.rb', line 25

def description
  @description
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#run_environment ⇒ Object

Returns the value of attribute run_environment.



34
35
36
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 34

def run_environment
  @run_environment
end

#subject_template ⇒ Object

Returns the value of attribute subject_template.



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

def subject_template
  @subject_template
end

#to_addresses ⇒ Object

Returns the value of attribute to_addresses.



40
41
42
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 40

def to_addresses
  @to_addresses
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



38
39
40
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 38

def updated_at
  @updated_at
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#uuid ⇒ Object

Returns the value of attribute uuid.



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

def uuid
  @uuid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 72

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 51

def self.attribute_map
  {
    :'url' => :'url',
    :'uuid' => :'uuid',
    :'name' => :'name',
    :'description' => :'description',
    :'dashboard_url' => :'dashboard_url',
    :'created_by_user' => :'created_by_user',
    :'created_by_group' => :'created_by_group',
    :'run_environment' => :'run_environment',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'to_addresses' => :'to_addresses',
    :'cc_addresses' => :'cc_addresses',
    :'bcc_addresses' => :'bcc_addresses',
    :'subject_template' => :'subject_template',
    :'body_template' => :'body_template'
  }
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



309
310
311
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 309

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
102
103
104
105
106
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 77

def self.openapi_types
  {
    :'url' => :'String',
    :'uuid' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'dashboard_url' => :'String',
    :'created_by_user' => :'String',
    :'created_by_group' => :'Group',
    :'run_environment' => :'NameAndUuid',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'to_addresses' => :'Array<String>',
    :'cc_addresses' => :'Array<String>',
    :'bcc_addresses' => :'Array<String>',
    :'subject_template' => :'String',
    :'body_template' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 274

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 &&
      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 &&
      to_addresses == o.to_addresses &&
      cc_addresses == o.cc_addresses &&
      bcc_addresses == o.bcc_addresses &&
      subject_template == o.subject_template &&
      body_template == o.body_template
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



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
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 339

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 410

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 316

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


296
297
298
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 296

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



302
303
304
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 302

def hash
  [url, uuid, name, description, dashboard_url, created_by_user, created_by_group, run_environment, created_at, updated_at, to_addresses, cc_addresses, bcc_addresses, subject_template, body_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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 192

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

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

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



386
387
388
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 386

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 392

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



380
381
382
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 380

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



219
220
221
222
223
224
225
226
 
# File 'lib/cloudreactor_api_client/models/email_notification_profile.rb', line 219

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
  return false if !@subject_template.nil? && @subject_template.to_s.length > 1000
  return false if !@body_template.nil? && @body_template.to_s.length > 10000
  true
end