Class: UntitledApi::ApiV1OrgsPcapsCaptureRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/untitled_api/models/api_v1_orgs_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, tcpdump_expression = SKIP, mxedges = SKIP) ⇒ ApiV1OrgsPcapsCaptureRequest

Returns a new instance of ApiV1OrgsPcapsCaptureRequest.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/untitled_api/models/api_v1_orgs_pcaps_capture_request.rb', line 65

def initialize(type = SKIP,
               num_packets = SKIP,
               duration = SKIP,
               max_pkt_len = SKIP,
               tcpdump_expression = SKIP,
               mxedges = 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
  @tcpdump_expression = tcpdump_expression unless tcpdump_expression == SKIP
  @mxedges = mxedges unless mxedges == SKIP
end

Instance Attribute Details

#duration ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


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

def duration
  @duration
end

#max_pkt_len ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


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

def max_pkt_len
  @max_pkt_len
end

#mxedges ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


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

def mxedges
  @mxedges
end

#num_packets ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


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

def num_packets
  @num_packets
end

#tcpdump_expression ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def tcpdump_expression
  @tcpdump_expression
end

#type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/untitled_api/models/api_v1_orgs_pcaps_capture_request.rb', line 80

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
  tcpdump_expression =
    hash.key?('tcpdump_expression') ? hash['tcpdump_expression'] : SKIP
  mxedges = hash.key?('mxedges') ? hash['mxedges'] : SKIP

  # Create object from extracted values.
  ApiV1OrgsPcapsCaptureRequest.new(type,
                                   num_packets,
                                   duration,
                                   max_pkt_len,
                                   tcpdump_expression,
                                   mxedges)
end

.names ⇒ Object

A mapping from model property names to API property names.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/untitled_api/models/api_v1_orgs_pcaps_capture_request.rb', line 37

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['tcpdump_expression'] = 'tcpdump_expression'
  @_hash['mxedges'] = 'mxedges'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



61
62
63
 
# File 'lib/untitled_api/models/api_v1_orgs_pcaps_capture_request.rb', line 61

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/untitled_api/models/api_v1_orgs_pcaps_capture_request.rb', line 49

def self.optionals
  %w[
    type
    num_packets
    duration
    max_pkt_len
    tcpdump_expression
    mxedges
  ]
end