Class: OCI::VnMonitoring::Models::VisibleTrafficNode

Inherits:
TrafficNode
  • Object
show all
Defined in:
lib/oci/vn_monitoring/models/visible_traffic_node.rb

Overview

Defines the configuration of a traffic node that is visible to the user.

Constant Summary

Constants inherited from TrafficNode

TrafficNode::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from TrafficNode

#egress_security_action, #egress_traffic, #ingress_security_action, #next_hop_routing_action, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TrafficNode

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ VisibleTrafficNode

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 66

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'VISIBLE'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.entity_id = attributes[:'entityId'] if attributes[:'entityId']

  raise 'You cannot provide both :entityId and :entity_id' if attributes.key?(:'entityId') && attributes.key?(:'entity_id')

  self.entity_id = attributes[:'entity_id'] if attributes[:'entity_id']

  self.transformation_description = attributes[:'transformationDescription'] if attributes[:'transformationDescription']

  raise 'You cannot provide both :transformationDescription and :transformation_description' if attributes.key?(:'transformationDescription') && attributes.key?(:'transformation_description')

  self.transformation_description = attributes[:'transformation_description'] if attributes[:'transformation_description']
end

Instance Attribute Details

#entity_id ⇒ String

The OCID of the OCI entity that represents the traffic node (Instance, GW, LB, etc.).

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 16

def entity_id
  @entity_id
end

#transformation_description ⇒ String

Describes how the traffic was transformed. For example, if an address is translated by a NAT GW, the string will describe the translation: 'SNAT: 10.0.0.1->204.0.0.1'

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 22

def transformation_description
  @transformation_description
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'egress_traffic': :'egressTraffic',
    'next_hop_routing_action': :'nextHopRoutingAction',
    'egress_security_action': :'egressSecurityAction',
    'ingress_security_action': :'ingressSecurityAction',
    'entity_id': :'entityId',
    'transformation_description': :'transformationDescription'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'egress_traffic': :'OCI::VnMonitoring::Models::EgressTrafficSpec',
    'next_hop_routing_action': :'OCI::VnMonitoring::Models::RoutingAction',
    'egress_security_action': :'OCI::VnMonitoring::Models::SecurityAction',
    'ingress_security_action': :'OCI::VnMonitoring::Models::SecurityAction',
    'entity_id': :'String',
    'transformation_description': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 96

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    egress_traffic == other.egress_traffic &&
    next_hop_routing_action == other.next_hop_routing_action &&
    egress_security_action == other.egress_security_action &&
    ingress_security_action == other.ingress_security_action &&
    entity_id == other.entity_id &&
    transformation_description == other.transformation_description
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 132

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


112
113
114
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 112

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 121

def hash
  [type, egress_traffic, next_hop_routing_action, egress_security_action, ingress_security_action, entity_id, transformation_description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 165

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



159
160
161
 
# File 'lib/oci/vn_monitoring/models/visible_traffic_node.rb', line 159

def to_s
  to_hash.to_s
end