Class: Alfresco::RequestStats

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco/models/request_stats.rb

Overview

A list of stats request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestStats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



113
114
115
116
117
118
119
120
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/alfresco/models/request_stats.rb', line 113

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'field')
    self.field = attributes[:'field']
  end

  if attributes.has_key?(:'label')
    self.label = attributes[:'label']
  end

  if attributes.has_key?(:'min')
    self.min = attributes[:'min']
  else
    self.min = true
  end

  if attributes.has_key?(:'max')
    self.max = attributes[:'max']
  else
    self.max = true
  end

  if attributes.has_key?(:'sum')
    self.sum = attributes[:'sum']
  else
    self.sum = true
  end

  if attributes.has_key?(:'countValues')
    self.count_values = attributes[:'countValues']
  else
    self.count_values = true
  end

  if attributes.has_key?(:'missing')
    self.missing = attributes[:'missing']
  else
    self.missing = true
  end

  if attributes.has_key?(:'mean')
    self.mean = attributes[:'mean']
  else
    self.mean = true
  end

  if attributes.has_key?(:'stddev')
    self.stddev = attributes[:'stddev']
  else
    self.stddev = true
  end

  if attributes.has_key?(:'sumOfSquares')
    self.sum_of_squares = attributes[:'sumOfSquares']
  else
    self.sum_of_squares = true
  end

  if attributes.has_key?(:'distinctValues')
    self.distinct_values = attributes[:'distinctValues']
  else
    self.distinct_values = false
  end

  if attributes.has_key?(:'countDistinct')
    self.count_distinct = attributes[:'countDistinct']
  else
    self.count_distinct = false
  end

  if attributes.has_key?(:'cardinality')
    self.cardinality = attributes[:'cardinality']
  else
    self.cardinality = false
  end

  if attributes.has_key?(:'cardinalityAccuracy')
    self.cardinality_accuracy = attributes[:'cardinalityAccuracy']
  else
    self.cardinality_accuracy = 0.3
  end

  if attributes.has_key?(:'excludeFilters')
    if (value = attributes[:'excludeFilters']).is_a?(Array)
      self.exclude_filters = value
    end
  end

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

end

Instance Attribute Details

#cardinality ⇒ Object

A statistical approximation of the number of distinct values



55
56
57
 
# File 'lib/alfresco/models/request_stats.rb', line 55

def cardinality
  @cardinality
end

#cardinality_accuracy ⇒ Object

Number between 0.0 and 1.0 indicating how aggressively the algorithm should try to be accurate. Used with boolean cardinality flag.



58
59
60
 
# File 'lib/alfresco/models/request_stats.rb', line 58

def cardinality_accuracy
  @cardinality_accuracy
end

#count_distinct ⇒ Object

The number of distinct values (This can be very expensive to calculate)



52
53
54
 
# File 'lib/alfresco/models/request_stats.rb', line 52

def count_distinct
  @count_distinct
end

#count_values ⇒ Object

The number which have a value for this field



34
35
36
 
# File 'lib/alfresco/models/request_stats.rb', line 34

def count_values
  @count_values
end

#distinct_values ⇒ Object

The set of all distinct values for the field (This can be very expensive to calculate)



49
50
51
 
# File 'lib/alfresco/models/request_stats.rb', line 49

def distinct_values
  @distinct_values
end

#exclude_filters ⇒ Object

A list of filters to exclude



61
62
63
 
# File 'lib/alfresco/models/request_stats.rb', line 61

def exclude_filters
  @exclude_filters
end

#field ⇒ Object

The stats field



19
20
21
 
# File 'lib/alfresco/models/request_stats.rb', line 19

def field
  @field
end

#label ⇒ Object

A label to include for reference the stats field



22
23
24
 
# File 'lib/alfresco/models/request_stats.rb', line 22

def label
  @label
end

#max ⇒ Object

The maximum value of the field



28
29
30
 
# File 'lib/alfresco/models/request_stats.rb', line 28

def max
  @max
end

#mean ⇒ Object

The average



40
41
42
 
# File 'lib/alfresco/models/request_stats.rb', line 40

def mean
  @mean
end

#min ⇒ Object

The minimum value of the field



25
26
27
 
# File 'lib/alfresco/models/request_stats.rb', line 25

def min
  @min
end

#missing ⇒ Object

The number which do not have a value for this field



37
38
39
 
# File 'lib/alfresco/models/request_stats.rb', line 37

def missing
  @missing
end

#percentiles ⇒ Object

A list of percentile values, e.g. "1,99,99.9"



64
65
66
 
# File 'lib/alfresco/models/request_stats.rb', line 64

def percentiles
  @percentiles
end

#stddev ⇒ Object

Standard deviation



43
44
45
 
# File 'lib/alfresco/models/request_stats.rb', line 43

def stddev
  @stddev
end

#sum ⇒ Object

The sum of all values of the field



31
32
33
 
# File 'lib/alfresco/models/request_stats.rb', line 31

def sum
  @sum
end

#sum_of_squares ⇒ Object

Sum of all values squared



46
47
48
 
# File 'lib/alfresco/models/request_stats.rb', line 46

def sum_of_squares
  @sum_of_squares
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/alfresco/models/request_stats.rb', line 68

def self.attribute_map
  {
    :'field' => :'field',
    :'label' => :'label',
    :'min' => :'min',
    :'max' => :'max',
    :'sum' => :'sum',
    :'count_values' => :'countValues',
    :'missing' => :'missing',
    :'mean' => :'mean',
    :'stddev' => :'stddev',
    :'sum_of_squares' => :'sumOfSquares',
    :'distinct_values' => :'distinctValues',
    :'count_distinct' => :'countDistinct',
    :'cardinality' => :'cardinality',
    :'cardinality_accuracy' => :'cardinalityAccuracy',
    :'exclude_filters' => :'excludeFilters',
    :'percentiles' => :'percentiles'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/alfresco/models/request_stats.rb', line 90

def self.swagger_types
  {
    :'field' => :'String',
    :'label' => :'String',
    :'min' => :'BOOLEAN',
    :'max' => :'BOOLEAN',
    :'sum' => :'BOOLEAN',
    :'count_values' => :'BOOLEAN',
    :'missing' => :'BOOLEAN',
    :'mean' => :'BOOLEAN',
    :'stddev' => :'BOOLEAN',
    :'sum_of_squares' => :'BOOLEAN',
    :'distinct_values' => :'BOOLEAN',
    :'count_distinct' => :'BOOLEAN',
    :'cardinality' => :'BOOLEAN',
    :'cardinality_accuracy' => :'Float',
    :'exclude_filters' => :'Array<String>',
    :'percentiles' => :'Array<Float>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/alfresco/models/request_stats.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field == o.field &&
      label == o.label &&
      min == o.min &&
      max == o.max &&
      sum == o.sum &&
      count_values == o.count_values &&
      missing == o.missing &&
      mean == o.mean &&
      stddev == o.stddev &&
      sum_of_squares == o.sum_of_squares &&
      distinct_values == o.distinct_values &&
      count_distinct == o.count_distinct &&
      cardinality == o.cardinality &&
      cardinality_accuracy == o.cardinality_accuracy &&
      exclude_filters == o.exclude_filters &&
      percentiles == o.percentiles
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/alfresco/models/request_stats.rb', line 285

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = Alfresco.const_get(type).new
    temp_model.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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/alfresco/models/request_stats.rb', line 351

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/alfresco/models/request_stats.rb', line 264

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


251
252
253
 
# File 'lib/alfresco/models/request_stats.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



257
258
259
 
# File 'lib/alfresco/models/request_stats.rb', line 257

def hash
  [field, label, min, max, sum, count_values, missing, mean, stddev, sum_of_squares, distinct_values, count_distinct, cardinality, cardinality_accuracy, exclude_filters, percentiles].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



215
216
217
218
 
# File 'lib/alfresco/models/request_stats.rb', line 215

def list_invalid_properties
  invalid_properties = Array.new
  return 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



331
332
333
 
# File 'lib/alfresco/models/request_stats.rb', line 331

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



337
338
339
340
341
342
343
344
345
 
# File 'lib/alfresco/models/request_stats.rb', line 337

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



325
326
327
 
# File 'lib/alfresco/models/request_stats.rb', line 325

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



222
223
224
 
# File 'lib/alfresco/models/request_stats.rb', line 222

def valid?
  return true
end