Class: OCI::DataCatalog::Models::ObjectLineage

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/object_lineage.rb

Overview

Lineage for an object.

Constant Summary collapse

DIRECTION_ENUM = 
[
  DIRECTION_UPSTREAM = 'UPSTREAM'.freeze,
  DIRECTION_BOTH = 'BOTH'.freeze,
  DIRECTION_DOWNSTREAM = 'DOWNSTREAM'.freeze,
  DIRECTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectLineage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 81

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

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

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

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

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

Instance Attribute Details

#annotations ⇒ Hash<String, Hash<String, String>>

A map of maps that contains additional information in explanation of the lineage returned. The map keys are categories of information and the values are maps of annotation names to their corresponding values. Every annotation is contained inside a category. Example: {\"annotations\": { \"category\": { \"key\": \"value\"}}}

Returns:

  • (Hash<String, Hash<String, String>>) 


42
43
44
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 42

def annotations
  @annotations
end

#direction ⇒ String

[Required] Direction of the lineage returned.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 26

def direction
  @direction
end

#level ⇒ Integer

[Required] Object level at which the lineage is returned.

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 22

def level
  @level
end

#objects ⇒ Array<OCI::DataCatalog::Models::LineageObject>

Set of objects that are involved in the lineage.

Returns:



30
31
32
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 30

def objects
  @objects
end

#relationships ⇒ Array<OCI::DataCatalog::Models::LineageRelationship>

Set of relationships between the objects in the 'objects' set.

Returns:



34
35
36
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 34

def relationships
  @relationships
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'level': :'level',
    'direction': :'direction',
    'objects': :'objects',
    'relationships': :'relationships',
    'annotations': :'annotations'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'level': :'Integer',
    'direction': :'String',
    'objects': :'Array<OCI::DataCatalog::Models::LineageObject>',
    'relationships': :'Array<OCI::DataCatalog::Models::LineageRelationship>',
    'annotations': :'Hash<String, Hash<String, 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



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 118

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

  self.class == other.class &&
    level == other.level &&
    direction == other.direction &&
    objects == other.objects &&
    relationships == other.relationships &&
    annotations == other.annotations
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 152

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


132
133
134
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



141
142
143
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 141

def hash
  [level, direction, objects, relationships, annotations].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 185

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



179
180
181
 
# File 'lib/oci/data_catalog/models/object_lineage.rb', line 179

def to_s
  to_hash.to_s
end