Class: DatadogAPIClient::V1::EventCreateResponse

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/event_create_response.rb

Overview

Object containing an event response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsedObject

whether the object has unparsed attributes



23
24
25
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 23

def _unparsed
  @_unparsed
end

#alert_typeObject

Returns the value of attribute alert_type.



25
26
27
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 25

def alert_type
  @alert_type
end

#date_happenedObject

POSIX timestamp of the event. Must be sent as an integer (that is no quotes). Limited to events no older than 7 days.



28
29
30
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 28

def date_happened
  @date_happened
end

#device_nameObject

A device name.



31
32
33
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 31

def device_name
  @device_name
end

#eventObject

Object representing an event.



25
26
27
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 25

def event
  @event
end

#hostObject

Host name to associate with the event. Any tags associated with the host are also applied to this event.



34
35
36
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 34

def host
  @host
end

#idObject

Integer ID of the event.



37
38
39
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 37

def id
  @id
end

#payloadObject

Payload of the event.



40
41
42
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 40

def payload
  @payload
end

#priorityObject

Returns the value of attribute priority.



42
43
44
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 42

def priority
  @priority
end

ID of the parent event. Must be sent as an integer (that is no quotes).



45
46
47
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 45

def related_event_id
  @related_event_id
end

#source_type_nameObject

The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values available here.



48
49
50
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 48

def source_type_name
  @source_type_name
end

#statusObject

A status.



51
52
53
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 51

def status
  @status
end

#tagsObject

A list of tags to apply to the event.



54
55
56
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 54

def tags
  @tags
end

#textObject

The body of the event. Limited to 4000 characters. The text supports markdown. Use msg_text with the Datadog Ruby library.



57
58
59
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 57

def text
  @text
end

#titleObject

The event title. Limited to 100 characters. Use msg_title with the Datadog Ruby library.



60
61
62
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 60

def title
  @title
end

#urlObject

URL of the event.



63
64
65
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 63

def url
  @url
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



86
87
88
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 86

def self.acceptable_attributes
  attribute_map.values
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



269
270
271
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 269

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

.openapi_nullableObject

List of attributes with nullable: true



111
112
113
114
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 111

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

Instance Method Details

#_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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 299

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)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V1::UnparsedObject
      self._unparsed = true
    end
    res
  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



377
378
379
380
381
382
383
384
385
386
387
388
389
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 377

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 276

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


256
257
258
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 256

def eql?(o)
  self == o
end

#list_invalid_propertiesObject

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
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 192

def list_invalid_properties
  invalid_properties = Array.new
  if !@text.nil? && @text.to_s.length > 4000
    invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 4000.')
  end

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



353
354
355
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 353

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 359

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



347
348
349
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 347

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



207
208
209
210
211
# File 'lib/datadog_api_client/v1/models/event_create_response.rb', line 207

def valid?
  return false if !@text.nil? && @text.to_s.length > 4000
  return false if !@title.nil? && @title.to_s.length > 100
  true
end