Class: DatadogAPIClient::V2::LogsGroupBy

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

Overview

A group by rule

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/logs_group_by.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



44
45
46
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 44

def additional_properties
  @additional_properties
end

#facet ⇒ Object

The name of the facet to use (required)



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

def facet
  @facet
end

#histogram ⇒ Object

Used to perform a histogram computation (only for measure facets). Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.



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

def histogram
  @histogram
end

#limit ⇒ Object

The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed. If grouping by multiple facets, the product of limits must not exceed 10000.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 31

def limit
  @limit
end

#missing ⇒ Object

The value to use for logs that don't have the facet used to group by



36
37
38
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 36

def missing
  @missing
end

#sort ⇒ Object

A sort rule



39
40
41
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 39

def sort
  @sort
end

#total ⇒ Object

A resulting object to put the given computes in over all the matching records.



42
43
44
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 42

def total
  @total
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

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



162
163
164
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 162

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 69

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



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
231
232
233
234
235
236
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 192

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.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

#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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 169

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


149
150
151
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 149

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



118
119
120
121
122
123
124
125
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 118

def list_invalid_properties
  invalid_properties = Array.new
  if @facet.nil?
    invalid_properties.push('invalid value for "facet", facet 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



246
247
248
 
# File 'lib/datadog_api_client/v2/models/logs_group_by.rb', line 246

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

def to_s
  to_hash.to_s
end