Class: OCI::VnMonitoring::Models::Topology

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

Overview

Defines the representation of a virtual network topology. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_NETWORKING = 'NETWORKING'.freeze,
  TYPE_VCN = 'VCN'.freeze,
  TYPE_SUBNET = 'SUBNET'.freeze,
  TYPE_PATH = 'PATH'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Topology

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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/oci/vn_monitoring/models/topology.rb', line 97

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.type = attributes[:'type'] if attributes[:'type']

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

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

  self.limited_entities = attributes[:'limitedEntities'] if attributes[:'limitedEntities']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

Instance Attribute Details

#entities ⇒ Array<Object>

[Required] Lists entities comprising the virtual network topology.

Returns:

  • (Array<Object>) 


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

def entities
  @entities
end

#limited_entities ⇒ Array<String>

[Required] Lists entities that are limited during ingestion. The values for the items in the list are the entity type names of the limitedEntities. Example: vcn

Returns:

  • (Array<String>) 


36
37
38
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 36

def limited_entities
  @limited_entities
end

#relationships ⇒ Array<OCI::VnMonitoring::Models::TopologyEntityRelationship>

[Required] Lists relationships between entities in the virtual network topology.

Returns:



29
30
31
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 29

def relationships
  @relationships
end

#time_created ⇒ DateTime

[Required] Records when the virtual network topology was created, in RFC3339 format for date and time.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 40

def time_created
  @time_created
end

#type ⇒ String

[Required] Type of the topology object.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'entities': :'entities',
    'relationships': :'relationships',
    'limited_entities': :'limitedEntities',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 73

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::VnMonitoring::Models::VcnTopology' if type == 'VCN'
  return 'OCI::VnMonitoring::Models::PathTopology' if type == 'PATH'
  return 'OCI::VnMonitoring::Models::NetworkingTopology' if type == 'NETWORKING'
  return 'OCI::VnMonitoring::Models::SubnetTopology' if type == 'SUBNET'

  # TODO: Log a warning when the subtype is not found.
  'OCI::VnMonitoring::Models::Topology'
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'entities': :'Array<Object>',
    'relationships': :'Array<OCI::VnMonitoring::Models::TopologyEntityRelationship>',
    'limited_entities': :'Array<String>',
    'time_created': :'DateTime'
    # 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



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 137

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

  self.class == other.class &&
    type == other.type &&
    entities == other.entities &&
    relationships == other.relationships &&
    limited_entities == other.limited_entities &&
    time_created == other.time_created
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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 171

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


151
152
153
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 151

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



160
161
162
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 160

def hash
  [type, entities, relationships, limited_entities, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 204

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



198
199
200
 
# File 'lib/oci/vn_monitoring/models/topology.rb', line 198

def to_s
  to_hash.to_s
end