Class: Samsara::Types::AlertObjectSitesResponseBody

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

Overview

A site 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(id:, name: OMIT, tags: OMIT, additional_properties: nil) ⇒ Samsara::Types::AlertObjectSitesResponseBody

Parameters:

  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



33
34
35
36
37
38
39
40
41
# File 'lib/samsara_api/types/alert_object_sites_response_body.rb', line 33

def initialize(id:, name: OMIT, tags: OMIT, additional_properties: nil)
  @id = id
  @name = name if name != OMIT
  @tags = tags if tags != OMIT
  @additional_properties = additional_properties
  @_field_set = { "id": id, "name": name, "tags": tags }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_propertiesOpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct)

    Additional properties unmapped to the current class definition



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

def additional_properties
  @additional_properties
end

#idString (readonly)

Returns The ID of the site associated with the alert.

Returns:

  • (String)

    The ID of the site associated with the alert



11
12
13
# File 'lib/samsara_api/types/alert_object_sites_response_body.rb', line 11

def id
  @id
end

#nameString (readonly)

Returns The name of the site.

Returns:

  • (String)

    The name of the site



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

def name
  @name
end

#tagsObject (readonly)

associated with the Site.



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

def tags
  @tags
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/samsara_api/types/alert_object_sites_response_body.rb', line 46

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  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(
    id: id,
    name: name,
    tags: tags,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void)


74
75
76
77
78
# File 'lib/samsara_api/types/alert_object_sites_response_body.rb', line 74

def self.validate_raw(obj:)
  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_jsonString

Returns:

  • (String)


65
66
67
# File 'lib/samsara_api/types/alert_object_sites_response_body.rb', line 65

def to_json
  @_field_set&.to_json
end