Class: OCI::VnMonitoring::Models::TrafficRoute

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

Overview

Defines the traffic route taken in the path in PathAnalysisResult.

Constant Summary collapse

REACHABILITY_STATUS_ENUM = 
[
  REACHABILITY_STATUS_REACHABLE = 'REACHABLE'.freeze,
  REACHABILITY_STATUS_UNREACHABLE = 'UNREACHABLE'.freeze,
  REACHABILITY_STATUS_INDETERMINATE = 'INDETERMINATE'.freeze,
  REACHABILITY_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TrafficRoute

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 64

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

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

  self.reachability_status = attributes[:'reachabilityStatus'] if attributes[:'reachabilityStatus']

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

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

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

  self.route_analysis_description = attributes[:'routeAnalysisDescription'] if attributes[:'routeAnalysisDescription']

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

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

Instance Attribute Details

#nodes ⇒ Array<OCI::VnMonitoring::Models::TrafficNode>

[Required] The ordered sequence of nodes in the given the traffic route forming a path.

Returns:



25
26
27
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 25

def nodes
  @nodes
end

#reachability_status ⇒ String

[Required] Reachability status for the given traffic route.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 21

def reachability_status
  @reachability_status
end

#route_analysis_description ⇒ String

A description of the traffic route analysis. For example: "Traffic might not reach a destination due to the LB backend being unhealthy".

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 31

def route_analysis_description
  @route_analysis_description
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'reachability_status': :'reachabilityStatus',
    'nodes': :'nodes',
    'route_analysis_description': :'routeAnalysisDescription'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'reachability_status': :'String',
    'nodes': :'Array<OCI::VnMonitoring::Models::TrafficNode>',
    'route_analysis_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



105
106
107
108
109
110
111
112
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 105

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

  self.class == other.class &&
    reachability_status == other.reachability_status &&
    nodes == other.nodes &&
    route_analysis_description == other.route_analysis_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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 137

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


117
118
119
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



126
127
128
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 126

def hash
  [reachability_status, nodes, route_analysis_description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 170

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



164
165
166
 
# File 'lib/oci/vn_monitoring/models/traffic_route.rb', line 164

def to_s
  to_hash.to_s
end