Class: Verizon::SearchDeviceEventHistoryRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/search_device_event_history_request.rb

Overview

Search Device By Property resource definition.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(accountidentifier = nil, resourceidentifier = nil, selection = SKIP, limitnumber = SKIP, page = SKIP) ⇒ SearchDeviceEventHistoryRequest

Returns a new instance of SearchDeviceEventHistoryRequest.



63
64
65
66
67
68
69
70
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 63

def initialize(accountidentifier = nil, resourceidentifier = nil,
               selection = SKIP, limitnumber = SKIP, page = SKIP)
  @accountidentifier = accountidentifier
  @selection = selection unless selection == SKIP
  @resourceidentifier = resourceidentifier
  @limitnumber = limitnumber unless limitnumber == SKIP
  @page = page unless page == SKIP
end

Instance Attribute Details

#accountidentifier ⇒ AccountIdentifier

The ID of the authenticating billing account, in the format ‘“billingaccountid”:“1234567890-12345”`.

Returns:



15
16
17
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 15

def accountidentifier
  @accountidentifier
end

#limitnumber ⇒ Integer

The maximum number of events to include in the response.

Returns:

  • (Integer) 


32
33
34
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 32

def limitnumber
  @limitnumber
end

#page ⇒ String

The maximum number of events to include in the response.

Returns:

  • (String) 


36
37
38
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 36

def page
  @page
end

#resourceidentifier ⇒ ResourceIdentifier

The ID of the target to delete, in the format “dd1682d3-2d80-cefc-f3ee-25154800beff”.

Returns:



28
29
30
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 28

def resourceidentifier
  @resourceidentifier
end

#selection ⇒ Hash[String, String]

A comma-separated list of properties and comparator values to match against subscriptions in the ThingSpace account. See Working with Query Filters for more information. If the request does not include ‘$selection`, the response will include all subscriptions to which the requesting user has access.

Returns:

  • (Hash[String, String]) 


23
24
25
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 23

def selection
  @selection
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 73

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  accountidentifier = AccountIdentifier.from_hash(hash['accountidentifier']) if
    hash['accountidentifier']
  resourceidentifier = ResourceIdentifier.from_hash(hash['resourceidentifier']) if
    hash['resourceidentifier']
  selection = hash.key?('$selection') ? hash['$selection'] : SKIP
  limitnumber = hash.key?('$limitnumber') ? hash['$limitnumber'] : SKIP
  page = hash.key?('$page') ? hash['$page'] : SKIP

  # Create object from extracted values.
  SearchDeviceEventHistoryRequest.new(accountidentifier,
                                      resourceidentifier,
                                      selection,
                                      limitnumber,
                                      page)
end

.names ⇒ Object

A mapping from model property names to API property names.



39
40
41
42
43
44
45
46
47
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 39

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['accountidentifier'] = 'accountidentifier'
  @_hash['selection'] = '$selection'
  @_hash['resourceidentifier'] = 'resourceidentifier'
  @_hash['limitnumber'] = '$limitnumber'
  @_hash['page'] = '$page'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



59
60
61
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 59

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



50
51
52
53
54
55
56
 
# File 'lib/verizon/models/search_device_event_history_request.rb', line 50

def self.optionals
  %w[
    selection
    limitnumber
    page
  ]
end