Class: OCI::DataCatalog::Models::LineageObject

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

Overview

Object describing an individual element of object lineage.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LineageObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :object_key (String) —

    The value to assign to the #object_key property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :is_intra_lineage_available (BOOLEAN) —

    The value to assign to the #is_intra_lineage_available property

  • :parent_key (String) —

    The value to assign to the #parent_key property

  • :parent_path (String) —

    The value to assign to the #parent_path property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :type_name (String) —

    The value to assign to the #type_name property

  • :type_key (String) —

    The value to assign to the #type_key property

  • :properties (Hash<String, Hash<String, String>>) —

    The value to assign to the #properties property



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 119

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.is_intra_lineage_available = attributes[:'isIntraLineageAvailable'] unless attributes[:'isIntraLineageAvailable'].nil?
  self.is_intra_lineage_available = false if is_intra_lineage_available.nil? && !attributes.key?(:'isIntraLineageAvailable') # rubocop:disable Style/StringLiterals

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

  self.is_intra_lineage_available = attributes[:'is_intra_lineage_available'] unless attributes[:'is_intra_lineage_available'].nil?
  self.is_intra_lineage_available = false if is_intra_lineage_available.nil? && !attributes.key?(:'isIntraLineageAvailable') && !attributes.key?(:'is_intra_lineage_available') # rubocop:disable Style/StringLiterals

  self.parent_key = attributes[:'parentKey'] if attributes[:'parentKey']

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

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

  self.parent_path = attributes[:'parentPath'] if attributes[:'parentPath']

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

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

  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']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.type_name = attributes[:'typeName'] if attributes[:'typeName']

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

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

  self.type_key = attributes[:'typeKey'] if attributes[:'typeKey']

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

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

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

Instance Attribute Details

#description ⇒ String

Detailed description of the object.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 21

def description
  @description
end

#display_name ⇒ String

Display name of the object.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 17

def display_name
  @display_name
end

#is_intra_lineage_available ⇒ BOOLEAN

Indicates if intra-lineage is available for this given object. If yes, drill-down can be requested for this object.

Returns:

  • (BOOLEAN) 


27
28
29
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 27

def is_intra_lineage_available
  @is_intra_lineage_available
end

#object_key ⇒ String

Key of the object, such as an entity, about which this lineage applies.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 13

def object_key
  @object_key
end

#parent_key ⇒ String

Key of the parent object for this object.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 31

def parent_key
  @parent_key
end

#parent_path ⇒ String

Full path of the parent object.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 35

def parent_path
  @parent_path
end

#properties ⇒ Hash<String, Hash<String, String>>

A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data entities have required properties within the "default" category. Example: {\"properties\": { \"default\": { \"key1\": \"value1\"}}}

Returns:

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


62
63
64
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 62

def properties
  @properties
end

#time_created ⇒ DateTime

The time that this object was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 40

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time that this object was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 45

def time_updated
  @time_updated
end

#type_key ⇒ String

Type key of the object. Type keys can be found via the '/types' endpoint.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 53

def type_key
  @type_key
end

#type_name ⇒ String

Type name of the object. Type keys can be found via the '/types' endpoint.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 49

def type_name
  @type_name
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 65

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'object_key': :'objectKey',
    'display_name': :'displayName',
    'description': :'description',
    'is_intra_lineage_available': :'isIntraLineageAvailable',
    'parent_key': :'parentKey',
    'parent_path': :'parentPath',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'type_name': :'typeName',
    'type_key': :'typeKey',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 84

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'object_key': :'String',
    'display_name': :'String',
    'description': :'String',
    'is_intra_lineage_available': :'BOOLEAN',
    'parent_key': :'String',
    'parent_path': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'type_name': :'String',
    'type_key': :'String',
    'properties': :'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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 193

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

  self.class == other.class &&
    object_key == other.object_key &&
    display_name == other.display_name &&
    description == other.description &&
    is_intra_lineage_available == other.is_intra_lineage_available &&
    parent_key == other.parent_key &&
    parent_path == other.parent_path &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    type_name == other.type_name &&
    type_key == other.type_key &&
    properties == other.properties
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 233

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


213
214
215
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 213

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 222

def hash
  [object_key, display_name, description, is_intra_lineage_available, parent_key, parent_path, time_created, time_updated, type_name, type_key, properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 266

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



260
261
262
 
# File 'lib/oci/data_catalog/models/lineage_object.rb', line 260

def to_s
  to_hash.to_s
end