Class: CtdDocumentation::Taskextraparams

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

Overview

Taskextraparams 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_discovered_devices = SKIP, port = SKIP, sub_query = SKIP) ⇒ Taskextraparams

Returns a new instance of Taskextraparams.



47
48
49
50
51
52
53
 
# File 'lib/ctd_documentation/models/taskextraparams.rb', line 47

def initialize(query_discovered_devices = SKIP,
               port = SKIP,
               sub_query = SKIP)
  @query_discovered_devices = query_discovered_devices unless query_discovered_devices == SKIP
  @port = port unless port == SKIP
  @sub_query = sub_query unless sub_query == SKIP
end

Instance Attribute Details

#port ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def port
  @port
end

#query_discovered_devices ⇒ TrueClass|FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass|FalseClass) 


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

def query_discovered_devices
  @query_discovered_devices
end

#sub_query ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def sub_query
  @sub_query
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  query_discovered_devices =
    hash.key?('Query_Discovered_Devices') ? hash['Query_Discovered_Devices'] : SKIP
  port = hash.key?('port') ? hash['port'] : SKIP
  sub_query = hash.key?('sub_query') ? hash['sub_query'] : SKIP

  # Create object from extracted values.

  Taskextraparams.new(query_discovered_devices,
                      port,
                      sub_query)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/ctd_documentation/models/taskextraparams.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['query_discovered_devices'] = 'Query_Discovered_Devices'
  @_hash['port'] = 'port'
  @_hash['sub_query'] = 'sub_query'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/ctd_documentation/models/taskextraparams.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    query_discovered_devices
    port
    sub_query
  ]
end