Class: OCI::DataCatalog::Models::Folder

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

Overview

A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_MOVING = 'MOVING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
HARVEST_STATUS_ENUM = 
[
  HARVEST_STATUS_COMPLETE = 'COMPLETE'.freeze,
  HARVEST_STATUS_ERROR = 'ERROR'.freeze,
  HARVEST_STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  HARVEST_STATUS_DEFERRED = 'DEFERRED'.freeze,
  HARVEST_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Folder

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
306
307
308
309
310
311
312
313
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/data_catalog/models/folder.rb', line 239

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

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

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

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

  self.parent_folder_key = attributes[:'parentFolderKey'] if attributes[:'parentFolderKey']

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

  self.parent_folder_key = attributes[:'parent_folder_key'] if attributes[:'parent_folder_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.time_harvested = attributes[:'timeHarvested'] if attributes[:'timeHarvested']

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

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

  self.object_relationships = attributes[:'objectRelationships'] if attributes[:'objectRelationships']

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

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

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

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

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

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

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

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

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

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

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

  self.object_storage_url = attributes[:'objectStorageUrl'] if attributes[:'objectStorageUrl']

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

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

Instance Attribute Details

#business_name ⇒ String

Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.

Returns:

  • (String) 


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

def business_name
  @business_name
end

#created_by_id ⇒ String

OCID of the user who created the folder.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/data_catalog/models/folder.rb', line 109

def created_by_id
  @created_by_id
end

#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>

The list of customized properties along with the values for this object

Returns:



81
82
83
 
# File 'lib/oci/data_catalog/models/folder.rb', line 81

def custom_property_members
  @custom_property_members
end

#data_asset_key ⇒ String

The key of the associated data asset.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/data_catalog/models/folder.rb', line 77

def data_asset_key
  @data_asset_key
end

#description ⇒ String

Detailed description of a folder.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#external_key ⇒ String

Unique external key of this object in the source system.

Returns:

  • (String) 


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

def external_key
  @external_key
end

#harvest_status ⇒ String

Status of the object as updated by the harvest process.

Returns:

  • (String) 


131
132
133
 
# File 'lib/oci/data_catalog/models/folder.rb', line 131

def harvest_status
  @harvest_status
end

#key ⇒ String

[Required] Unique folder key that is immutable.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_catalog/models/folder.rb', line 38

def key
  @key
end

#last_job_key ⇒ String

The key of the last harvest process to update the metadata of this object.

Returns:

  • (String) 


135
136
137
 
# File 'lib/oci/data_catalog/models/folder.rb', line 135

def last_job_key
  @last_job_key
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.

Returns:

  • (String) 


127
128
129
 
# File 'lib/oci/data_catalog/models/folder.rb', line 127

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the folder.

Returns:

  • (String) 


121
122
123
 
# File 'lib/oci/data_catalog/models/folder.rb', line 121

def lifecycle_state
  @lifecycle_state
end

#object_relationships ⇒ Array<OCI::DataCatalog::Models::ObjectRelationship>

List of objects and their relationships to this folder.

Returns:



69
70
71
 
# File 'lib/oci/data_catalog/models/folder.rb', line 69

def object_relationships
  @object_relationships
end

#object_storage_url ⇒ String

URL of the folder in the object store.

Returns:

  • (String) 


143
144
145
 
# File 'lib/oci/data_catalog/models/folder.rb', line 143

def object_storage_url
  @object_storage_url
end

#parent_folder_key ⇒ String

The unique key of the containing folder or null if there is no parent folder.

Returns:

  • (String) 


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

def parent_folder_key
  @parent_folder_key
end

#path ⇒ String

Full path of the folder.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/data_catalog/models/folder.rb', line 73

def path
  @path
end

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

A map of maps that contains the properties which are specific to the folder type. Each folder 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 folders have required properties within the "default" category. Example: {\"properties\": { \"default\": { \"key1\": \"value1\"}}}

Returns:

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


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

def properties
  @properties
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


100
101
102
 
# File 'lib/oci/data_catalog/models/folder.rb', line 100

def time_created
  @time_created
end

#time_external ⇒ DateTime

Last modified timestamp of this object in the external system.

Returns:

  • (DateTime) 


117
118
119
 
# File 'lib/oci/data_catalog/models/folder.rb', line 117

def time_external
  @time_external
end

#time_harvested ⇒ DateTime

The date and time the folder was harvested, in the format defined by RFC3339.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/data_catalog/models/folder.rb', line 65

def time_harvested
  @time_harvested
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


105
106
107
 
# File 'lib/oci/data_catalog/models/folder.rb', line 105

def time_updated
  @time_updated
end

#type_key ⇒ String

The type of folder object. Type keys can be found via the '/types' endpoint.

Returns:

  • (String) 


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

def type_key
  @type_key
end

#updated_by_id ⇒ String

OCID of the user who modified the folder.

Returns:

  • (String) 


113
114
115
 
# File 'lib/oci/data_catalog/models/folder.rb', line 113

def updated_by_id
  @updated_by_id
end

#uri ⇒ String

URI to the folder instance in the API.

Returns:

  • (String) 


139
140
141
 
# File 'lib/oci/data_catalog/models/folder.rb', line 139

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'business_name': :'businessName',
    'description': :'description',
    'parent_folder_key': :'parentFolderKey',
    'type_key': :'typeKey',
    'time_harvested': :'timeHarvested',
    'object_relationships': :'objectRelationships',
    'path': :'path',
    'data_asset_key': :'dataAssetKey',
    'custom_property_members': :'customPropertyMembers',
    'properties': :'properties',
    'external_key': :'externalKey',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by_id': :'createdById',
    'updated_by_id': :'updatedById',
    'time_external': :'timeExternal',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'harvest_status': :'harvestStatus',
    'last_job_key': :'lastJobKey',
    'uri': :'uri',
    'object_storage_url': :'objectStorageUrl'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/data_catalog/models/folder.rb', line 178

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'business_name': :'String',
    'description': :'String',
    'parent_folder_key': :'String',
    'type_key': :'String',
    'time_harvested': :'DateTime',
    'object_relationships': :'Array<OCI::DataCatalog::Models::ObjectRelationship>',
    'path': :'String',
    'data_asset_key': :'String',
    'custom_property_members': :'Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>',
    'properties': :'Hash<String, Hash<String, String>>',
    'external_key': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by_id': :'String',
    'updated_by_id': :'String',
    'time_external': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'harvest_status': :'String',
    'last_job_key': :'String',
    'uri': :'String',
    'object_storage_url': :'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



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/oci/data_catalog/models/folder.rb', line 403

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

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    business_name == other.business_name &&
    description == other.description &&
    parent_folder_key == other.parent_folder_key &&
    type_key == other.type_key &&
    time_harvested == other.time_harvested &&
    object_relationships == other.object_relationships &&
    path == other.path &&
    data_asset_key == other.data_asset_key &&
    custom_property_members == other.custom_property_members &&
    properties == other.properties &&
    external_key == other.external_key &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by_id == other.created_by_id &&
    updated_by_id == other.updated_by_id &&
    time_external == other.time_external &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    harvest_status == other.harvest_status &&
    last_job_key == other.last_job_key &&
    uri == other.uri &&
    object_storage_url == other.object_storage_url
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



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/oci/data_catalog/models/folder.rb', line 456

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


436
437
438
 
# File 'lib/oci/data_catalog/models/folder.rb', line 436

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



445
446
447
 
# File 'lib/oci/data_catalog/models/folder.rb', line 445

def hash
  [key, display_name, business_name, description, parent_folder_key, type_key, time_harvested, object_relationships, path, data_asset_key, custom_property_members, properties, external_key, time_created, time_updated, created_by_id, updated_by_id, time_external, lifecycle_state, lifecycle_details, harvest_status, last_job_key, uri, object_storage_url].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



489
490
491
492
493
494
495
496
497
498
 
# File 'lib/oci/data_catalog/models/folder.rb', line 489

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



483
484
485
 
# File 'lib/oci/data_catalog/models/folder.rb', line 483

def to_s
  to_hash.to_s
end