Class: Verizon::DataTrigger2

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

Overview

DataTrigger2 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(device_group = SKIP, condition_type = SKIP, comparitor = SKIP, threshold = SKIP, threshold_unit = SKIP, cycle_type = SKIP, allowance_threshold = SKIP, action = SKIP) ⇒ DataTrigger2

Returns a new instance of DataTrigger2.



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/verizon/models/data_trigger2.rb', line 82

def initialize(device_group = SKIP, condition_type = SKIP,
               comparitor = SKIP, threshold = SKIP, threshold_unit = SKIP,
               cycle_type = SKIP, allowance_threshold = SKIP, action = SKIP)
  @device_group = device_group unless device_group == SKIP
  @condition_type = condition_type unless condition_type == SKIP
  @comparitor = comparitor unless comparitor == SKIP
  @threshold = threshold unless threshold == SKIP
  @threshold_unit = threshold_unit unless threshold_unit == SKIP
  @cycle_type = cycle_type unless cycle_type == SKIP
  @allowance_threshold = allowance_threshold unless allowance_threshold == SKIP
  @action = action unless action == SKIP
end

Instance Attribute Details

#action ⇒ Actionobject

The interval to monitor for the threshold. This can be Daily, Weekly or Monthly

Returns:



47
48
49
 
# File 'lib/verizon/models/data_trigger2.rb', line 47

def action
  @action
end

#allowance_threshold ⇒ AllowanceThreshold

The interval to monitor for the threshold. This can be Daily, Weekly or Monthly

Returns:



42
43
44
 
# File 'lib/verizon/models/data_trigger2.rb', line 42

def allowance_threshold
  @allowance_threshold
end

#comparitor ⇒ ComparitorEnum

The boolean of the comparison. ‘gt` is Greater Than, `lt` is Less Than and `eq` is Equal To

Returns:



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

def comparitor
  @comparitor
end

#condition_type ⇒ ConditionTypeEnum

The condition type being monitored

Returns:



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

def condition_type
  @condition_type
end

#cycle_type ⇒ RulesCycleTypeEnum

The interval to monitor for the threshold. This can be Daily, Weekly or Monthly

Returns:



37
38
39
 
# File 'lib/verizon/models/data_trigger2.rb', line 37

def cycle_type
  @cycle_type
end

#device_group ⇒ DeviceGroupFilterCriteria

TODO: Write general description for this method

Returns:



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

def device_group
  @device_group
end

#threshold ⇒ Integer

The threshold value the trigger monitors for

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/verizon/models/data_trigger2.rb', line 27

def threshold
  @threshold
end

#threshold_unit ⇒ ThresholdUnitEnum

The units of the threshold. This can be KB, Kilobits, MB, Megabits, or GB, Gigabits

Returns:



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

def threshold_unit
  @threshold_unit
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/verizon/models/data_trigger2.rb', line 96

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  device_group = DeviceGroupFilterCriteria.from_hash(hash['deviceGroup']) if
    hash['deviceGroup']
  condition_type = hash.key?('conditionType') ? hash['conditionType'] : SKIP
  comparitor = hash.key?('comparitor') ? hash['comparitor'] : SKIP
  threshold = hash.key?('threshold') ? hash['threshold'] : SKIP
  threshold_unit = hash.key?('thresholdUnit') ? hash['thresholdUnit'] : SKIP
  cycle_type = hash.key?('cycleType') ? hash['cycleType'] : SKIP
  allowance_threshold = AllowanceThreshold.from_hash(hash['allowanceThreshold']) if
    hash['allowanceThreshold']
  action = Actionobject.from_hash(hash['action']) if hash['action']

  # Create object from extracted values.
  DataTrigger2.new(device_group,
                   condition_type,
                   comparitor,
                   threshold,
                   threshold_unit,
                   cycle_type,
                   allowance_threshold,
                   action)
end

.names ⇒ Object

A mapping from model property names to API property names.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/verizon/models/data_trigger2.rb', line 50

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['device_group'] = 'deviceGroup'
  @_hash['condition_type'] = 'conditionType'
  @_hash['comparitor'] = 'comparitor'
  @_hash['threshold'] = 'threshold'
  @_hash['threshold_unit'] = 'thresholdUnit'
  @_hash['cycle_type'] = 'cycleType'
  @_hash['allowance_threshold'] = 'allowanceThreshold'
  @_hash['action'] = 'action'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



78
79
80
 
# File 'lib/verizon/models/data_trigger2.rb', line 78

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/verizon/models/data_trigger2.rb', line 64

def self.optionals
  %w[
    device_group
    condition_type
    comparitor
    threshold
    threshold_unit
    cycle_type
    allowance_threshold
    action
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (DataTrigger2 | Hash) —

    value against the validation is performed.



124
125
126
127
128
129
130
 
# File 'lib/verizon/models/data_trigger2.rb', line 124

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



142
143
144
145
146
147
148
149
 
# File 'lib/verizon/models/data_trigger2.rb', line 142

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} device_group: #{@device_group.inspect}, condition_type:"\
  " #{@condition_type.inspect}, comparitor: #{@comparitor.inspect}, threshold:"\
  " #{@threshold.inspect}, threshold_unit: #{@threshold_unit.inspect}, cycle_type:"\
  " #{@cycle_type.inspect}, allowance_threshold: #{@allowance_threshold.inspect}, action:"\
  " #{@action.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



133
134
135
136
137
138
139
 
# File 'lib/verizon/models/data_trigger2.rb', line 133

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} device_group: #{@device_group}, condition_type: #{@condition_type},"\
  " comparitor: #{@comparitor}, threshold: #{@threshold}, threshold_unit: #{@threshold_unit},"\
  " cycle_type: #{@cycle_type}, allowance_threshold: #{@allowance_threshold}, action:"\
  " #{@action}>"
end