class DatadogAPIClient::V1::EventCreateRequest
Object representing an event.
Attributes
An arbitrary string to use for aggregation. Limited to 100 characters. If you specify a key, all events using that key are grouped together in the Event
Stream.
POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 7 days.
A device name.
Host
name to associate with the event. Any tags associated with the host are also applied to this event.
Integer ID of the event.
Payload of the event.
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](docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with `%%% \n` and end the text block with `\n %%%`. Use `msg_text` with the Datadog Ruby library.
The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library.
URL of the event.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 83 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 63 def self.attribute_map { :'aggregation_key' => :'aggregation_key', :'alert_type' => :'alert_type', :'date_happened' => :'date_happened', :'device_name' => :'device_name', :'host' => :'host', :'id' => :'id', :'payload' => :'payload', :'priority' => :'priority', :'related_event_id' => :'related_event_id', :'source_type_name' => :'source_type_name', :'tags' => :'tags', :'text' => :'text', :'title' => :'title', :'url' => :'url' } end
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/event_create_request.rb, line 299 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 115 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::EventCreateRequest` 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::EventCreateRequest`. 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?(:'aggregation_key') self.aggregation_key = attributes[:'aggregation_key'] end if attributes.key?(:'alert_type') self.alert_type = attributes[:'alert_type'] end if attributes.key?(:'date_happened') self.date_happened = attributes[:'date_happened'] end if attributes.key?(:'device_name') self.device_name = attributes[:'device_name'] end if attributes.key?(:'host') self.host = attributes[:'host'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'payload') self.payload = attributes[:'payload'] end if attributes.key?(:'priority') self.priority = attributes[:'priority'] end if attributes.key?(:'related_event_id') self.related_event_id = attributes[:'related_event_id'] end if attributes.key?(:'source_type_name') self.source_type_name = attributes[:'source_type_name'] end if attributes.key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self.tags = value end end if attributes.key?(:'text') self.text = attributes[:'text'] end if attributes.key?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'url') self.url = attributes[:'url'] end end
List of attributes with nullable: true
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 108 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 88 def self.openapi_types { :'aggregation_key' => :'String', :'alert_type' => :'EventAlertType', :'date_happened' => :'Integer', :'device_name' => :'String', :'host' => :'String', :'id' => :'Integer', :'payload' => :'String', :'priority' => :'EventPriority', :'related_event_id' => :'Integer', :'source_type_name' => :'String', :'tags' => :'Array<String>', :'text' => :'String', :'title' => :'String', :'url' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 265 def ==(o) return true if self.equal?(o) self.class == o.class && aggregation_key == o.aggregation_key && alert_type == o.alert_type && date_happened == o.date_happened && device_name == o.device_name && host == o.host && id == o.id && payload == o.payload && priority == o.priority && related_event_id == o.related_event_id && source_type_name == o.source_type_name && tags == o.tags && text == o.text && title == o.title && url == o.url 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/datadog_api_client/v1/models/event_create_request.rb, line 329 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
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/event_create_request.rb, line 403 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
Custom attribute writer method with validation @param [Object] aggregation_key
Value to be assigned
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 227 def aggregation_key=(aggregation_key) if !aggregation_key.nil? && aggregation_key.to_s.length > 100 fail ArgumentError, 'invalid value for "aggregation_key", the character length must be smaller than or equal to 100.' end @aggregation_key = aggregation_key end
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/event_create_request.rb, line 306 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
@see the `==` method @param [Object] Object to be compared
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 286 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 292 def hash [aggregation_key, alert_type, date_happened, device_name, host, id, payload, priority, related_event_id, source_type_name, tags, text, title, url].hash end
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/event_create_request.rb, line 189 def list_invalid_properties invalid_properties = Array.new if !@aggregation_key.nil? && @aggregation_key.to_s.length > 100 invalid_properties.push('invalid value for "aggregation_key", the character length must be smaller than or equal to 100.') end if @text.nil? invalid_properties.push('invalid value for "text", text cannot be nil.') end if @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? invalid_properties.push('invalid value for "title", title cannot be nil.') end if @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
Custom attribute writer method with validation @param [Object] text Value to be assigned
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 237 def text=(text) if text.nil? fail ArgumentError, 'text cannot be nil' end if text.to_s.length > 4000 fail ArgumentError, 'invalid value for "text", the character length must be smaller than or equal to 4000.' end @text = text end
Custom attribute writer method with validation @param [Object] title Value to be assigned
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 251 def title=(title) if title.nil? fail ArgumentError, 'title cannot be nil' end if title.to_s.length > 100 fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 100.' end @title = title end
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/event_create_request.rb, line 385 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/datadog_api_client/v1/models/event_create_request.rb, line 373 def to_s to_hash.to_s end
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/event_create_request.rb, line 216 def valid? return false if !@aggregation_key.nil? && @aggregation_key.to_s.length > 100 return false if @text.nil? return false if @text.to_s.length > 4000 return false if @title.nil? return false if @title.to_s.length > 100 true end