Class: IntersightClient::TelemetryDruidFilteredAggregator

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

Overview

A filtered aggregator wraps any given aggregator, but only aggregates the values for which the given dimension filter matches. This makes it possible to compute the results of a filtered and an unfiltered aggregation simultaneously, without having to issue multiple queries, and use both results as part of post-aggregations. If only the filtered results are required, consider putting the filter on the query itself, which will be much faster since it does not require scanning all the data.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TelemetryDruidFilteredAggregator

Initializes the object



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 92

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

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

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

Instance Attribute Details

#aggregator ⇒ Object

Returns the value of attribute aggregator.



24
25
26
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 24

def aggregator
  @aggregator
end

#filter ⇒ Object

Returns the value of attribute filter.



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

def filter
  @filter
end

#type ⇒ Object

The aggregator type.



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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

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



63
64
65
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 63

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 49

def self.attribute_map
  {
    :'type' => :'type',
    :'filter' => :'filter',
    :'aggregator' => :'aggregator'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



183
184
185
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 183

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



83
84
85
86
87
88
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 83

def self.openapi_all_of
  [
  :'TelemetryDruidBaseAggregator',
  :'TelemetryDruidFilteredAggregatorAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 68

def self.openapi_types
  {
    :'type' => :'String',
    :'filter' => :'TelemetryDruidFilter',
    :'aggregator' => :'TelemetryDruidAggregator'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



160
161
162
163
164
165
166
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      filter == o.filter &&
      aggregator == o.aggregator
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 213

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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 284

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 190

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


170
171
172
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



176
177
178
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 176

def hash
  [type, filter, aggregator].hash
end

#list_invalid_properties ⇒ Object

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 120

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



260
261
262
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 260

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 266

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



254
255
256
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 254

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



139
140
141
142
143
144
145
146
 
# File 'lib/intersight_client/models/telemetry_druid_filtered_aggregator.rb', line 139

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["count", "longSum", "doubleSum", "floatSum", "doubleMin", "doubleMax", "floatMin", "floatMax", "longMin", "longMax", "doubleFirst", "doubleLast", "floatFirst", "floatLast", "longFirst", "longLast", "stringFirst", "stringLast", "doubleAny", "floatAny", "longAny", "stringAny", "thetaSketch", "filtered"])
  return false unless type_validator.valid?(@type)
  return false if @filter.nil?
  return false if @aggregator.nil?
  true
end