Class: OCI::DataCatalog::Models::Entity

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

Overview

Data entity details. A representation of data with a set of attributes, normally representing a single business entity. Synonymous with 'table' or 'view' in a database, or a single logical file structure that one or many files may match.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Entity

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String)

    The value to assign to the #key property

  • :display_name (String)

    The value to assign to the #display_name property

  • :description (String)

    The value to assign to the #description 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

  • :created_by_id (String)

    The value to assign to the #created_by_id property

  • :updated_by_id (String)

    The value to assign to the #updated_by_id property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :external_key (String)

    The value to assign to the #external_key property

  • :time_external (DateTime)

    The value to assign to the #time_external property

  • :time_status_updated (DateTime)

    The value to assign to the #time_status_updated property

  • :is_logical (BOOLEAN)

    The value to assign to the #is_logical property

  • :is_partition (BOOLEAN)

    The value to assign to the #is_partition property

  • :data_asset_key (String)

    The value to assign to the #data_asset_key property

  • :folder_key (String)

    The value to assign to the #folder_key property

  • :path (String)

    The value to assign to the #path property

  • :harvest_status (String)

    The value to assign to the #harvest_status property

  • :last_job_key (String)

    The value to assign to the #last_job_key property

  • :type_key (String)

    The value to assign to the #type_key property

  • :uri (String)

    The value to assign to the #uri property

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

    The value to assign to the #properties property



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/oci/data_catalog/models/entity.rb', line 194

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

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

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

  self.updated_by_id = attributes[:'updatedById'] if attributes[:'updatedById']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.external_key = attributes[:'externalKey'] if attributes[:'externalKey']

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

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

  self.time_external = attributes[:'timeExternal'] if attributes[:'timeExternal']

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

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

  self.time_status_updated = attributes[:'timeStatusUpdated'] if attributes[:'timeStatusUpdated']

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

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

  self.is_logical = attributes[:'isLogical'] unless attributes[:'isLogical'].nil?

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

  self.is_logical = attributes[:'is_logical'] unless attributes[:'is_logical'].nil?

  self.is_partition = attributes[:'isPartition'] unless attributes[:'isPartition'].nil?

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

  self.is_partition = attributes[:'is_partition'] unless attributes[:'is_partition'].nil?

  self.data_asset_key = attributes[:'dataAssetKey'] if attributes[:'dataAssetKey']

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

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

  self.folder_key = attributes[:'folderKey'] if attributes[:'folderKey']

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

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

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

  self.harvest_status = attributes[:'harvestStatus'] if attributes[:'harvestStatus']

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

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

  self.last_job_key = attributes[:'lastJobKey'] if attributes[:'lastJobKey']

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

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

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

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

Instance Attribute Details

#created_by_idString

OCID of the user who created this object in the data catalog.

Returns:

  • (String)


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

def created_by_id
  @created_by_id
end

#data_asset_keyString

Unique key of the parent data asset.

Returns:

  • (String)


74
75
76
# File 'lib/oci/data_catalog/models/entity.rb', line 74

def data_asset_key
  @data_asset_key
end

#descriptionString

Detailed description of a data entity.

Returns:

  • (String)


25
26
27
# File 'lib/oci/data_catalog/models/entity.rb', line 25

def description
  @description
end

#display_nameString

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


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

def display_name
  @display_name
end

#external_keyString

Unique external key of this object in the source system.

Returns:

  • (String)


52
53
54
# File 'lib/oci/data_catalog/models/entity.rb', line 52

def external_key
  @external_key
end

#folder_keyString

Key of the associated folder.

Returns:

  • (String)


78
79
80
# File 'lib/oci/data_catalog/models/entity.rb', line 78

def folder_key
  @folder_key
end

#harvest_statusString

Status of the object as updated by the harvest process.

Returns:

  • (String)


86
87
88
# File 'lib/oci/data_catalog/models/entity.rb', line 86

def harvest_status
  @harvest_status
end

#is_logicalBOOLEAN

Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.

Returns:

  • (BOOLEAN)


66
67
68
# File 'lib/oci/data_catalog/models/entity.rb', line 66

def is_logical
  @is_logical
end

#is_partitionBOOLEAN

Property that identifies if an object is a sub object of a physical or materialized parent object.

Returns:

  • (BOOLEAN)


70
71
72
# File 'lib/oci/data_catalog/models/entity.rb', line 70

def is_partition
  @is_partition
end

#keyString

[Required] Unique data entity key that is immutable.

Returns:

  • (String)


15
16
17
# File 'lib/oci/data_catalog/models/entity.rb', line 15

def key
  @key
end

#last_job_keyString

Key of the last harvest process to update this object.

Returns:

  • (String)


90
91
92
# File 'lib/oci/data_catalog/models/entity.rb', line 90

def last_job_key
  @last_job_key
end

#lifecycle_stateString

The current state of the data entity.

Returns:

  • (String)


48
49
50
# File 'lib/oci/data_catalog/models/entity.rb', line 48

def lifecycle_state
  @lifecycle_state
end

#pathString

Full path of the data entity.

Returns:

  • (String)


82
83
84
# File 'lib/oci/data_catalog/models/entity.rb', line 82

def path
  @path
end

#propertiesHash<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>>)


107
108
109
# File 'lib/oci/data_catalog/models/entity.rb', line 107

def properties
  @properties
end

#time_createdDateTime

The date and time the data entity was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_externalDateTime

Last modified timestamp of this object in the external system.

Returns:

  • (DateTime)


56
57
58
# File 'lib/oci/data_catalog/models/entity.rb', line 56

def time_external
  @time_external
end

#time_status_updatedDateTime

Time that the data entities status was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


60
61
62
# File 'lib/oci/data_catalog/models/entity.rb', line 60

def time_status_updated
  @time_status_updated
end

#time_updatedDateTime

The last time that any change was made to the data entity. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


36
37
38
# File 'lib/oci/data_catalog/models/entity.rb', line 36

def time_updated
  @time_updated
end

#type_keyString

The type of data entity object. Type key's can be found via the '/types' endpoint.

Returns:

  • (String)


94
95
96
# File 'lib/oci/data_catalog/models/entity.rb', line 94

def type_key
  @type_key
end

#updated_by_idString

OCID of the user who updated this object in the data catalog.

Returns:

  • (String)


44
45
46
# File 'lib/oci/data_catalog/models/entity.rb', line 44

def updated_by_id
  @updated_by_id
end

#uriString

URI to the data entity instance in the API.

Returns:

  • (String)


98
99
100
# File 'lib/oci/data_catalog/models/entity.rb', line 98

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/oci/data_catalog/models/entity.rb', line 110

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by_id': :'createdById',
    'updated_by_id': :'updatedById',
    'lifecycle_state': :'lifecycleState',
    'external_key': :'externalKey',
    'time_external': :'timeExternal',
    'time_status_updated': :'timeStatusUpdated',
    'is_logical': :'isLogical',
    'is_partition': :'isPartition',
    'data_asset_key': :'dataAssetKey',
    'folder_key': :'folderKey',
    'path': :'path',
    'harvest_status': :'harvestStatus',
    'last_job_key': :'lastJobKey',
    'type_key': :'typeKey',
    'uri': :'uri',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/oci/data_catalog/models/entity.rb', line 139

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by_id': :'String',
    'updated_by_id': :'String',
    'lifecycle_state': :'String',
    'external_key': :'String',
    'time_external': :'DateTime',
    'time_status_updated': :'DateTime',
    'is_logical': :'BOOLEAN',
    'is_partition': :'BOOLEAN',
    'data_asset_key': :'String',
    'folder_key': :'String',
    'path': :'String',
    'harvest_status': :'String',
    'last_job_key': :'String',
    'type_key': :'String',
    'uri': :'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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'lib/oci/data_catalog/models/entity.rb', line 314

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

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by_id == other.created_by_id &&
    updated_by_id == other.updated_by_id &&
    lifecycle_state == other.lifecycle_state &&
    external_key == other.external_key &&
    time_external == other.time_external &&
    time_status_updated == other.time_status_updated &&
    is_logical == other.is_logical &&
    is_partition == other.is_partition &&
    data_asset_key == other.data_asset_key &&
    folder_key == other.folder_key &&
    path == other.path &&
    harvest_status == other.harvest_status &&
    last_job_key == other.last_job_key &&
    type_key == other.type_key &&
    uri == other.uri &&
    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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'lib/oci/data_catalog/models/entity.rb', line 364

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


344
345
346
# File 'lib/oci/data_catalog/models/entity.rb', line 344

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



353
354
355
# File 'lib/oci/data_catalog/models/entity.rb', line 353

def hash
  [key, display_name, description, time_created, time_updated, created_by_id, updated_by_id, lifecycle_state, external_key, time_external, time_status_updated, is_logical, is_partition, data_asset_key, folder_key, path, harvest_status, last_job_key, type_key, uri, properties].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



397
398
399
400
401
402
403
404
405
406
# File 'lib/oci/data_catalog/models/entity.rb', line 397

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



391
392
393
# File 'lib/oci/data_catalog/models/entity.rb', line 391

def to_s
  to_hash.to_s
end