Class: CtdDocumentation::CreateANewQuery

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

Overview

CreateANewQuery Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(site_id = nil, params = nil) ⇒ CreateANewQuery

Returns a new instance of CreateANewQuery.



38
39
40
41
42
 
# File 'lib/ctd_documentation/models/create_a_new_query.rb', line 38

def initialize(site_id = nil,
               params = nil)
  @site_id = site_id
  @params = params
end

Instance Attribute Details

#params ⇒ NewQueryobject

TODO: Write general description for this method

Returns:



18
19
20
 
# File 'lib/ctd_documentation/models/create_a_new_query.rb', line 18

def params
  @params
end

#site_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def site_id
  @site_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/ctd_documentation/models/create_a_new_query.rb', line 45

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  site_id = hash.key?('site_id') ? hash['site_id'] : nil
  params = NewQueryobject.from_hash(hash['params']) if hash['params']

  # Create object from extracted values.

  CreateANewQuery.new(site_id,
                      params)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/ctd_documentation/models/create_a_new_query.rb', line 21

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

.nullables ⇒ Object

An array for nullable fields



34
35
36
 
# File 'lib/ctd_documentation/models/create_a_new_query.rb', line 34

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/ctd_documentation/models/create_a_new_query.rb', line 29

def self.optionals
  []
end