Class: Samsara::Types::AlertObjectOnvifCameraStreamResponseBody

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

Overview

A camera stream associated with the alert.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(camera_device: OMIT, id:, name: OMIT, tags: OMIT, additional_properties: nil) ⇒ Samsara::Types::AlertObjectOnvifCameraStreamResponseBody

Parameters:

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

    Additional properties unmapped to the current class definition



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/samsara_api/types/alert_object_onvif_camera_stream_response_body.rb', line 37

def initialize(camera_device: OMIT, id:, name: OMIT, tags: OMIT, additional_properties: nil)
  @camera_device = camera_device if camera_device != OMIT
  @id = id
  @name = name if name != OMIT
  @tags = tags if tags != OMIT
  @additional_properties = additional_properties
  @_field_set = { "cameraDevice": camera_device, "id": id, "name": name, "tags": tags }.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



22
23
24
 
# File 'lib/samsara_api/types/alert_object_onvif_camera_stream_response_body.rb', line 22

def additional_properties
  @additional_properties
end

#camera_device ⇒ Samsara::Types::AlertObjectWorkforceCameraDeviceResponseBody (readonly)

Returns:



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

def camera_device
  @camera_device
end

#id ⇒ String (readonly)

Returns The ID of the camera stream associated with the alert.

Returns:

  • (String) —

    The ID of the camera stream associated with the alert.



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

def id
  @id
end

#name ⇒ String (readonly)

Returns The name of the camera stream.

Returns:

  • (String) —

    The name of the camera stream.



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

def name
  @name
end

#tags ⇒ Object (readonly)

associated with the camera stream.



20
21
22
 
# File 'lib/samsara_api/types/alert_object_onvif_camera_stream_response_body.rb', line 20

def tags
  @tags
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/samsara_api/types/alert_object_onvif_camera_stream_response_body.rb', line 52

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  unless parsed_json["cameraDevice"].nil?
    camera_device = parsed_json["cameraDevice"].to_json
    camera_device = Samsara::Types::AlertObjectWorkforceCameraDeviceResponseBody.from_json(json_object: camera_device)
  else
    camera_device = nil
  end
  id = parsed_json["id"]
  name = parsed_json["name"]
  tags = parsed_json["tags"]&.map do | item |
  item = item.to_json
  Samsara::Types::GoaTagTinyResponseResponseBody.from_json(json_object: item)
end
  new(
    camera_device: camera_device,
    id: id,
    name: name,
    tags: tags,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


88
89
90
91
92
93
 
# File 'lib/samsara_api/types/alert_object_onvif_camera_stream_response_body.rb', line 88

def self.validate_raw(obj:)
  obj.camera_device.nil? || Samsara::Types::AlertObjectWorkforceCameraDeviceResponseBody.validate_raw(obj: obj.camera_device)
  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.tags&.is_a?(Array) != false || raise("Passed value for field obj.tags is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


79
80
81
 
# File 'lib/samsara_api/types/alert_object_onvif_camera_stream_response_body.rb', line 79

def to_json
  @_field_set&.to_json
end