Class: MistApi::SwitchPortUsageDynamicRule

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/mist_api/models/switch_port_usage_dynamic_rule.rb

Overview

SwitchPortUsageDynamicRule 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(src = nil, description = SKIP, equals = SKIP, equals_any = SKIP, expression = SKIP, usage = SKIP) ⇒ SwitchPortUsageDynamicRule

Returns a new instance of SwitchPortUsageDynamicRule.



69
70
71
72
73
74
75
76
77
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 69

def initialize(src = nil, description = SKIP, equals = SKIP,
               equals_any = SKIP, expression = SKIP, usage = SKIP)
  @description = description unless description == SKIP
  @equals = equals unless equals == SKIP
  @equals_any = equals_any unless equals_any == SKIP
  @expression = expression unless expression == SKIP
  @src = src
  @usage = usage unless usage == SKIP
end

Instance Attribute Details

#description ⇒ String

Optional description of the rule

Returns:

  • (String) 


14
15
16
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 14

def description
  @description
end

#equals ⇒ String

Optional description of the rule

Returns:

  • (String) 


18
19
20
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 18

def equals
  @equals
end

#equals_any ⇒ Array[String]

Use ‘equals_any` to match any item in a list

Returns:

  • (Array[String]) 


22
23
24
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 22

def equals_any
  @equals_any
end

#expression ⇒ String

“[0:3]”:“abcdef” -> “abc” “split(.)”: “a.b.c” -> “b” “split(-)[0:3]: ”a1234-b5678-c90“ -> ”b56“

Returns:

  • (String) 


28
29
30
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 28

def expression
  @expression
end

#src ⇒ SwitchPortUsageDynamicRuleSrcEnum

enum: ‘link_peermac`, `lldp_chassis_id`, `lldp_hardware_revision`, `lldp_manufacturer_name`, `lldp_oui`, `lldp_serial_number`, `lldp_system_description`, `lldp_system_name`, `radius_dynamicfilter`, `radius_usermac`, `radius_username`

Returns:



35
36
37
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 35

def src
  @src
end

#usage ⇒ String

‘port_usage` name

Returns:

  • (String) 


39
40
41
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 39

def usage
  @usage
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 80

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  src = hash.key?('src') ? hash['src'] : nil
  description = hash.key?('description') ? hash['description'] : SKIP
  equals = hash.key?('equals') ? hash['equals'] : SKIP
  equals_any = hash.key?('equals_any') ? hash['equals_any'] : SKIP
  expression = hash.key?('expression') ? hash['expression'] : SKIP
  usage = hash.key?('usage') ? hash['usage'] : SKIP

  # Create object from extracted values.
  SwitchPortUsageDynamicRule.new(src,
                                 description,
                                 equals,
                                 equals_any,
                                 expression,
                                 usage)
end

.names ⇒ Object

A mapping from model property names to API property names.



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 42

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['description'] = 'description'
  @_hash['equals'] = 'equals'
  @_hash['equals_any'] = 'equals_any'
  @_hash['expression'] = 'expression'
  @_hash['src'] = 'src'
  @_hash['usage'] = 'usage'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



65
66
67
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 65

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



54
55
56
57
58
59
60
61
62
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 54

def self.optionals
  %w[
    description
    equals
    equals_any
    expression
    usage
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 102

def self.validate(value)
  if value.instance_of? self
    return APIHelper.valid_type?(value.src,
                                 ->(val) { SwitchPortUsageDynamicRuleSrcEnum.validate(val) })
  end

  return false unless value.instance_of? Hash

  APIHelper.valid_type?(value['src'],
                        ->(val) { SwitchPortUsageDynamicRuleSrcEnum.validate(val) })
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



122
123
124
125
126
127
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 122

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} description: #{@description.inspect}, equals: #{@equals.inspect},"\
  " equals_any: #{@equals_any.inspect}, expression: #{@expression.inspect}, src:"\
  " #{@src.inspect}, usage: #{@usage.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



115
116
117
118
119
 
# File 'lib/mist_api/models/switch_port_usage_dynamic_rule.rb', line 115

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} description: #{@description}, equals: #{@equals}, equals_any:"\
  " #{@equals_any}, expression: #{@expression}, src: #{@src}, usage: #{@usage}>"
end