Class: CtdDocumentation::Cap

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

Overview

Cap 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 = SKIP, resource_id = SKIP, id = SKIP, deleted = SKIP, file_name = SKIP) ⇒ Cap

Returns a new instance of Cap.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ctd_documentation/models/cap.rb', line 59

def initialize(site_id = SKIP,
               resource_id = SKIP,
               id = SKIP,
               deleted = SKIP,
               file_name = SKIP)
  @site_id = site_id unless site_id == SKIP
  @resource_id = resource_id unless resource_id == SKIP
  @id = id unless id == SKIP
  @deleted = deleted unless deleted == SKIP
  @file_name = file_name unless file_name == SKIP
end

Instance Attribute Details

#deleted ⇒ TrueClass|FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass|FalseClass) 


26
27
28
 
# File 'lib/ctd_documentation/models/cap.rb', line 26

def deleted
  @deleted
end

#file_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


30
31
32
 
# File 'lib/ctd_documentation/models/cap.rb', line 30

def file_name
  @file_name
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/ctd_documentation/models/cap.rb', line 22

def id
  @id
end

#resource_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def resource_id
  @resource_id
end

#site_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/ctd_documentation/models/cap.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.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ctd_documentation/models/cap.rb', line 72

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
  resource_id = hash.key?('resource_id') ? hash['resource_id'] : SKIP
  id = hash.key?('id') ? hash['id'] : SKIP
  deleted = hash.key?('deleted') ? hash['deleted'] : SKIP
  file_name = hash.key?('file_name') ? hash['file_name'] : SKIP

  # Create object from extracted values.
  Cap.new(site_id,
          resource_id,
          id,
          deleted,
          file_name)
end

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
41
 
# File 'lib/ctd_documentation/models/cap.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['site_id'] = 'site_id'
  @_hash['resource_id'] = 'resource_id'
  @_hash['id'] = 'id'
  @_hash['deleted'] = 'deleted'
  @_hash['file_name'] = 'file_name'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



55
56
57
 
# File 'lib/ctd_documentation/models/cap.rb', line 55

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



44
45
46
47
48
49
50
51
52
 
# File 'lib/ctd_documentation/models/cap.rb', line 44

def self.optionals
  %w[
    site_id
    resource_id
    id
    deleted
    file_name
  ]
end