Class: DatadogAPIClient::V2::MetricTagConfigurationCreateAttributes

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

Overview

Object containing the definition of a metric tag configuration to be created.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



57
58
59
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 57

def additional_properties
  @additional_properties
end

#aggregations ⇒ Object

A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available:

  • time: avg, space: avg
  • time: avg, space: max
  • time: avg, space: min
  • time: avg, space: sum
  • time: count, space: sum
  • time: max, space: max
  • time: min, space: min
  • time: sum, space: avg
  • time: sum, space: sum

Can only be applied to non_distribution metrics that have a metric_type of count, rate, or gauge.



26
27
28
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 26

def aggregations
  @aggregations
end

#exclude_tags_mode ⇒ Object

When set to true, the configuration will exclude the configured tags and include any other submitted tags. When set to false, the configuration will include the configured tags and exclude any other submitted tags. Defaults to false. Requires tags property.



45
46
47
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 45

def exclude_tags_mode
  @exclude_tags_mode
end

#include_percentiles ⇒ Object

Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a metric_type of distribution.



29
30
31
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 29

def include_percentiles
  @include_percentiles
end

#metric_type ⇒ Object

The metric's type.



52
53
54
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 52

def metric_type
  @metric_type
end

#tags ⇒ Object

A list of tag keys that will be queryable for your metric.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 34

def tags
  @tags
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 47

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



156
157
158
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 156

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 62

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 186

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::V2.const_get(type)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V2::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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 264

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 163

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


143
144
145
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 143

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 109

def list_invalid_properties
  invalid_properties = Array.new
  if @metric_type.nil?
    invalid_properties.push('invalid value for "metric_type", metric_type cannot be nil.')
  end

  if @tags.nil?
    invalid_properties.push('invalid value for "tags", tags cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



240
241
242
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 240

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



234
235
236
 
# File 'lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb', line 234

def to_s
  to_hash.to_s
end