Class: Falcon::DomainActionV1

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/models/domain_action_v1.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainActionV1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cid ⇒ Object

The ID of the customer who created the action



36
37
38
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 36

def cid
  @cid
end

#content_format ⇒ Object

The level of detail in which the content will be delivered. It can be either ‘standard’ or ‘enhanced’



39
40
41
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 39

def content_format
  @content_format
end

#created_timestamp ⇒ Object

The date when the action was created



42
43
44
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 42

def created_timestamp
  @created_timestamp
end

#frequency ⇒ Object

The time interval between the action’s triggers. It can be one of the values: ‘asap’, ‘daily’ or ‘weekly’



45
46
47
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 45

def frequency
  @frequency
end

#id ⇒ Object

The ID of the action



48
49
50
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 48

def id
  @id
end

#recipients ⇒ Object

The address list who will be notified by this action.



51
52
53
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 51

def recipients
  @recipients
end

#rule_id ⇒ Object

The ID of the rule on which this action is attached



54
55
56
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 54

def rule_id
  @rule_id
end

#status ⇒ Object

The action status. It can be either ‘enabled’ or ‘muted’.



57
58
59
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 57

def status
  @status
end

#trigger_matchless ⇒ Object

Whether to periodically trigger the action based on the frequency, even when there are no new matches for the associated monitoring rule



60
61
62
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 60

def trigger_matchless
  @trigger_matchless
end

#type ⇒ Object

The action type. The only type currently supported is ‘email’



63
64
65
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 63

def type
  @type
end

#updated_timestamp ⇒ Object

The date when the action was updated



66
67
68
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 66

def updated_timestamp
  @updated_timestamp
end

#user_uuid ⇒ Object

The UUID of the user who created the action



69
70
71
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 69

def user_uuid
  @user_uuid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 72

def self.attribute_map
  {
    :'cid' => :'cid',
    :'content_format' => :'content_format',
    :'created_timestamp' => :'created_timestamp',
    :'frequency' => :'frequency',
    :'id' => :'id',
    :'recipients' => :'recipients',
    :'rule_id' => :'rule_id',
    :'status' => :'status',
    :'trigger_matchless' => :'trigger_matchless',
    :'type' => :'type',
    :'updated_timestamp' => :'updated_timestamp',
    :'user_uuid' => :'user_uuid'
  }
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



291
292
293
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 291

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 113

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 95

def self.openapi_types
  {
    :'cid' => :'String',
    :'content_format' => :'String',
    :'created_timestamp' => :'Time',
    :'frequency' => :'String',
    :'id' => :'String',
    :'recipients' => :'Array<String>',
    :'rule_id' => :'String',
    :'status' => :'String',
    :'trigger_matchless' => :'Boolean',
    :'type' => :'String',
    :'updated_timestamp' => :'Time',
    :'user_uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 259

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cid == o.cid &&
      content_format == o.content_format &&
      created_timestamp == o.created_timestamp &&
      frequency == o.frequency &&
      id == o.id &&
      recipients == o.recipients &&
      rule_id == o.rule_id &&
      status == o.status &&
      trigger_matchless == o.trigger_matchless &&
      type == o.type &&
      updated_timestamp == o.updated_timestamp &&
      user_uuid == o.user_uuid
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



322
323
324
325
326
327
328
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
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 322

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 = Falcon.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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 393

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 298

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


278
279
280
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



284
285
286
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 284

def hash
  [cid, content_format, created_timestamp, frequency, id, recipients, rule_id, status, trigger_matchless, type, updated_timestamp, user_uuid].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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 186

def list_invalid_properties
  invalid_properties = Array.new
  if @cid.nil?
    invalid_properties.push('invalid value for "cid", cid cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

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

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



369
370
371
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 369

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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 375

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



363
364
365
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 363

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/crimson-falcon/models/domain_action_v1.rb', line 241

def valid?
  return false if @cid.nil?
  return false if @content_format.nil?
  return false if @created_timestamp.nil?
  return false if @frequency.nil?
  return false if @id.nil?
  return false if @recipients.nil?
  return false if @rule_id.nil?
  return false if @status.nil?
  return false if @trigger_matchless.nil?
  return false if @type.nil?
  return false if @updated_timestamp.nil?
  return false if @user_uuid.nil?
  true
end