Class: Samsara::Types::EquipmentStatsResponseData

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

Overview

A unit of equipment and its most recent stat.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(engine_rpm: OMIT, engine_seconds: OMIT, engine_state: OMIT, engine_total_idle_time_minutes: OMIT, fuel_percent: OMIT, gateway_engine_seconds: OMIT, gateway_engine_state: OMIT, gps: OMIT, gps_odometer_meters: OMIT, id:, name:, obd_engine_seconds: OMIT, obd_engine_state: OMIT, additional_properties: nil) ⇒ Samsara::Types::EquipmentStatsResponseData

Parameters:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 69

def initialize(engine_rpm: OMIT, engine_seconds: OMIT, engine_state: OMIT, engine_total_idle_time_minutes: OMIT, fuel_percent: OMIT, gateway_engine_seconds: OMIT, gateway_engine_state: OMIT, gps: OMIT, gps_odometer_meters: OMIT, id:, name:, obd_engine_seconds: OMIT, obd_engine_state: OMIT, additional_properties: nil)
  @engine_rpm = engine_rpm if engine_rpm != OMIT
  @engine_seconds = engine_seconds if engine_seconds != OMIT
  @engine_state = engine_state if engine_state != OMIT
  @engine_total_idle_time_minutes = engine_total_idle_time_minutes if engine_total_idle_time_minutes != OMIT
  @fuel_percent = fuel_percent if fuel_percent != OMIT
  @gateway_engine_seconds = gateway_engine_seconds if gateway_engine_seconds != OMIT
  @gateway_engine_state = gateway_engine_state if gateway_engine_state != OMIT
  @gps = gps if gps != OMIT
  @gps_odometer_meters = gps_odometer_meters if gps_odometer_meters != OMIT
  @id = id
  @name = name
  @obd_engine_seconds = obd_engine_seconds if obd_engine_seconds != OMIT
  @obd_engine_state = obd_engine_state if obd_engine_state != OMIT
  @additional_properties = additional_properties
  @_field_set = { "engineRpm": engine_rpm, "engineSeconds": engine_seconds, "engineState": engine_state, "engineTotalIdleTimeMinutes": engine_total_idle_time_minutes, "fuelPercent": fuel_percent, "gatewayEngineSeconds": gateway_engine_seconds, "gatewayEngineState": gateway_engine_state, "gps": gps, "gpsOdometerMeters": gps_odometer_meters, "id": id, "name": name, "obdEngineSeconds": obd_engine_seconds, "obdEngineState": obd_engine_state }.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



47
48
49
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 47

def additional_properties
  @additional_properties
end

#engine_rpm ⇒ Samsara::Types::EquipmentEngineRpm (readonly)

Returns:



21
22
23
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 21

def engine_rpm
  @engine_rpm
end

#engine_seconds ⇒ Samsara::Types::EquipmentEngineSeconds (readonly)

Returns:



23
24
25
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 23

def engine_seconds
  @engine_seconds
end

#engine_state ⇒ Samsara::Types::EquipmentEngineState (readonly)

Returns:



25
26
27
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 25

def engine_state
  @engine_state
end

#engine_total_idle_time_minutes ⇒ Samsara::Types::EquipmentEngineTotalIdleTimeMinutes (readonly)

Returns:



27
28
29
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 27

def engine_total_idle_time_minutes
  @engine_total_idle_time_minutes
end

#fuel_percent ⇒ Samsara::Types::EquipmentFuelPercent (readonly)

Returns:



29
30
31
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 29

def fuel_percent
  @fuel_percent
end

#gateway_engine_seconds ⇒ Samsara::Types::EquipmentGatewayEngineSeconds (readonly)

Returns:



31
32
33
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 31

def gateway_engine_seconds
  @gateway_engine_seconds
end

#gateway_engine_state ⇒ Samsara::Types::EquipmentGatewayEngineState (readonly)

Returns:



33
34
35
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 33

def gateway_engine_state
  @gateway_engine_state
end

#gps ⇒ Samsara::Types::EquipmentStatsGps (readonly)

Returns:



35
36
37
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 35

def gps
  @gps
end

#gps_odometer_meters ⇒ Samsara::Types::EquipmentGpsOdometerMeters (readonly)

Returns:



37
38
39
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 37

def gps_odometer_meters
  @gps_odometer_meters
end

#id ⇒ String (readonly)

Returns:

  • (String) 


39
40
41
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 39

def id
  @id
end

#name ⇒ String (readonly)

Returns:

  • (String) 


41
42
43
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 41

def name
  @name
end

#obd_engine_seconds ⇒ Samsara::Types::EquipmentObdEngineSeconds (readonly)

Returns:



43
44
45
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 43

def obd_engine_seconds
  @obd_engine_seconds
end

#obd_engine_state ⇒ Samsara::Types::EquipmentObdEngineState (readonly)

Returns:



45
46
47
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 45

def obd_engine_state
  @obd_engine_state
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 92

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  unless parsed_json["engineRpm"].nil?
    engine_rpm = parsed_json["engineRpm"].to_json
    engine_rpm = Samsara::Types::EquipmentEngineRpm.from_json(json_object: engine_rpm)
  else
    engine_rpm = nil
  end
  unless parsed_json["engineSeconds"].nil?
    engine_seconds = parsed_json["engineSeconds"].to_json
    engine_seconds = Samsara::Types::EquipmentEngineSeconds.from_json(json_object: engine_seconds)
  else
    engine_seconds = nil
  end
  unless parsed_json["engineState"].nil?
    engine_state = parsed_json["engineState"].to_json
    engine_state = Samsara::Types::EquipmentEngineState.from_json(json_object: engine_state)
  else
    engine_state = nil
  end
  unless parsed_json["engineTotalIdleTimeMinutes"].nil?
    engine_total_idle_time_minutes = parsed_json["engineTotalIdleTimeMinutes"].to_json
    engine_total_idle_time_minutes = Samsara::Types::EquipmentEngineTotalIdleTimeMinutes.from_json(json_object: engine_total_idle_time_minutes)
  else
    engine_total_idle_time_minutes = nil
  end
  unless parsed_json["fuelPercent"].nil?
    fuel_percent = parsed_json["fuelPercent"].to_json
    fuel_percent = Samsara::Types::EquipmentFuelPercent.from_json(json_object: fuel_percent)
  else
    fuel_percent = nil
  end
  unless parsed_json["gatewayEngineSeconds"].nil?
    gateway_engine_seconds = parsed_json["gatewayEngineSeconds"].to_json
    gateway_engine_seconds = Samsara::Types::EquipmentGatewayEngineSeconds.from_json(json_object: gateway_engine_seconds)
  else
    gateway_engine_seconds = nil
  end
  unless parsed_json["gatewayEngineState"].nil?
    gateway_engine_state = parsed_json["gatewayEngineState"].to_json
    gateway_engine_state = Samsara::Types::EquipmentGatewayEngineState.from_json(json_object: gateway_engine_state)
  else
    gateway_engine_state = nil
  end
  unless parsed_json["gps"].nil?
    gps = parsed_json["gps"].to_json
    gps = Samsara::Types::EquipmentStatsGps.from_json(json_object: gps)
  else
    gps = nil
  end
  unless parsed_json["gpsOdometerMeters"].nil?
    gps_odometer_meters = parsed_json["gpsOdometerMeters"].to_json
    gps_odometer_meters = Samsara::Types::EquipmentGpsOdometerMeters.from_json(json_object: gps_odometer_meters)
  else
    gps_odometer_meters = nil
  end
  id = parsed_json["id"]
  name = parsed_json["name"]
  unless parsed_json["obdEngineSeconds"].nil?
    obd_engine_seconds = parsed_json["obdEngineSeconds"].to_json
    obd_engine_seconds = Samsara::Types::EquipmentObdEngineSeconds.from_json(json_object: obd_engine_seconds)
  else
    obd_engine_seconds = nil
  end
  unless parsed_json["obdEngineState"].nil?
    obd_engine_state = parsed_json["obdEngineState"].to_json
    obd_engine_state = Samsara::Types::EquipmentObdEngineState.from_json(json_object: obd_engine_state)
  else
    obd_engine_state = nil
  end
  new(
    engine_rpm: engine_rpm,
    engine_seconds: engine_seconds,
    engine_state: engine_state,
    engine_total_idle_time_minutes: engine_total_idle_time_minutes,
    fuel_percent: fuel_percent,
    gateway_engine_seconds: gateway_engine_seconds,
    gateway_engine_state: gateway_engine_state,
    gps: gps,
    gps_odometer_meters: gps_odometer_meters,
    id: id,
    name: name,
    obd_engine_seconds: obd_engine_seconds,
    obd_engine_state: obd_engine_state,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 192

def self.validate_raw(obj:)
  obj.engine_rpm.nil? || Samsara::Types::EquipmentEngineRpm.validate_raw(obj: obj.engine_rpm)
  obj.engine_seconds.nil? || Samsara::Types::EquipmentEngineSeconds.validate_raw(obj: obj.engine_seconds)
  obj.engine_state.nil? || Samsara::Types::EquipmentEngineState.validate_raw(obj: obj.engine_state)
  obj.engine_total_idle_time_minutes.nil? || Samsara::Types::EquipmentEngineTotalIdleTimeMinutes.validate_raw(obj: obj.engine_total_idle_time_minutes)
  obj.fuel_percent.nil? || Samsara::Types::EquipmentFuelPercent.validate_raw(obj: obj.fuel_percent)
  obj.gateway_engine_seconds.nil? || Samsara::Types::EquipmentGatewayEngineSeconds.validate_raw(obj: obj.gateway_engine_seconds)
  obj.gateway_engine_state.nil? || Samsara::Types::EquipmentGatewayEngineState.validate_raw(obj: obj.gateway_engine_state)
  obj.gps.nil? || Samsara::Types::EquipmentStatsGps.validate_raw(obj: obj.gps)
  obj.gps_odometer_meters.nil? || Samsara::Types::EquipmentGpsOdometerMeters.validate_raw(obj: obj.gps_odometer_meters)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.obd_engine_seconds.nil? || Samsara::Types::EquipmentObdEngineSeconds.validate_raw(obj: obj.obd_engine_seconds)
  obj.obd_engine_state.nil? || Samsara::Types::EquipmentObdEngineState.validate_raw(obj: obj.obd_engine_state)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


183
184
185
 
# File 'lib/samsara_api/types/equipment_stats_response_data.rb', line 183

def to_json
  @_field_set&.to_json
end