Class: UntitledApi::ApiV1SitesPcapsCaptureRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb

Overview

Request parameters

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(type = SKIP, num_packets = SKIP, duration = SKIP, max_pkt_len = SKIP, includes_mcast = SKIP, ap_mac = SKIP, renderer = SKIP) ⇒ ApiV1SitesPcapsCaptureRequest

Returns a new instance of ApiV1SitesPcapsCaptureRequest.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 71

def initialize(type = SKIP,
               num_packets = SKIP,
               duration = SKIP,
               max_pkt_len = SKIP,
               includes_mcast = SKIP,
               ap_mac = SKIP,
               renderer = SKIP)
  @type = type unless type == SKIP
  @num_packets = num_packets unless num_packets == SKIP
  @duration = duration unless duration == SKIP
  @max_pkt_len = max_pkt_len unless max_pkt_len == SKIP
  @includes_mcast = includes_mcast unless includes_mcast == SKIP
  @ap_mac = ap_mac unless ap_mac == SKIP
  @renderer = renderer unless renderer == SKIP
end

Instance Attribute Details

#ap_mac ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


34
35
36
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 34

def ap_mac
  @ap_mac
end

#duration ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


22
23
24
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 22

def duration
  @duration
end

#includes_mcast ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


30
31
32
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 30

def includes_mcast
  @includes_mcast
end

#max_pkt_len ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


26
27
28
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 26

def max_pkt_len
  @max_pkt_len
end

#num_packets ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


18
19
20
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 18

def num_packets
  @num_packets
end

#renderer ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


38
39
40
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 38

def renderer
  @renderer
end

#type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 14

def type
  @type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 88

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  type = hash.key?('type') ? hash['type'] : SKIP
  num_packets = hash.key?('num_packets') ? hash['num_packets'] : SKIP
  duration = hash.key?('duration') ? hash['duration'] : SKIP
  max_pkt_len = hash.key?('max_pkt_len') ? hash['max_pkt_len'] : SKIP
  includes_mcast =
    hash.key?('includes_mcast') ? hash['includes_mcast'] : SKIP
  ap_mac = hash.key?('ap_mac') ? hash['ap_mac'] : SKIP
  renderer = hash.key?('renderer') ? hash['renderer'] : SKIP

  # Create object from extracted values.
  ApiV1SitesPcapsCaptureRequest.new(type,
                                    num_packets,
                                    duration,
                                    max_pkt_len,
                                    includes_mcast,
                                    ap_mac,
                                    renderer)
end

.names ⇒ Object

A mapping from model property names to API property names.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 41

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['type'] = 'type'
  @_hash['num_packets'] = 'num_packets'
  @_hash['duration'] = 'duration'
  @_hash['max_pkt_len'] = 'max_pkt_len'
  @_hash['includes_mcast'] = 'includes_mcast'
  @_hash['ap_mac'] = 'ap_mac'
  @_hash['renderer'] = 'renderer'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



67
68
69
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 67

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/untitled_api/models/api_v1_sites_pcaps_capture_request.rb', line 54

def self.optionals
  %w[
    type
    num_packets
    duration
    max_pkt_len
    includes_mcast
    ap_mac
    renderer
  ]
end