Class: OpsgenieSdk::CreateNotificationRulePayload

Inherits:
Object
  • Object
show all
Defined in:
lib/opsgenie_sdk/models/create_notification_rule_payload.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateNotificationRulePayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 78

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'actionType')
    self.action_type = attributes[:'actionType']
  end

  if attributes.has_key?(:'criteria')
    self.criteria = attributes[:'criteria']
  end

  if attributes.has_key?(:'notificationTime')
    if (value = attributes[:'notificationTime']).is_a?(Array)
      self.notification_time = value
    end
  end

  if attributes.has_key?(:'timeRestriction')
    self.time_restriction = attributes[:'timeRestriction']
  end

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

  if attributes.has_key?(:'order')
    self.order = attributes[:'order']
  end

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

  if attributes.has_key?(:'repeat')
    self.repeat = attributes[:'repeat']
  end

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

Instance Attribute Details

#action_type ⇒ Object

Returns the value of attribute action_type.



20
21
22
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 20

def action_type
  @action_type
end

#criteria ⇒ Object

Returns the value of attribute criteria.



22
23
24
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 22

def criteria
  @criteria
end

#enabled ⇒ Object

Defines if notification rule will be enabled or not when it is created



42
43
44
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 42

def enabled
  @enabled
end

#name ⇒ Object

Name of the notification rule



18
19
20
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 18

def name
  @name
end

#notification_time ⇒ Object

List of Time Periods that notification for schedule start/end will be sent



25
26
27
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 25

def notification_time
  @notification_time
end

#order ⇒ Object

The order of the notification rule within the notification rules with the same action type



34
35
36
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 34

def order
  @order
end

#repeat ⇒ Object

Returns the value of attribute repeat.



39
40
41
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 39

def repeat
  @repeat
end

#schedules ⇒ Object

List of schedules that notification rule will be applied when on call of that schedule starts/ends. This field is valid for Schedule Start/End rules



31
32
33
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 31

def schedules
  @schedules
end

#steps ⇒ Object

List of steps that will be added to notification rule



37
38
39
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 37

def steps
  @steps
end

#time_restriction ⇒ Object

Time interval that notification rule will work



28
29
30
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 28

def time_restriction
  @time_restriction
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 45

def self.attribute_map
  {
    :'name' => :'name',
    :'action_type' => :'actionType',
    :'criteria' => :'criteria',
    :'notification_time' => :'notificationTime',
    :'time_restriction' => :'timeRestriction',
    :'schedules' => :'schedules',
    :'order' => :'order',
    :'steps' => :'steps',
    :'repeat' => :'repeat',
    :'enabled' => :'enabled'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 61

def self.swagger_types
  {
    :'name' => :'String',
    :'action_type' => :'NotificationActionType',
    :'criteria' => :'Filter',
    :'notification_time' => :'Array<NotifyTime>',
    :'time_restriction' => :'TimeRestrictionInterval',
    :'schedules' => :'Array<ScheduleRecipient>',
    :'order' => :'Integer',
    :'steps' => :'Array<CreateNotificationRuleStepPayload>',
    :'repeat' => :'NotificationRepeat',
    :'enabled' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      action_type == o.action_type &&
      criteria == o.criteria &&
      notification_time == o.notification_time &&
      time_restriction == o.time_restriction &&
      schedules == o.schedules &&
      order == o.order &&
      steps == o.steps &&
      repeat == o.repeat &&
      enabled == o.enabled
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 227

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = OpsgenieSdk.const_get(type).new
    temp_model.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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 293

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 206

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


193
194
195
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 199

def hash
  [name, action_type, criteria, notification_time, time_restriction, schedules, order, steps, repeat, enabled].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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 133

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

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

  if !@order.nil? && @order < 0
    invalid_properties.push('invalid value for "order", must be greater than or equal to 0.')
  end

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



273
274
275
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 273

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



279
280
281
282
283
284
285
286
287
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 279

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



267
268
269
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 267

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



156
157
158
159
160
161
162
 
# File 'lib/opsgenie_sdk/models/create_notification_rule_payload.rb', line 156

def valid?
  return false if @name.nil?
  return false if @action_type.nil?
  return false if !@order.nil? && @order < 0
  return false if @enabled.nil?
  true
end