class DatadogAPIClient::V1::MonitorUpdateRequest

Object describing a monitor update request.

Attributes

created[RW]

Timestamp of the monitor creation.

creator[RW]
deleted[RW]

Whether or not the monitor is deleted. (Always `null`)

id[RW]

ID of this monitor.

message[RW]

A message to include with notifications for this monitor.

modified[RW]

Last timestamp when the monitor was edited.

multi[RW]

Whether or not the monitor is broken down on different groups.

name[RW]

The monitor name.

options[RW]
overall_state[RW]
priority[RW]

Integer from 1 (high) to 5 (low) indicating alert severity.

query[RW]

The monitor query.

restricted_roles[RW]

A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option.

state[RW]
tags[RW]

Tags associated to your monitor.

type[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 88
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 66
def self.attribute_map
  {
    :'created' => :'created',
    :'creator' => :'creator',
    :'deleted' => :'deleted',
    :'id' => :'id',
    :'message' => :'message',
    :'modified' => :'modified',
    :'multi' => :'multi',
    :'name' => :'name',
    :'options' => :'options',
    :'overall_state' => :'overall_state',
    :'priority' => :'priority',
    :'query' => :'query',
    :'restricted_roles' => :'restricted_roles',
    :'state' => :'state',
    :'tags' => :'tags',
    :'type' => :'type'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 280
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 123
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::MonitorUpdateRequest` 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 `DatadogAPIClient::V1::MonitorUpdateRequest`. 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?(:'created')
    self.created = attributes[:'created']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 115
def self.openapi_nullable
  Set.new([
    :'deleted',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 93
def self.openapi_types
  {
    :'created' => :'Time',
    :'creator' => :'Creator',
    :'deleted' => :'Time',
    :'id' => :'Integer',
    :'message' => :'String',
    :'modified' => :'Time',
    :'multi' => :'Boolean',
    :'name' => :'String',
    :'options' => :'MonitorOptions',
    :'overall_state' => :'MonitorOverallStates',
    :'priority' => :'Integer',
    :'query' => :'String',
    :'restricted_roles' => :'Array<String>',
    :'state' => :'MonitorState',
    :'tags' => :'Array<String>',
    :'type' => :'MonitorType'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 244
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      creator == o.creator &&
      deleted == o.deleted &&
      id == o.id &&
      message == o.message &&
      modified == o.modified &&
      multi == o.multi &&
      name == o.name &&
      options == o.options &&
      overall_state == o.overall_state &&
      priority == o.priority &&
      query == o.query &&
      restricted_roles == o.restricted_roles &&
      state == o.state &&
      tags == o.tags &&
      type == o.type
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 310
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 :Array
    # generic array, 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 = DatadogAPIClient::V1.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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/datadog_api_client/v1/models/monitor_update_request.rb, line 384
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 287
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 267
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 273
def hash
  [created, creator, deleted, id, message, modified, multi, name, options, overall_state, priority, query, restricted_roles, state, tags, type].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 207
def list_invalid_properties
  invalid_properties = Array.new
  if !@priority.nil? && @priority > 5
    invalid_properties.push('invalid value for "priority", must be smaller than or equal to 5.')
  end

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

  invalid_properties
end
priority=(priority) click to toggle source

Custom attribute writer method with validation @param [Object] priority Value to be assigned

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 230
def priority=(priority)
  if !priority.nil? && priority > 5
    fail ArgumentError, 'invalid value for "priority", must be smaller than or equal to 5.'
  end

  if !priority.nil? && priority < 1
    fail ArgumentError, 'invalid value for "priority", must be greater than or equal to 1.'
  end

  @priority = priority
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 360
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 366
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 354
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/datadog_api_client/v1/models/monitor_update_request.rb, line 222
def valid?
  return false if !@priority.nil? && @priority > 5
  return false if !@priority.nil? && @priority < 1
  true
end