Class: OCI::Core::Models::VcnTopology

Inherits:
Topology
  • Object
show all
Defined in:
lib/oci/core/models/vcn_topology.rb

Overview

Defines the representation of a virtual network topology for a VCN. See Network Visualizer Documentation for more information, including conventions and pictures of symbols.

Constant Summary

Constants inherited from Topology

Topology::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Topology

#entities, #limited_entities, #relationships, #time_created, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Topology

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ VcnTopology

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/core/models/vcn_topology.rb', line 59

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

  attributes['type'] = 'VCN'

  super(attributes)

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

  self.vcn_id = attributes[:'vcnId'] if attributes[:'vcnId']

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

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

Instance Attribute Details

#vcn_id ⇒ String

The OCID of the VCN for which the topology is generated.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/core/models/vcn_topology.rb', line 18

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/oci/core/models/vcn_topology.rb', line 21

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

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/core/models/vcn_topology.rb', line 35

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



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/core/models/vcn_topology.rb', line 83

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 &&
    vcn_id == other.vcn_id
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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/core/models/vcn_topology.rb', line 118

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


98
99
100
 
# File 'lib/oci/core/models/vcn_topology.rb', line 98

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



107
108
109
 
# File 'lib/oci/core/models/vcn_topology.rb', line 107

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/core/models/vcn_topology.rb', line 151

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



145
146
147
 
# File 'lib/oci/core/models/vcn_topology.rb', line 145

def to_s
  to_hash.to_s
end