Class: DatadogAPIClient::V1::TimeseriesWidgetRequest

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

Overview

Updated timeseries widget.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsedObject

whether the object has unparsed attributes



23
24
25
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 23

def _unparsed
  @_unparsed
end

#apm_queryObject

The log query.



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

def apm_query
  @apm_query
end

#audit_queryObject

The log query.



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

def audit_query
  @audit_query
end

#display_typeObject

Type of display to use for the request.



31
32
33
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 31

def display_type
  @display_type
end

#event_queryObject

The log query.



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

def event_query
  @event_query
end

#formulasObject

List of formulas that operate on queries.



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

def formulas
  @formulas
end

#log_queryObject

The log query.



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

def log_query
  @log_query
end

#metadataObject

Used to define expression aliases.



39
40
41
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 39

def 
  @metadata
end

#network_queryObject

The log query.



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

def network_query
  @network_query
end

#on_right_yaxisObject

Whether or not to display a second y-axis on the right.



44
45
46
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 44

def on_right_yaxis
  @on_right_yaxis
end

#process_queryObject

The process query to use in the widget.



52
53
54
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 52

def process_query
  @process_query
end

#profile_metrics_queryObject

The log query.



55
56
57
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 55

def profile_metrics_query
  @profile_metrics_query
end

#qObject

Widget query.



51
52
53
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 51

def q
  @q
end

#queriesObject

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



54
55
56
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 54

def queries
  @queries
end

#response_formatObject

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



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

def response_format
  @response_format
end

#rum_queryObject

The log query.



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

def rum_query
  @rum_query
end

#security_queryObject

The log query.



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

def security_query
  @security_query
end

#styleObject

Define request widget style.



73
74
75
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 73

def style
  @style
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



88
89
90
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 88

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



263
264
265
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 263

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

.openapi_nullableObject

List of attributes with nullable: true



116
117
118
119
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 116

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



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
334
335
336
337
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 293

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



371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 371

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 270

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


250
251
252
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 250

def eql?(o)
  self == o
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



213
214
215
216
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 213

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



347
348
349
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 347

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



353
354
355
356
357
358
359
360
361
362
363
364
365
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 353

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



341
342
343
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 341

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



220
221
222
# File 'lib/datadog_api_client/v1/models/timeseries_widget_request.rb', line 220

def valid?
  true
end