Class: CtdDocumentation::Network

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

Overview

Network Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(resource_id = SKIP, id = SKIP, site_id = SKIP, name = SKIP) ⇒ Network

Returns a new instance of Network.



53
54
55
56
57
58
59
60
61
 
# File 'lib/ctd_documentation/models/network.rb', line 53

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

Instance Attribute Details

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def id
  @id
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def name
  @name
end

#resource_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def resource_id
  @resource_id
end

#site_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def site_id
  @site_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ctd_documentation/models/network.rb', line 64

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  resource_id = hash.key?('resource_id') ? hash['resource_id'] : SKIP
  id = hash.key?('id') ? hash['id'] : SKIP
  site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
  name = hash.key?('name') ? hash['name'] : SKIP

  # Create object from extracted values.

  Network.new(resource_id,
              id,
              site_id,
              name)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/ctd_documentation/models/network.rb', line 29

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

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/ctd_documentation/models/network.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/ctd_documentation/models/network.rb', line 39

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