Class: DatadogAPIClient::V1::ToplistWidgetRequest

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

Overview

Updated top list widget.

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/v1/models/toplist_widget_request.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



72
73
74
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 72

def additional_properties
  @additional_properties
end

#apm_query ⇒ Object

The log query.



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

def apm_query
  @apm_query
end

#audit_query ⇒ Object

The log query.



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

def audit_query
  @audit_query
end

#conditional_formats ⇒ Object

List of conditional formats.



30
31
32
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 30

def conditional_formats
  @conditional_formats
end

#event_query ⇒ Object

The log query.



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

def event_query
  @event_query
end

#formulas ⇒ Object

List of formulas that operate on queries.



35
36
37
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 35

def formulas
  @formulas
end

#log_query ⇒ Object

The log query.



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

def log_query
  @log_query
end

#network_query ⇒ Object

The log query.



43
44
45
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 43

def network_query
  @network_query
end

#process_query ⇒ Object

The process query to use in the widget.



46
47
48
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 46

def process_query
  @process_query
end

#profile_metrics_query ⇒ Object

The log query.



49
50
51
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 49

def profile_metrics_query
  @profile_metrics_query
end

#q ⇒ Object

Widget query.



46
47
48
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 46

def q
  @q
end

#queries ⇒ Object

List of queries that can be returned directly or used in formulas.



49
50
51
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 49

def queries
  @queries
end

#response_format ⇒ Object

Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.



58
59
60
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 58

def response_format
  @response_format
end

#rum_query ⇒ Object

The log query.



61
62
63
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 61

def rum_query
  @rum_query
end

#security_query ⇒ Object

The log query.



64
65
66
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 64

def security_query
  @security_query
end

#sort ⇒ Object

The controls for sorting the widget.



67
68
69
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 67

def sort
  @sort
end

#style ⇒ Object

Define request widget style.



70
71
72
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 70

def style
  @style
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 81

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



259
260
261
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 259

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 107

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



289
290
291
292
293
294
295
296
297
298
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
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 289

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 367

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 266

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


246
247
248
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 246

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



196
197
198
199
200
201
202
203
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 196

def list_invalid_properties
  invalid_properties = Array.new
  if !@conditional_formats.nil? && @conditional_formats.length < 1
    invalid_properties.push('invalid value for "conditional_formats", number of items must be greater than or equal to 1.')
  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



343
344
345
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 343

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



337
338
339
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_request.rb', line 337

def to_s
  to_hash.to_s
end