Class: OCI::DataCatalog::Models::FolderSummary

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

Overview

Summary of a folder. 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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FolderSummary

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

  • :business_name (String) —

    The value to assign to the #business_name property

  • :description (String) —

    The value to assign to the #description property

  • :data_asset_key (String) —

    The value to assign to the #data_asset_key property

  • :parent_folder_key (String) —

    The value to assign to the #parent_folder_key property

  • :type_key (String) —

    The value to assign to the #type_key property

  • :path (String) —

    The value to assign to the #path 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_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :uri (String) —

    The value to assign to the #uri property

  • :object_storage_url (String) —

    The value to assign to the #object_storage_url property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property



170
171
172
173
174
175
176
177
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
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
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 170

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

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

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


41
42
43
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 41

def business_name
  @business_name
end

#data_asset_key ⇒ String

The unique key of the parent data asset.

Returns:

  • (String) 


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

def data_asset_key
  @data_asset_key
end

#description ⇒ String

Detailed description of a folder.

Returns:

  • (String) 


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

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) 


37
38
39
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 37

def display_name
  @display_name
end

#external_key ⇒ String

Unique external key of this object from the source systems.

Returns:

  • (String) 


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

def external_key
  @external_key
end

#key ⇒ String

[Required] Unique folder key that is immutable.

Returns:

  • (String) 


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

def key
  @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) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

State of the folder.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 92

def lifecycle_state
  @lifecycle_state
end

#object_storage_url ⇒ String

URL of the folder in the object store.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 88

def object_storage_url
  @object_storage_url
end

#parent_folder_key ⇒ String

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

Returns:

  • (String) 


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

def parent_folder_key
  @parent_folder_key
end

#path ⇒ String

Full path of the folder.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 61

def path
  @path
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) 


75
76
77
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 75

def time_created
  @time_created
end

#time_external ⇒ DateTime

Last modified timestamp of this object in the external system.

Returns:

  • (DateTime) 


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

def time_external
  @time_external
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


80
81
82
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 80

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) 


57
58
59
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 57

def type_key
  @type_key
end

#uri ⇒ String

URI of the folder resource within the data catalog API.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 84

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 101

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'business_name': :'businessName',
    'description': :'description',
    'data_asset_key': :'dataAssetKey',
    'parent_folder_key': :'parentFolderKey',
    'type_key': :'typeKey',
    'path': :'path',
    'external_key': :'externalKey',
    'time_external': :'timeExternal',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'uri': :'uri',
    'object_storage_url': :'objectStorageUrl',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 125

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'business_name': :'String',
    'description': :'String',
    'data_asset_key': :'String',
    'parent_folder_key': :'String',
    'type_key': :'String',
    'path': :'String',
    'external_key': :'String',
    'time_external': :'DateTime',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'uri': :'String',
    'object_storage_url': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 277

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 &&
    data_asset_key == other.data_asset_key &&
    parent_folder_key == other.parent_folder_key &&
    type_key == other.type_key &&
    path == other.path &&
    external_key == other.external_key &&
    time_external == other.time_external &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    uri == other.uri &&
    object_storage_url == other.object_storage_url &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 322

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


302
303
304
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 302

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



311
312
313
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 311

def hash
  [key, display_name, business_name, description, data_asset_key, parent_folder_key, type_key, path, external_key, time_external, time_created, time_updated, uri, object_storage_url, lifecycle_state, lifecycle_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 355

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



349
350
351
 
# File 'lib/oci/data_catalog/models/folder_summary.rb', line 349

def to_s
  to_hash.to_s
end