Class: Algolia::Monitoring::Metrics

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/monitoring/metrics.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Metrics

Initializes the object



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/algolia/models/monitoring/metrics.rb', line 57

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Metrics` 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))
      raise(
        ArgumentError,
        "`#{k}` is not a valid attribute in `Algolia::Metrics`. 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?(:cpu_usage)
    if (value = attributes[:cpu_usage]).is_a?(Hash)
      self.cpu_usage = value
    end
  end

  if attributes.key?(:ram_indexing_usage)
    if (value = attributes[:ram_indexing_usage]).is_a?(Hash)
      self.ram_indexing_usage = value
    end
  end

  if attributes.key?(:ram_search_usage)
    if (value = attributes[:ram_search_usage]).is_a?(Hash)
      self.ram_search_usage = value
    end
  end

  if attributes.key?(:ssd_usage)
    if (value = attributes[:ssd_usage]).is_a?(Hash)
      self.ssd_usage = value
    end
  end

  if attributes.key?(:avg_build_time)
    if (value = attributes[:avg_build_time]).is_a?(Hash)
      self.avg_build_time = value
    end
  end
end

Instance Attribute Details

#avg_build_timeObject

Average build time of the indices in seconds.



24
25
26
# File 'lib/algolia/models/monitoring/metrics.rb', line 24

def avg_build_time
  @avg_build_time
end

#cpu_usageObject

CPU idleness in %.



12
13
14
# File 'lib/algolia/models/monitoring/metrics.rb', line 12

def cpu_usage
  @cpu_usage
end

#ram_indexing_usageObject

RAM used for indexing in MB.



15
16
17
# File 'lib/algolia/models/monitoring/metrics.rb', line 15

def ram_indexing_usage
  @ram_indexing_usage
end

#ram_search_usageObject

RAM used for search in MB.



18
19
20
# File 'lib/algolia/models/monitoring/metrics.rb', line 18

def ram_search_usage
  @ram_search_usage
end

#ssd_usageObject

Solid-state disk (SSD) usage expressed as % of RAM. 0% means no SSD usage. A value of 50% indicates 32 GB SSD usage for a machine with 64 RAM.



21
22
23
# File 'lib/algolia/models/monitoring/metrics.rb', line 21

def ssd_usage
  @ssd_usage
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
# File 'lib/algolia/models/monitoring/metrics.rb', line 160

def self._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
    # model
  else
    # models (e.g. Pet) or oneOf
    klass = Algolia::Monitoring.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
      .build_from_hash(value)
  end
end

.attribute_mapObject

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



27
28
29
30
31
32
33
34
35
# File 'lib/algolia/models/monitoring/metrics.rb', line 27

def self.attribute_map
  {
    :cpu_usage => :cpu_usage,
    :ram_indexing_usage => :ram_indexing_usage,
    :ram_search_usage => :ram_search_usage,
    :ssd_usage => :ssd_usage,
    :avg_build_time => :avg_build_time
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/algolia/models/monitoring/metrics.rb', line 133

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  types_mapping.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = 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[attribute_map[key]].is_a?(Array)
        transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
          _deserialize(::Regexp.last_match(1), v)
        }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
    end
  end

  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



49
50
51
52
53
# File 'lib/algolia/models/monitoring/metrics.rb', line 49

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

.types_mappingObject

Attribute type mapping.



38
39
40
41
42
43
44
45
46
# File 'lib/algolia/models/monitoring/metrics.rb', line 38

def self.types_mapping
  {
    :cpu_usage => :"Hash<String, Array>",
    :ram_indexing_usage => :"Hash<String, Array>",
    :ram_search_usage => :"Hash<String, Array>",
    :ssd_usage => :"Hash<String, Array>",
    :avg_build_time => :"Hash<String, Array>"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



108
109
110
111
112
113
114
115
116
# File 'lib/algolia/models/monitoring/metrics.rb', line 108

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    cpu_usage == other.cpu_usage &&
    ram_indexing_usage == other.ram_indexing_usage &&
    ram_search_usage == other.ram_search_usage &&
    ssd_usage == other.ssd_usage &&
    avg_build_time == other.avg_build_time
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/algolia/models/monitoring/metrics.rb', line 239

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

#eql?(other) ⇒ Boolean

See Also:

  • `==` method


120
121
122
# File 'lib/algolia/models/monitoring/metrics.rb', line 120

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.



126
127
128
# File 'lib/algolia/models/monitoring/metrics.rb', line 126

def hash
  [cpu_usage, ram_indexing_usage, ram_search_usage, ssd_usage, avg_build_time].hash
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



210
211
212
# File 'lib/algolia/models/monitoring/metrics.rb', line 210

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



220
221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/algolia/models/monitoring/metrics.rb', line 220

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end

  hash
end

#to_json(*_args) ⇒ Object



214
215
216
# File 'lib/algolia/models/monitoring/metrics.rb', line 214

def to_json(*_args)
  to_hash.to_json
end

#to_sString

Returns the string representation of the object



204
205
206
# File 'lib/algolia/models/monitoring/metrics.rb', line 204

def to_s
  to_hash.to_s
end