Class: Samsara::Types::ScopeObjectRequestBody

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

Overview

What the triggers are scoped to. These are the objects this alert applies to.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(all:, assets: OMIT, drivers: OMIT, tags: OMIT, widgets: OMIT, additional_properties: nil) ⇒ Samsara::Types::ScopeObjectRequestBody

Parameters:



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

def initialize(all:, assets: OMIT, drivers: OMIT, tags: OMIT, widgets: OMIT, additional_properties: nil)
  @all = all
  @assets = assets if assets != OMIT
  @drivers = drivers if drivers != OMIT
  @tags = tags if tags != OMIT
  @widgets = widgets if widgets != OMIT
  @additional_properties = additional_properties
  @_field_set = { "all": all, "assets": assets, "drivers": drivers, "tags": tags, "widgets": widgets }.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



24
25
26
 
# File 'lib/samsara_api/types/scope_object_request_body.rb', line 24

def additional_properties
  @additional_properties
end

#all ⇒ Boolean (readonly)

Returns Whether it applies to all applicable objects.

Returns:

  • (Boolean) —

    Whether it applies to all applicable objects.



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

def all
  @all
end

#assets ⇒ Array<Samsara::Types::TinyAssetObjectRequestBody> (readonly)

Returns The assets these triggers are scoped to.

Returns:



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

def assets
  @assets
end

#drivers ⇒ Array<Samsara::Types::TinyDriverObjectRequestBody> (readonly)

Returns The drivers these triggers are scoped to.

Returns:



18
19
20
 
# File 'lib/samsara_api/types/scope_object_request_body.rb', line 18

def drivers
  @drivers
end

#tags ⇒ Array<Samsara::Types::GoaTagTinyResponseRequestBody> (readonly)

Returns The tags these triggers are scoped to.

Returns:



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

def tags
  @tags
end

#widgets ⇒ Array<Samsara::Types::TinyWidgetObjectRequestBody> (readonly)

Returns The widgets these triggers are scoped to.

Returns:



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

def widgets
  @widgets
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



53
54
55
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
 
# File 'lib/samsara_api/types/scope_object_request_body.rb', line 53

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  all = parsed_json["all"]
  assets = parsed_json["assets"]&.map do | item |
  item = item.to_json
  Samsara::Types::TinyAssetObjectRequestBody.from_json(json_object: item)
end
  drivers = parsed_json["drivers"]&.map do | item |
  item = item.to_json
  Samsara::Types::TinyDriverObjectRequestBody.from_json(json_object: item)
end
  tags = parsed_json["tags"]&.map do | item |
  item = item.to_json
  Samsara::Types::GoaTagTinyResponseRequestBody.from_json(json_object: item)
end
  widgets = parsed_json["widgets"]&.map do | item |
  item = item.to_json
  Samsara::Types::TinyWidgetObjectRequestBody.from_json(json_object: item)
end
  new(
    all: all,
    assets: assets,
    drivers: drivers,
    tags: tags,
    widgets: widgets,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


94
95
96
97
98
99
100
 
# File 'lib/samsara_api/types/scope_object_request_body.rb', line 94

def self.validate_raw(obj:)
  obj.all.is_a?(Boolean) != false || raise("Passed value for field obj.all is not the expected type, validation failed.")
  obj.assets&.is_a?(Array) != false || raise("Passed value for field obj.assets is not the expected type, validation failed.")
  obj.drivers&.is_a?(Array) != false || raise("Passed value for field obj.drivers 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.")
  obj.widgets&.is_a?(Array) != false || raise("Passed value for field obj.widgets is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


85
86
87
 
# File 'lib/samsara_api/types/scope_object_request_body.rb', line 85

def to_json
  @_field_set&.to_json
end