class DatadogAPIClient::V1::MetricMetadata
Object with all metric related metadata.
Attributes
Metric description.
Name of the integration that sent the metric if applicable.
Per unit of the metric such as `second` in `bytes per second`.
A more human-readable and abbreviated version of the metric name.
StatsD flush interval of the metric in seconds if applicable.
Metric type such as `gauge` or `rate`.
Primary unit of the metric such as `byte` or `operation`.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/datadog_api_client/v1/models/metric_metadata.rb, line 57 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/metric_metadata.rb, line 44 def self.attribute_map { :'description' => :'description', :'integration' => :'integration', :'per_unit' => :'per_unit', :'short_name' => :'short_name', :'statsd_interval' => :'statsd_interval', :'type' => :'type', :'unit' => :'unit' } 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/metric_metadata.rb, line 166 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/metric_metadata.rb, line 82 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::MetricMetadata` 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::MetricMetadata`. 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?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'integration') self.integration = attributes[:'integration'] end if attributes.key?(:'per_unit') self.per_unit = attributes[:'per_unit'] end if attributes.key?(:'short_name') self.short_name = attributes[:'short_name'] end if attributes.key?(:'statsd_interval') self.statsd_interval = attributes[:'statsd_interval'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'unit') self.unit = attributes[:'unit'] end end
List of attributes with nullable: true
# File lib/datadog_api_client/v1/models/metric_metadata.rb, line 75 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/datadog_api_client/v1/models/metric_metadata.rb, line 62 def self.openapi_types { :'description' => :'String', :'integration' => :'String', :'per_unit' => :'String', :'short_name' => :'String', :'statsd_interval' => :'Integer', :'type' => :'String', :'unit' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/datadog_api_client/v1/models/metric_metadata.rb, line 139 def ==(o) return true if self.equal?(o) self.class == o.class && description == o.description && integration == o.integration && per_unit == o.per_unit && short_name == o.short_name && statsd_interval == o.statsd_interval && type == o.type && unit == o.unit 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/metric_metadata.rb, line 196 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/metric_metadata.rb, line 270 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/datadog_api_client/v1/models/metric_metadata.rb, line 173 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/metric_metadata.rb, line 153 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/datadog_api_client/v1/models/metric_metadata.rb, line 159 def hash [description, integration, per_unit, short_name, statsd_interval, type, unit].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/metric_metadata.rb, line 126 def list_invalid_properties invalid_properties = Array.new invalid_properties 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/metric_metadata.rb, line 252 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/metric_metadata.rb, line 240 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/metric_metadata.rb, line 133 def valid? true end