Class: IntersightClient::TelemetryDruidTopNRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/intersight_client/models/telemetry_druid_top_n_request.rb

Overview

TopN queries return a sorted set of results for the values in a given dimension according to some criteria. Conceptually, they can be thought of as an approximate GroupByQuery over a single dimension with an Ordering spec. TopNs are much faster and resource efficient than GroupBys for this use case. These types of queries take a topN query object and return an array of JSON objects where each object represents a value asked for by the topN query. TopNs are approximate in that each data process will rank their top K results and only return those top K results to the Broker. K, by default in Druid, is max(1000, threshold). In practice, this means that if you ask for the top 1000 items ordered, the correctness of the first ~900 items will be 100%, and the ordering of the results after that is not guaranteed. TopNs can be made more accurate by increasing the threshold.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TelemetryDruidTopNRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 128

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::TelemetryDruidTopNRequest` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aggregations ⇒ Object

Aggregation functions are used to summarize data in buckets. Summarization functions include counting rows, calculating the min/max/sum of metrics and retrieving the first/last value of metrics for each bucket. Additional summarization functions are available with extensions. If no aggregator is provided, the results will be empty for each bucket.



32
33
34
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 32

def aggregations
  @aggregations
end

#context ⇒ Object

Returns the value of attribute context.



44
45
46
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 44

def context
  @context
end

#data_source ⇒ Object

Returns the value of attribute data_source.



22
23
24
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 22

def data_source
  @data_source
end

#dimension ⇒ Object

Returns the value of attribute dimension.



37
38
39
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 37

def dimension
  @dimension
end

#filter ⇒ Object

Returns the value of attribute filter.



29
30
31
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 29

def filter
  @filter
end

#granularity ⇒ Object

Returns the value of attribute granularity.



27
28
29
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 27

def granularity
  @granularity
end

#intervals ⇒ Object

A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.



25
26
27
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 25

def intervals
  @intervals
end

#metric ⇒ Object

Returns the value of attribute metric.



42
43
44
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 42

def metric
  @metric
end

#post_aggregations ⇒ Object

Post-aggregations are specifications of processing that should happen on aggregated values as they come out of Apache Druid. If you include a post aggregation as part of a query, make sure to include all aggregators the post-aggregator requires.



35
36
37
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 35

def post_aggregations
  @post_aggregations
end

#query_type ⇒ Object

null



20
21
22
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 20

def query_type
  @query_type
end

#threshold ⇒ Object

An integer defining the N in the topN (i.e. how many results you want in the top list).



40
41
42
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 40

def threshold
  @threshold
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



91
92
93
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 91

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 69

def self.attribute_map
  {
    :'query_type' => :'queryType',
    :'data_source' => :'dataSource',
    :'intervals' => :'intervals',
    :'granularity' => :'granularity',
    :'filter' => :'filter',
    :'aggregations' => :'aggregations',
    :'post_aggregations' => :'postAggregations',
    :'dimension' => :'dimension',
    :'threshold' => :'threshold',
    :'metric' => :'metric',
    :'context' => :'context'
  }
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



285
286
287
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 285

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



119
120
121
122
123
124
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 119

def self.openapi_all_of
  [
  :'TelemetryDruidBaseRequest',
  :'TelemetryDruidTopNRequestAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 113

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 96

def self.openapi_types
  {
    :'query_type' => :'String',
    :'data_source' => :'TelemetryDruidDataSource',
    :'intervals' => :'Array<String>',
    :'granularity' => :'TelemetryDruidGranularity',
    :'filter' => :'TelemetryDruidFilter',
    :'aggregations' => :'Array<TelemetryDruidAggregator>',
    :'post_aggregations' => :'Array<TelemetryDruidPostAggregator>',
    :'dimension' => :'TelemetryDruidDimensionSpec',
    :'threshold' => :'Integer',
    :'metric' => :'TelemetryDruidTopNMetricSpec',
    :'context' => :'TelemetryDruidQueryContext'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query_type == o.query_type &&
      data_source == o.data_source &&
      intervals == o.intervals &&
      granularity == o.granularity &&
      filter == o.filter &&
      aggregations == o.aggregations &&
      post_aggregations == o.post_aggregations &&
      dimension == o.dimension &&
      threshold == o.threshold &&
      metric == o.metric &&
      context == o.context
end

#_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



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
351
352
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 315

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 /\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 = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 386

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 292

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  TelemetryDruidTopNRequest.openapi_types.each_pair do |key, type|
    if attributes[TelemetryDruidTopNRequest.attribute_map[key]].nil? && TelemetryDruidTopNRequest.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[TelemetryDruidTopNRequest.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[TelemetryDruidTopNRequest.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[TelemetryDruidTopNRequest.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[TelemetryDruidTopNRequest.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 278

def hash
  [query_type, data_source, intervals, granularity, filter, aggregations, post_aggregations, dimension, threshold, metric, context].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 194

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

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

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

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

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

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

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



362
363
364
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 362

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 368

def to_hash
  hash = {}
  TelemetryDruidTopNRequest.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = TelemetryDruidTopNRequest.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



356
357
358
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 356

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



229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/intersight_client/models/telemetry_druid_top_n_request.rb', line 229

def valid?
  return false if @query_type.nil?
  query_type_validator = EnumAttributeValidator.new('String', ["timeseries", "topN", "groupBy", "scan", "timeBoundary", "segmentMetadata", "dataSourceMetadata", "search"])
  return false unless query_type_validator.valid?(@query_type)
  return false if @data_source.nil?
  return false if @intervals.nil?
  return false if @granularity.nil?
  return false if @dimension.nil?
  return false if @threshold.nil?
  return false if @metric.nil?
  true
end