class Alfresco::RequestStats

A list of stats request.

Attributes

cardinality[RW]

A statistical approximation of the number of distinct values

cardinality_accuracy[RW]

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

count_distinct[RW]

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

count_values[RW]

The number which have a value for this field

distinct_values[RW]

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

exclude_filters[RW]

A list of filters to exclude

field[RW]

The stats field

label[RW]

A label to include for reference the stats field

max[RW]

The maximum value of the field

mean[RW]

The average

min[RW]

The minimum value of the field

missing[RW]

The number which do not have a value for this field

percentiles[RW]

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

stddev[RW]

Standard deviation

sum[RW]

The sum of all values of the field

sum_of_squares[RW]

Sum of all values squared

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/alfresco/models/request_stats.rb, line 251
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/alfresco/models/request_stats.rb, line 215
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/alfresco/models/request_stats.rb, line 331
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/alfresco/models/request_stats.rb, line 325
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/alfresco/models/request_stats.rb, line 222
def valid?
  return true
end