Class: Samsara::Types::GatewayDetailsResponseResponseBody

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

Overview

Gateway-specific health metadata.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cell_connectivity: OMIT, gateway_battery_state: OMIT, gateway_battery_temp: OMIT, gateway_battery_volts: OMIT, last_check_in_time: OMIT, vehicle_battery_volts: OMIT, additional_properties: nil) ⇒ Samsara::Types::GatewayDetailsResponseResponseBody

Parameters:

  • cell_connectivity (Samsara::Types::CellConnectivityResponseResponseBody) (defaults to: OMIT)
  • gateway_battery_state (Samsara::Types::GatewayDetailsResponseResponseBodyGatewayBatteryState) (defaults to: OMIT) —

    The gateway’s battery state. Valid values: ‘low`, `ok`, `unknown`

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

    The battery temperature of the gateway, in degrees Celsius.

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

    The battery voltage of the gateway, in volts.

  • last_check_in_time (DateTime) (defaults to: OMIT) —

    The timestamp of the gateway’s last check-in, in RFC 3339 format.

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

    The battery voltage of the vehicle that gateway is connected to, in volts.

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

    Additional properties unmapped to the current class definition



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

def initialize(cell_connectivity: OMIT, gateway_battery_state: OMIT, gateway_battery_temp: OMIT, gateway_battery_volts: OMIT, last_check_in_time: OMIT, vehicle_battery_volts: OMIT, additional_properties: nil)
  @cell_connectivity = cell_connectivity if cell_connectivity != OMIT
  @gateway_battery_state = gateway_battery_state if gateway_battery_state != OMIT
  @gateway_battery_temp = gateway_battery_temp if gateway_battery_temp != OMIT
  @gateway_battery_volts = gateway_battery_volts if gateway_battery_volts != OMIT
  @last_check_in_time = last_check_in_time if last_check_in_time != OMIT
  @vehicle_battery_volts = vehicle_battery_volts if vehicle_battery_volts != OMIT
  @additional_properties = additional_properties
  @_field_set = { "cellConnectivity": cell_connectivity, "gatewayBatteryState": gateway_battery_state, "gatewayBatteryTemp": gateway_battery_temp, "gatewayBatteryVolts": gateway_battery_volts, "lastCheckInTime": last_check_in_time, "vehicleBatteryVolts": vehicle_battery_volts }.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



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

def additional_properties
  @additional_properties
end

#cell_connectivity ⇒ Samsara::Types::CellConnectivityResponseResponseBody (readonly)

Returns:



13
14
15
 
# File 'lib/samsara_api/types/gateway_details_response_response_body.rb', line 13

def cell_connectivity
  @cell_connectivity
end

#gateway_battery_state ⇒ Samsara::Types::GatewayDetailsResponseResponseBodyGatewayBatteryState (readonly)

Returns The gateway’s battery state. Valid values: ‘low`, `ok`, `unknown`.

Returns:



15
16
17
 
# File 'lib/samsara_api/types/gateway_details_response_response_body.rb', line 15

def gateway_battery_state
  @gateway_battery_state
end

#gateway_battery_temp ⇒ Float (readonly)

Returns The battery temperature of the gateway, in degrees Celsius.

Returns:

  • (Float) —

    The battery temperature of the gateway, in degrees Celsius.



17
18
19
 
# File 'lib/samsara_api/types/gateway_details_response_response_body.rb', line 17

def gateway_battery_temp
  @gateway_battery_temp
end

#gateway_battery_volts ⇒ Float (readonly)

Returns The battery voltage of the gateway, in volts.

Returns:

  • (Float) —

    The battery voltage of the gateway, in volts.



19
20
21
 
# File 'lib/samsara_api/types/gateway_details_response_response_body.rb', line 19

def gateway_battery_volts
  @gateway_battery_volts
end

#last_check_in_time ⇒ DateTime (readonly)

Returns The timestamp of the gateway’s last check-in, in RFC 3339 format.

Returns:

  • (DateTime) —

    The timestamp of the gateway’s last check-in, in RFC 3339 format.



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

def last_check_in_time
  @last_check_in_time
end

#vehicle_battery_volts ⇒ Float (readonly)

Returns The battery voltage of the vehicle that gateway is connected to, in volts.

Returns:

  • (Float) —

    The battery voltage of the vehicle that gateway is connected to, in volts.



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

def vehicle_battery_volts
  @vehicle_battery_volts
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/samsara_api/types/gateway_details_response_response_body.rb', line 56

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  unless parsed_json["cellConnectivity"].nil?
    cell_connectivity = parsed_json["cellConnectivity"].to_json
    cell_connectivity = Samsara::Types::CellConnectivityResponseResponseBody.from_json(json_object: cell_connectivity)
  else
    cell_connectivity = nil
  end
  gateway_battery_state = parsed_json["gatewayBatteryState"]
  gateway_battery_temp = parsed_json["gatewayBatteryTemp"]
  gateway_battery_volts = parsed_json["gatewayBatteryVolts"]
  last_check_in_time = unless parsed_json["lastCheckInTime"].nil?
  DateTime.parse(parsed_json["lastCheckInTime"])
else
  nil
end
  vehicle_battery_volts = parsed_json["vehicleBatteryVolts"]
  new(
    cell_connectivity: cell_connectivity,
    gateway_battery_state: gateway_battery_state,
    gateway_battery_temp: gateway_battery_temp,
    gateway_battery_volts: gateway_battery_volts,
    last_check_in_time: last_check_in_time,
    vehicle_battery_volts: vehicle_battery_volts,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


96
97
98
99
100
101
102
103
 
# File 'lib/samsara_api/types/gateway_details_response_response_body.rb', line 96

def self.validate_raw(obj:)
  obj.cell_connectivity.nil? || Samsara::Types::CellConnectivityResponseResponseBody.validate_raw(obj: obj.cell_connectivity)
  obj.gateway_battery_state&.is_a?(Samsara::Types::GatewayDetailsResponseResponseBodyGatewayBatteryState) != false || raise("Passed value for field obj.gateway_battery_state is not the expected type, validation failed.")
  obj.gateway_battery_temp&.is_a?(Float) != false || raise("Passed value for field obj.gateway_battery_temp is not the expected type, validation failed.")
  obj.gateway_battery_volts&.is_a?(Float) != false || raise("Passed value for field obj.gateway_battery_volts is not the expected type, validation failed.")
  obj.last_check_in_time&.is_a?(DateTime) != false || raise("Passed value for field obj.last_check_in_time is not the expected type, validation failed.")
  obj.vehicle_battery_volts&.is_a?(Float) != false || raise("Passed value for field obj.vehicle_battery_volts is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


87
88
89
 
# File 'lib/samsara_api/types/gateway_details_response_response_body.rb', line 87

def to_json
  @_field_set&.to_json
end