Class: CtdDocumentation::DbStatistics

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/ctd_documentation/models/db_statistics.rb

Overview

DbStatistics Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(query_count = SKIP) ⇒ DbStatistics

Returns a new instance of DbStatistics.



35
36
37
 
# File 'lib/ctd_documentation/models/db_statistics.rb', line 35

def initialize(query_count = SKIP)
  @query_count = query_count unless query_count == SKIP
end

Instance Attribute Details

#query_count ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/ctd_documentation/models/db_statistics.rb', line 14

def query_count
  @query_count
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



40
41
42
43
44
45
46
47
48
 
# File 'lib/ctd_documentation/models/db_statistics.rb', line 40

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  query_count = hash.key?('query_count') ? hash['query_count'] : SKIP

  # Create object from extracted values.
  DbStatistics.new(query_count)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/ctd_documentation/models/db_statistics.rb', line 17

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['query_count'] = 'query_count'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



31
32
33
 
# File 'lib/ctd_documentation/models/db_statistics.rb', line 31

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
27
28
 
# File 'lib/ctd_documentation/models/db_statistics.rb', line 24

def self.optionals
  %w[
    query_count
  ]
end