class OCI::Core::Models::Topology
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
Constants
- TYPE_ENUM
Attributes
[Required] Lists entities comprising the virtual network topology. @return [Array<Object>]
[Required] Lists relationships between entities in the virtual network topology. @return [Array<OCI::Core::Models::TopologyEntityRelationship>]
[Required] Records when the virtual network topology was created, in [RFC3339](tools.ietf.org/html/rfc3339) format for date and time. @return [DateTime]
[Required] Type of the topology object. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/topology.rb, line 33 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'type': :'type', 'entities': :'entities', 'relationships': :'relationships', 'time_created': :'timeCreated' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/core/models/topology.rb, line 61 def self.get_subtype(object_hash) type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral return 'OCI::Core::Models::VcnTopology' if type == 'VCN' return 'OCI::Core::Models::NetworkingTopology' if type == 'NETWORKING' # TODO: Log a warning when the subtype is not found. 'OCI::Core::Models::Topology' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :type The value to assign to the {#type} property @option attributes [Array<Object>] :entities The value to assign to the {#entities} property @option attributes [Array<OCI::Core::Models::TopologyEntityRelationship>] :relationships The value to assign to the {#relationships} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
# File lib/oci/core/models/topology.rb, line 82 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.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
Attribute type mapping.
# File lib/oci/core/models/topology.rb, line 45 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'type': :'String', 'entities': :'Array<Object>', 'relationships': :'Array<OCI::Core::Models::TopologyEntityRelationship>', 'time_created': :'DateTime' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/core/models/topology.rb, line 116 def ==(other) return true if equal?(other) self.class == other.class && type == other.type && entities == other.entities && relationships == other.relationships && time_created == other.time_created end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/core/models/topology.rb, line 149 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/core/models/topology.rb, line 129 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/topology.rb, line 138 def hash [type, entities, relationships, time_created].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/topology.rb, line 182 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/core/models/topology.rb, line 176 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object
to be assigned
# File lib/oci/core/models/topology.rb, line 105 def type=(type) raise "Invalid value for 'type': this must be one of the values in TYPE_ENUM." if type && !TYPE_ENUM.include?(type) @type = type end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/core/models/topology.rb, line 199 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end