Class: Verizon::HistorySearchFilter

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

Overview

The selected device and attributes for which a request should retrieve data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(account_name = nil, device = nil, attributes = SKIP) ⇒ HistorySearchFilter

Returns a new instance of HistorySearchFilter.



45
46
47
48
49
50
51
 
# File 'lib/verizon/models/history_search_filter.rb', line 45

def initialize( = nil,
               device = nil,
               attributes = SKIP)
  @account_name = 
  @device = device
  @attributes = attributes unless attributes == SKIP
end

Instance Attribute Details

#account_name ⇒ String

Account name identifier.

Returns:

  • (String) 


14
15
16
 
# File 'lib/verizon/models/history_search_filter.rb', line 14

def 
  @account_name
end

#attributes ⇒ HistorySearchFilterAttributes

Streaming RF parameters for which you want to retrieve history data.

Returns:



22
23
24
 
# File 'lib/verizon/models/history_search_filter.rb', line 22

def attributes
  @attributes
end

#device ⇒ Device

Identifies a particular IoT device.

Returns:



18
19
20
 
# File 'lib/verizon/models/history_search_filter.rb', line 18

def device
  @device
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/verizon/models/history_search_filter.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
   = hash.key?('accountName') ? hash['accountName'] : nil
  device = Device.from_hash(hash['device']) if hash['device']
  attributes = HistorySearchFilterAttributes.from_hash(hash['attributes']) if
    hash['attributes']

  # Create object from extracted values.
  HistorySearchFilter.new(,
                          device,
                          attributes)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/verizon/models/history_search_filter.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_name'] = 'accountName'
  @_hash['device'] = 'device'
  @_hash['attributes'] = 'attributes'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



41
42
43
 
# File 'lib/verizon/models/history_search_filter.rb', line 41

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
 
# File 'lib/verizon/models/history_search_filter.rb', line 34

def self.optionals
  %w[
    attributes
  ]
end