class OpsgenieSdk::AlertPolicy
Attributes
Alias of the alert. You can use {{alias}} to refer to the original alias. Default value is {{alias}}
Alert
actions as a list of strings to add to the alerts original actions value. If ignoreOriginalActions field is set to true, this will replace the original actions.
Will continue with other modify policies if set to true
Description of the alert. You can use {{description}} to refer to the original alert description. Default value is {{description}}
Custom properties to add to the alerts original details value as a list of strings. If ignoreOriginalDetails field is set to true, this will replace the original details.
Activity status of the alert policy
Entity field of the alert. You can use {{entity}} to refer to the original entity. Default value is {{entity}}
Conditions specified in this field must be met for this policy to work
If set to true, policy will ignore the original details of the alert. Default value is false
If set to true, policy will ignore the original responders of the alert. Default value is false
If set to true, policy will ignore the original teams of the alert. Default value is false
Message of the alert
Name of the policy
Description of the policy
Priority level of the alert
Responders to add to the alerts original responders value as a list of teams or users. If ignoreOriginalResponders field is set to true, this will replace the original responders.
Source field of the alert. You can use {{source}} to refer to the original source. Default value is {{source}}
TeamId of the policy
Time restrictions specified in this field must be met for this policy to work
Type of the policy
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/opsgenie_sdk/models/alert_policy.rb, line 110 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'policy_description' => :'policyDescription', :'team_id' => :'teamId', :'filter' => :'filter', :'time_restrictions' => :'timeRestrictions', :'enabled' => :'enabled', :'type' => :'type', :'ignore_original_actions' => :'ignoreOriginalActions', :'ignore_original_details' => :'ignoreOriginalDetails', :'ignore_original_responders' => :'ignoreOriginalResponders', :'ignore_original_tags' => :'ignoreOriginalTags', :'ignore_original_teams' => :'ignoreOriginalTeams', :'continue' => :'continue', :'_alias' => :'alias', :'description' => :'description', :'entity' => :'entity', :'message' => :'message', :'source' => :'source', :'actions' => :'actions', :'responders' => :'responders', :'tags' => :'tags', :'details' => :'details', :'priority' => :'priority' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/opsgenie_sdk/models/alert_policy.rb, line 171 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'policyDescription') self.policy_description = attributes[:'policyDescription'] end if attributes.has_key?(:'teamId') self.team_id = attributes[:'teamId'] end if attributes.has_key?(:'filter') self.filter = attributes[:'filter'] end if attributes.has_key?(:'timeRestrictions') self.time_restrictions = attributes[:'timeRestrictions'] end if attributes.has_key?(:'enabled') self.enabled = attributes[:'enabled'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'ignoreOriginalActions') self.ignore_original_actions = attributes[:'ignoreOriginalActions'] end if attributes.has_key?(:'ignoreOriginalDetails') self.ignore_original_details = attributes[:'ignoreOriginalDetails'] end if attributes.has_key?(:'ignoreOriginalResponders') self.ignore_original_responders = attributes[:'ignoreOriginalResponders'] end if attributes.has_key?(:'ignoreOriginalTags') self.ignore_original_tags = attributes[:'ignoreOriginalTags'] end if attributes.has_key?(:'ignoreOriginalTeams') self.ignore_original_teams = attributes[:'ignoreOriginalTeams'] end if attributes.has_key?(:'continue') self.continue = attributes[:'continue'] end if attributes.has_key?(:'alias') self._alias = attributes[:'alias'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'entity') self.entity = attributes[:'entity'] end if attributes.has_key?(:'message') self.message = attributes[:'message'] end if attributes.has_key?(:'source') self.source = attributes[:'source'] end if attributes.has_key?(:'actions') if (value = attributes[:'actions']).is_a?(Array) self.actions = value end end if attributes.has_key?(:'responders') if (value = attributes[:'responders']).is_a?(Array) self.responders = value end end if attributes.has_key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self.tags = value end end if attributes.has_key?(:'details') if (value = attributes[:'details']).is_a?(Hash) self.details = value end end if attributes.has_key?(:'priority') self.priority = attributes[:'priority'] end end
Attribute type mapping.
# File lib/opsgenie_sdk/models/alert_policy.rb, line 140 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'policy_description' => :'String', :'team_id' => :'String', :'filter' => :'Filter', :'time_restrictions' => :'TimeRestrictionInterval', :'enabled' => :'BOOLEAN', :'type' => :'String', :'ignore_original_actions' => :'BOOLEAN', :'ignore_original_details' => :'BOOLEAN', :'ignore_original_responders' => :'BOOLEAN', :'ignore_original_tags' => :'BOOLEAN', :'ignore_original_teams' => :'BOOLEAN', :'continue' => :'BOOLEAN', :'_alias' => :'String', :'description' => :'String', :'entity' => :'String', :'message' => :'String', :'source' => :'String', :'actions' => :'Array<String>', :'responders' => :'Array<Responder>', :'tags' => :'Array<String>', :'details' => :'Hash<String, String>', :'priority' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/opsgenie_sdk/models/alert_policy.rb, line 326 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && policy_description == o.policy_description && team_id == o.team_id && filter == o.filter && time_restrictions == o.time_restrictions && enabled == o.enabled && type == o.type && ignore_original_actions == o.ignore_original_actions && ignore_original_details == o.ignore_original_details && ignore_original_responders == o.ignore_original_responders && ignore_original_tags == o.ignore_original_tags && ignore_original_teams == o.ignore_original_teams && continue == o.continue && _alias == o._alias && description == o.description && entity == o.entity && message == o.message && source == o.source && actions == o.actions && responders == o.responders && tags == o.tags && details == o.details && priority == o.priority end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/opsgenie_sdk/models/alert_policy.rb, line 391 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/opsgenie_sdk/models/alert_policy.rb, line 457 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/opsgenie_sdk/models/alert_policy.rb, line 370 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
@see the `==` method @param [Object] Object to be compared
# File lib/opsgenie_sdk/models/alert_policy.rb, line 357 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/opsgenie_sdk/models/alert_policy.rb, line 363 def hash [id, name, policy_description, team_id, filter, time_restrictions, enabled, type, ignore_original_actions, ignore_original_details, ignore_original_responders, ignore_original_tags, ignore_original_teams, continue, _alias, description, entity, message, source, actions, responders, tags, details, priority].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/opsgenie_sdk/models/alert_policy.rb, line 284 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] priority Object to be assigned
# File lib/opsgenie_sdk/models/alert_policy.rb, line 316 def priority=(priority) validator = EnumAttributeValidator.new('String', ['P1', 'P2', 'P3', 'P4', 'P5']) unless validator.valid?(priority) fail ArgumentError, 'invalid value for "priority", must be one of #{validator.allowable_values}.' end @priority = priority end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/opsgenie_sdk/models/alert_policy.rb, line 443 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/opsgenie_sdk/models/alert_policy.rb, line 431 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/opsgenie_sdk/models/alert_policy.rb, line 306 def type=(type) validator = EnumAttributeValidator.new('String', ['alert', 'notification']) unless validator.valid?(type) fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.' end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/opsgenie_sdk/models/alert_policy.rb, line 295 def valid? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ['alert', 'notification']) return false unless type_validator.valid?(@type) priority_validator = EnumAttributeValidator.new('String', ['P1', 'P2', 'P3', 'P4', 'P5']) return false unless priority_validator.valid?(@priority) true end