Class: Samsara::Types::HosBreak

Inherits:
Object
  • Object
show all
Defined in:
lib/samsara_api/types/hos_break.rb

Overview

Remaining durations for the HOS rest break requirement.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(time_until_break_duration_ms: OMIT, additional_properties: nil) ⇒ Samsara::Types::HosBreak

Parameters:

  • time_until_break_duration_ms (Float) (defaults to: OMIT) —

    Time until the driver has a required break in milliseconds.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



22
23
24
25
26
27
28
 
# File 'lib/samsara_api/types/hos_break.rb', line 22

def initialize(time_until_break_duration_ms: OMIT, additional_properties: nil)
  @time_until_break_duration_ms = time_until_break_duration_ms if time_until_break_duration_ms != OMIT
  @additional_properties = additional_properties
  @_field_set = { "timeUntilBreakDurationMs": time_until_break_duration_ms }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



12
13
14
 
# File 'lib/samsara_api/types/hos_break.rb', line 12

def additional_properties
  @additional_properties
end

#time_until_break_duration_ms ⇒ Float (readonly)

Returns Time until the driver has a required break in milliseconds.

Returns:

  • (Float) —

    Time until the driver has a required break in milliseconds.



10
11
12
 
# File 'lib/samsara_api/types/hos_break.rb', line 10

def time_until_break_duration_ms
  @time_until_break_duration_ms
end

Class Method Details

.from_json(json_object:) ⇒ Samsara::Types::HosBreak

Parameters:

  • json_object (String)

Returns:



33
34
35
36
37
38
 
# File 'lib/samsara_api/types/hos_break.rb', line 33

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  time_until_break_duration_ms = parsed_json["timeUntilBreakDurationMs"]
  new(time_until_break_duration_ms: time_until_break_duration_ms, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


51
52
53
 
# File 'lib/samsara_api/types/hos_break.rb', line 51

def self.validate_raw(obj:)
  obj.time_until_break_duration_ms&.is_a?(Float) != false || raise("Passed value for field obj.time_until_break_duration_ms is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


42
43
44
 
# File 'lib/samsara_api/types/hos_break.rb', line 42

def to_json
  @_field_set&.to_json
end