Class: DatadogAPIClient::V1::ServiceSummaryWidgetDefinition

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

Overview

The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.

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

def _unparsed
  @_unparsed
end

#display_format ⇒ Object

Number of columns to display.



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

def display_format
  @display_format
end

#env ⇒ Object

APM environment.



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

def env
  @env
end

#service ⇒ Object

APM service.



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

def service
  @service
end

#show_breakdown ⇒ Object

Whether to show the latency breakdown or not.



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

def show_breakdown
  @show_breakdown
end

#show_distribution ⇒ Object

Whether to show the latency distribution or not.



37
38
39
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 37

def show_distribution
  @show_distribution
end

#show_errors ⇒ Object

Whether to show the error metrics or not.



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

def show_errors
  @show_errors
end

#show_hits ⇒ Object

Whether to show the hits metrics or not.



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

def show_hits
  @show_hits
end

#show_latency ⇒ Object

Whether to show the latency metrics or not.



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

def show_latency
  @show_latency
end

#show_resource_list ⇒ Object

Whether to show the resource list or not.



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

def show_resource_list
  @show_resource_list
end

#size_format ⇒ Object

Size of the widget.



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

def size_format
  @size_format
end

#span_name ⇒ Object

APM span name.



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

def span_name
  @span_name
end

#time ⇒ Object

Time setting for the widget.



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

def time
  @time
end

#title ⇒ Object

Title of the widget.



59
60
61
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 59

def title
  @title
end

#title_align ⇒ Object

How to align the text on the widget.



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

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Type of the service summary widget.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 91

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



276
277
278
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 276

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 118

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



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
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 306

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 384

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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 283

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


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

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 207

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

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

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

  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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



360
361
362
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 360

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



354
355
356
 
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 354

def to_s
  to_hash.to_s
end