Class: DatadogAPIClient::V1::ServiceSummaryWidgetDefinition

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceSummaryWidgetDefinition

Initializes the object



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 130

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::ServiceSummaryWidgetDefinition` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::ServiceSummaryWidgetDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'display_format')
    self.display_format = attributes[:'display_format']
  end

  if attributes.key?(:'env')
    self.env = attributes[:'env']
  end

  if attributes.key?(:'service')
    self.service = attributes[:'service']
  end

  if attributes.key?(:'show_breakdown')
    self.show_breakdown = attributes[:'show_breakdown']
  end

  if attributes.key?(:'show_distribution')
    self.show_distribution = attributes[:'show_distribution']
  end

  if attributes.key?(:'show_errors')
    self.show_errors = attributes[:'show_errors']
  end

  if attributes.key?(:'show_hits')
    self.show_hits = attributes[:'show_hits']
  end

  if attributes.key?(:'show_latency')
    self.show_latency = attributes[:'show_latency']
  end

  if attributes.key?(:'show_resource_list')
    self.show_resource_list = attributes[:'show_resource_list']
  end

  if attributes.key?(:'size_format')
    self.size_format = attributes[:'size_format']
  end

  if attributes.key?(:'span_name')
    self.span_name = attributes[:'span_name']
  end

  if attributes.key?(:'time')
    self.time = attributes[:'time']
  end

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.key?(:'title_align')
    self.title_align = attributes[:'title_align']
  end

  if attributes.key?(:'title_size')
    self.title_size = attributes[:'title_size']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'trace_service'
  end
end

Instance Attribute Details

#display_formatObject

Returns the value of attribute display_format.



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

def display_format
  @display_format
end

#envObject

APM environment.



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

def env
  @env
end

#serviceObject

APM service.



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

def service
  @service
end

#show_breakdownObject

Whether to show the latency breakdown or not.



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

def show_breakdown
  @show_breakdown
end

#show_distributionObject

Whether to show the latency distribution or not.



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

def show_distribution
  @show_distribution
end

#show_errorsObject

Whether to show the error metrics or not.



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

def show_errors
  @show_errors
end

#show_hitsObject

Whether to show the hits metrics or not.



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

def show_hits
  @show_hits
end

#show_latencyObject

Whether to show the latency metrics or not.



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

def show_latency
  @show_latency
end

#show_resource_listObject

Whether to show the resource list or not.



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

def show_resource_list
  @show_resource_list
end

#size_formatObject

Returns the value of attribute size_format.



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

def size_format
  @size_format
end

#span_nameObject

APM span name.



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

def span_name
  @span_name
end

#timeObject

Returns the value of attribute time.



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

def time
  @time
end

#titleObject

Title of the widget.



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

def title
  @title
end

#title_alignObject

Returns the value of attribute title_align.



62
63
64
# File 'lib/datadog_api_client/v1/models/service_summary_widget_definition.rb', line 62

def title_align
  @title_align
end

#title_sizeObject

Size of the title.



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

def title_size
  @title_size
end

#typeObject

Returns the value of attribute type.



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

def type
  @type
end