Class: Samsara::Types::VehicleStatsFaultCodesValueObdiiConfirmedDtcs

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

Overview

Passenger vehicle DTC information

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dtc_description: OMIT, dtc_id:, dtc_short_code: OMIT, additional_properties: nil) ⇒ Samsara::Types::VehicleStatsFaultCodesValueObdiiConfirmedDtcs

Parameters:

  • dtc_description (String) (defaults to: OMIT) —

    The DTC description, if available.

  • dtc_id (Integer) —

    The DTC identifier.

  • dtc_short_code (String) (defaults to: OMIT) —

    The DTC short code, if available.

  • 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/vehicle_stats_fault_codes_value_obdii_confirmed_dtcs.rb', line 28

def initialize(dtc_description: OMIT, dtc_id:, dtc_short_code: OMIT, additional_properties: nil)
  @dtc_description = dtc_description if dtc_description != OMIT
  @dtc_id = dtc_id
  @dtc_short_code = dtc_short_code if dtc_short_code != OMIT
  @additional_properties = additional_properties
  @_field_set = { "dtcDescription": dtc_description, "dtcId": dtc_id, "dtcShortCode": dtc_short_code }.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/vehicle_stats_fault_codes_value_obdii_confirmed_dtcs.rb', line 16

def additional_properties
  @additional_properties
end

#dtc_description ⇒ String (readonly)

Returns The DTC description, if available.

Returns:

  • (String) —

    The DTC description, if available.



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

def dtc_description
  @dtc_description
end

#dtc_id ⇒ Integer (readonly)

Returns The DTC identifier.

Returns:

  • (Integer) —

    The DTC identifier.



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

def dtc_id
  @dtc_id
end

#dtc_short_code ⇒ String (readonly)

Returns The DTC short code, if available.

Returns:

  • (String) —

    The DTC short code, if available.



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

def dtc_short_code
  @dtc_short_code
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  dtc_description = parsed_json["dtcDescription"]
  dtc_id = parsed_json["dtcId"]
  dtc_short_code = parsed_json["dtcShortCode"]
  new(
    dtc_description: dtc_description,
    dtc_id: dtc_id,
    dtc_short_code: dtc_short_code,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


68
69
70
71
72
 
# File 'lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_confirmed_dtcs.rb', line 68

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


59
60
61
 
# File 'lib/samsara_api/types/vehicle_stats_fault_codes_value_obdii_confirmed_dtcs.rb', line 59

def to_json
  @_field_set&.to_json
end