Class: Verizon::DataTriggerRequest

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

Overview

DataTriggerRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(comparator: SKIP, threshold: SKIP, threshold_unit: SKIP) ⇒ DataTriggerRequest

Returns a new instance of DataTriggerRequest.



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

def initialize(comparator: SKIP, threshold: SKIP, threshold_unit: SKIP)
  @comparator = comparator unless comparator == SKIP
  @threshold = threshold unless threshold == SKIP
  @threshold_unit = threshold_unit unless threshold_unit == SKIP
end

Instance Attribute Details

#comparatorString

TODO: Write general description for this method

Returns:

  • (String)


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

def comparator
  @comparator
end

#thresholdInteger

TODO: Write general description for this method

Returns:

  • (Integer)


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

def threshold
  @threshold
end

#threshold_unitString

TODO: Write general description for this method

Returns:

  • (String)


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

def threshold_unit
  @threshold_unit
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
# File 'lib/verizon/models/data_trigger_request.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  comparator = hash.key?('comparator') ? hash['comparator'] : SKIP
  threshold = hash.key?('threshold') ? hash['threshold'] : SKIP
  threshold_unit = hash.key?('thresholdUnit') ? hash['thresholdUnit'] : SKIP

  # Create object from extracted values.
  DataTriggerRequest.new(comparator: comparator,
                         threshold: threshold,
                         threshold_unit: threshold_unit)
end

.namesObject

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['comparator'] = 'comparator'
  @_hash['threshold'] = 'threshold'
  @_hash['threshold_unit'] = 'thresholdUnit'
  @_hash
end

.nullablesObject

An array for nullable fields



43
44
45
# File 'lib/verizon/models/data_trigger_request.rb', line 43

def self.nullables
  []
end

.optionalsObject

An array for optional fields



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

def self.optionals
  %w[
    comparator
    threshold
    threshold_unit
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



76
77
78
79
80
# File 'lib/verizon/models/data_trigger_request.rb', line 76

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} comparator: #{@comparator.inspect}, threshold: #{@threshold.inspect},"\
  " threshold_unit: #{@threshold_unit.inspect}>"
end

#to_sObject

Provides a human-readable string representation of the object.



69
70
71
72
73
# File 'lib/verizon/models/data_trigger_request.rb', line 69

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} comparator: #{@comparator}, threshold: #{@threshold}, threshold_unit:"\
  " #{@threshold_unit}>"
end