class OCI::DataIntegration::Models::ReferenceSummary

This is the reference summary information.

Constants

TYPE_ENUM

Attributes

aggregator_key[RW]

The aggregator of reference object. @return [String]

child_references[RW]

List of references that are dependent on this reference. @return [Array<OCI::DataIntegration::Models::ChildReference>]

description[RW]

The description of reference object. @return [String]

identifier[RW]

The identifier of reference object. @return [String]

identifier_path[RW]

The identifier path of reference object. @return [String]

key[RW]

The reference's key, key of the object that is being used by a published object or its dependents. @return [String]

name[RW]

The name of reference object. @return [String]

target_object[RW]

The target object referenced. References are made to data assets and child references are made to connections. The type defining this reference is mentioned in the property type. @return [Object]

type[R]

The type of reference object. @return [String]

used_by[RW]

List of published objects where this is used. @return [Array<OCI::DataIntegration::Models::ReferenceUsedBy>]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/data_integration/models/reference_summary.rb, line 62
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'name': :'name',
    'identifier': :'identifier',
    'identifier_path': :'identifierPath',
    'description': :'description',
    'type': :'type',
    'target_object': :'targetObject',
    'aggregator_key': :'aggregatorKey',
    'used_by': :'usedBy',
    'child_references': :'childReferences'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :key The value to assign to the {#key} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :identifier The value to assign to the {#identifier} property @option attributes [String] :identifier_path The value to assign to the {#identifier_path} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :type The value to assign to the {#type} property @option attributes [Object] :target_object The value to assign to the {#target_object} property @option attributes [String] :aggregator_key The value to assign to the {#aggregator_key} property @option attributes [Array<OCI::DataIntegration::Models::ReferenceUsedBy>] :used_by The value to assign to the {#used_by} property @option attributes [Array<OCI::DataIntegration::Models::ChildReference>] :child_references The value to assign to the {#child_references} property

# File lib/oci/data_integration/models/reference_summary.rb, line 113
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.key = attributes[:'key'] if attributes[:'key']

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

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

  self.identifier_path = attributes[:'identifierPath'] if attributes[:'identifierPath']

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

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

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

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

  self.target_object = attributes[:'targetObject'] if attributes[:'targetObject']

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

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

  self.aggregator_key = attributes[:'aggregatorKey'] if attributes[:'aggregatorKey']

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

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

  self.used_by = attributes[:'usedBy'] if attributes[:'usedBy']

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

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

  self.child_references = attributes[:'childReferences'] if attributes[:'childReferences']

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

  self.child_references = attributes[:'child_references'] if attributes[:'child_references']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_integration/models/reference_summary.rb, line 80
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'name': :'String',
    'identifier': :'String',
    'identifier_path': :'String',
    'description': :'String',
    'type': :'String',
    'target_object': :'Object',
    'aggregator_key': :'String',
    'used_by': :'Array<OCI::DataIntegration::Models::ReferenceUsedBy>',
    'child_references': :'Array<OCI::DataIntegration::Models::ChildReference>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/data_integration/models/reference_summary.rb, line 180
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key == other.key &&
    name == other.name &&
    identifier == other.identifier &&
    identifier_path == other.identifier_path &&
    description == other.description &&
    type == other.type &&
    target_object == other.target_object &&
    aggregator_key == other.aggregator_key &&
    used_by == other.used_by &&
    child_references == other.child_references
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/data_integration/models/reference_summary.rb, line 219
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/data_integration/models/reference_summary.rb, line 199
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/data_integration/models/reference_summary.rb, line 208
def hash
  [key, name, identifier, identifier_path, description, type, target_object, aggregator_key, used_by, child_references].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/data_integration/models/reference_summary.rb, line 252
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/data_integration/models/reference_summary.rb, line 246
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/oci/data_integration/models/reference_summary.rb, line 164
def type=(type)
  # rubocop:disable Style/ConditionalAssignment
  if type && !TYPE_ENUM.include?(type)
    OCI.logger.debug("Unknown value for 'type' [" + type + "]. Mapping to 'TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @type = TYPE_UNKNOWN_ENUM_VALUE
  else
    @type = type
  end
  # rubocop:enable Style/ConditionalAssignment
end

Private Instance Methods

_to_hash(value) click to toggle source

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/data_integration/models/reference_summary.rb, line 269
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