Class: IntersightClient::TelemetryDruidGroupByRequest

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

Overview

These types of Apache Druid queries take a groupBy query object and return an array of JSON objects where each object represents a grouping asked for by the query.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TelemetryDruidGroupByRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'having')
    self.having = attributes[:'having']
  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?(:'intervals')
    if (value = attributes[:'intervals']).is_a?(Array)
      self.intervals = value
    end
  end

  if attributes.key?(:'subtotals_spec')
    self.subtotals_spec = attributes[:'subtotals_spec']
  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.



36
37
38
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 36

def aggregations
  @aggregations
end

#context ⇒ Object

Returns the value of attribute context.



47
48
49
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 47

def context
  @context
end

#data_source ⇒ Object

Returns the value of attribute data_source.



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

def data_source
  @data_source
end

#dimensions ⇒ Object

A JSON list of dimensions to do the groupBy over; or see DimensionSpec for ways to extract dimensions..



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

def dimensions
  @dimensions
end

#filter ⇒ Object

Returns the value of attribute filter.



33
34
35
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 33

def filter
  @filter
end

#granularity ⇒ Object

Returns the value of attribute granularity.



31
32
33
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 31

def granularity
  @granularity
end

#having ⇒ Object

Returns the value of attribute having.



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

def having
  @having
end

#intervals ⇒ Object

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



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

def intervals
  @intervals
end

#limit_spec ⇒ Object

Returns the value of attribute limit_spec.



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

def limit_spec
  @limit_spec
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.



39
40
41
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 39

def post_aggregations
  @post_aggregations
end

#query_type ⇒ Object

null



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

def query_type
  @query_type
end

#subtotals_spec ⇒ Object

A JSON array of arrays to return additional result sets for groupings of subsets of top level dimensions. The subtotals feature allows computation of multiple sub-groupings in a single query. To use this feature, add a "subtotalsSpec" to your query, which should be a list of subgroup dimension sets. It should contain the "outputName" from dimensions in your "dimensions" attribute, in the same order as they appear in the "dimensions" attribute.



45
46
47
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 45

def subtotals_spec
  @subtotals_spec
end

Class Method Details

.acceptable_attribute_map ⇒ Object

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



95
96
97
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 95

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 72

def self.attribute_map
  {
    :'query_type' => :'queryType',
    :'data_source' => :'dataSource',
    :'dimensions' => :'dimensions',
    :'limit_spec' => :'limitSpec',
    :'having' => :'having',
    :'granularity' => :'granularity',
    :'filter' => :'filter',
    :'aggregations' => :'aggregations',
    :'post_aggregations' => :'postAggregations',
    :'intervals' => :'intervals',
    :'subtotals_spec' => :'subtotalsSpec',
    :'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



287
288
289
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 287

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



124
125
126
127
128
129
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 124

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 100

def self.openapi_types
  {
    :'query_type' => :'String',
    :'data_source' => :'TelemetryDruidDataSource',
    :'dimensions' => :'Array<TelemetryDruidDimensionSpec>',
    :'limit_spec' => :'TelemetryDruidDefaultLimitSpec',
    :'having' => :'TelemetryDruidHavingFilter',
    :'granularity' => :'TelemetryDruidGranularity',
    :'filter' => :'TelemetryDruidFilter',
    :'aggregations' => :'Array<TelemetryDruidAggregator>',
    :'post_aggregations' => :'Array<TelemetryDruidPostAggregator>',
    :'intervals' => :'Array<String>',
    :'subtotals_spec' => :'Object',
    :'context' => :'TelemetryDruidQueryContext'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query_type == o.query_type &&
      data_source == o.data_source &&
      dimensions == o.dimensions &&
      limit_spec == o.limit_spec &&
      having == o.having &&
      granularity == o.granularity &&
      filter == o.filter &&
      aggregations == o.aggregations &&
      post_aggregations == o.post_aggregations &&
      intervals == o.intervals &&
      subtotals_spec == o.subtotals_spec &&
      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



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
353
354
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 317

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 388

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


274
275
276
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 274

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



280
281
282
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 280

def hash
  [query_type, data_source, dimensions, limit_spec, having, granularity, filter, aggregations, post_aggregations, intervals, subtotals_spec, 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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 205

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 @dimensions.nil?
    invalid_properties.push('invalid value for "dimensions", dimensions cannot be nil.')
  end

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

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



364
365
366
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 364

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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 370

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



358
359
360
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 358

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



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/intersight_client/models/telemetry_druid_group_by_request.rb', line 232

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 @dimensions.nil?
  return false if @granularity.nil?
  return false if @intervals.nil?
  true
end