Class: DatadogAPIClient::V1::MetricsQueryMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/models/metrics_query_metadata.rb

Overview

Object containing all metric names returned and their associated metadata.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetricsQueryMetadata

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    attributes Model attributes in the form of hash



121
122
123
124
125
126
127
128
129
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
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 121

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::MetricsQueryMetadata` 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::MetricsQueryMetadata`. 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?(:'aggr')
    self.aggr = attributes[:'aggr']
  end

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

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

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

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

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

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

  if attributes.key?(:'pointlist')
    if (value = attributes[:'pointlist']).is_a?(Array)
      self.pointlist = value
    end
  end

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

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

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

  if attributes.key?(:'tag_set')
    if (value = attributes[:'tag_set']).is_a?(Array)
      self.tag_set = value
    end
  end

  if attributes.key?(:'unit')
    if (value = attributes[:'unit']).is_a?(Array)
      self.unit = value
    end
  end
end

Instance Attribute Details

#_end ⇒ Object

End of the time window, milliseconds since Unix epoch.



33
34
35
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 33

def _end
  @_end
end

#aggr ⇒ Object

Aggregation type.



27
28
29
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 27

def aggr
  @aggr
end

#display_name ⇒ Object

Display name of the metric.



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

def display_name
  @display_name
end

#expression ⇒ Object

Metric expression.



36
37
38
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 36

def expression
  @expression
end

#interval ⇒ Object

Number of seconds between data samples.



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

def interval
  @interval
end

#length ⇒ Object

Number of data samples.



42
43
44
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 42

def length
  @length
end

#metric ⇒ Object

Metric name.



45
46
47
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 45

def metric
  @metric
end

#pointlist ⇒ Object

List of points of the time series.



48
49
50
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 48

def pointlist
  @pointlist
end

#query_index ⇒ Object

The index of the series’ query within the request.



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

def query_index
  @query_index
end

#scope ⇒ Object

Metric scope, comma separated list of tags.



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

def scope
  @scope
end

#start ⇒ Object

Start of the time window, milliseconds since Unix epoch.



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

def start
  @start
end

#tag_set ⇒ Object

Unique tags identifying this series.



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

def tag_set
  @tag_set
end

#unit ⇒ Object

Detailed information about the metric unit. First element describes the "primary unit" (for example, ‘bytes` in `bytes per second`), second describes the "per unit" (for example, `second` in `bytes per second`).



63
64
65
 
# File 'lib/datadog_api_client/v1/models/metrics_query_metadata.rb', line 63

def unit
  @unit
end