Class: Samsara::Types::DistanceTraveledObjectResponseBody

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

Overview

The distance traveled information of the log.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(drive_distance_meters: OMIT, personal_conveyance_distance_meters: OMIT, yard_move_distance_meters: OMIT, additional_properties: nil) ⇒ Samsara::Types::DistanceTraveledObjectResponseBody

Parameters:

  • drive_distance_meters (Long) (defaults to: OMIT) —

    Distance driven in meters, rounded to two decimal places.

  • personal_conveyance_distance_meters (Long) (defaults to: OMIT) —

    Distance driven for personal conveyance, rounded to two decimal places.

  • yard_move_distance_meters (Long) (defaults to: OMIT) —

    Distance driven for yard moves, rounded to two decimal places.

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

    Additional properties unmapped to the current class definition



28
29
30
31
32
33
34
35
36
 
# File 'lib/samsara_api/types/distance_traveled_object_response_body.rb', line 28

def initialize(drive_distance_meters: OMIT, personal_conveyance_distance_meters: OMIT, yard_move_distance_meters: OMIT, additional_properties: nil)
  @drive_distance_meters = drive_distance_meters if drive_distance_meters != OMIT
  @personal_conveyance_distance_meters = personal_conveyance_distance_meters if personal_conveyance_distance_meters != OMIT
  @yard_move_distance_meters = yard_move_distance_meters if yard_move_distance_meters != OMIT
  @additional_properties = additional_properties
  @_field_set = { "driveDistanceMeters": drive_distance_meters, "personalConveyanceDistanceMeters": personal_conveyance_distance_meters, "yardMoveDistanceMeters": yard_move_distance_meters }.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



16
17
18
 
# File 'lib/samsara_api/types/distance_traveled_object_response_body.rb', line 16

def additional_properties
  @additional_properties
end

#drive_distance_meters ⇒ Long (readonly)

Returns Distance driven in meters, rounded to two decimal places.

Returns:

  • (Long) —

    Distance driven in meters, rounded to two decimal places.



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

def drive_distance_meters
  @drive_distance_meters
end

#personal_conveyance_distance_meters ⇒ Long (readonly)

Returns Distance driven for personal conveyance, rounded to two decimal places.

Returns:

  • (Long) —

    Distance driven for personal conveyance, rounded to two decimal places.



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

def personal_conveyance_distance_meters
  @personal_conveyance_distance_meters
end

#yard_move_distance_meters ⇒ Long (readonly)

Returns Distance driven for yard moves, rounded to two decimal places.

Returns:

  • (Long) —

    Distance driven for yard moves, rounded to two decimal places.



14
15
16
 
# File 'lib/samsara_api/types/distance_traveled_object_response_body.rb', line 14

def yard_move_distance_meters
  @yard_move_distance_meters
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/samsara_api/types/distance_traveled_object_response_body.rb', line 41

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  drive_distance_meters = parsed_json["driveDistanceMeters"]
  personal_conveyance_distance_meters = parsed_json["personalConveyanceDistanceMeters"]
  yard_move_distance_meters = parsed_json["yardMoveDistanceMeters"]
  new(
    drive_distance_meters: drive_distance_meters,
    personal_conveyance_distance_meters: personal_conveyance_distance_meters,
    yard_move_distance_meters: yard_move_distance_meters,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


66
67
68
69
70
 
# File 'lib/samsara_api/types/distance_traveled_object_response_body.rb', line 66

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


57
58
59
 
# File 'lib/samsara_api/types/distance_traveled_object_response_body.rb', line 57

def to_json
  @_field_set&.to_json
end