Class: OCI::DataCatalog::Models::EntitySummary
- Inherits:
-
Object
- Object
- OCI::DataCatalog::Models::EntitySummary
- Defined in:
- lib/oci/data_catalog/models/entity_summary.rb
Overview
Summary of an data entity. 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
-
#data_asset_key ⇒ String
Unique key of the parent data asset.
-
#description ⇒ String
Detailed description of a data entity.
-
#display_name ⇒ String
A user-friendly display name.
-
#external_key ⇒ String
Unique external key of this object in the source system.
-
#folder_key ⇒ String
Key of the associated folder.
-
#key ⇒ String
[Required] Unique data entity key that is immutable.
-
#lifecycle_state ⇒ String
State of the data entity.
-
#path ⇒ String
Full path of the data entity.
-
#time_created ⇒ DateTime
The date and time the data entity was created, in the format defined by RFC3339.
-
#time_updated ⇒ DateTime
The last time that any change was made to the data entity.
-
#updated_by_id ⇒ String
OCID of the user who updated this object in the data catalog.
-
#uri ⇒ String
URI to the data entity instance in the API.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ EntitySummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ EntitySummary
Initializes the object
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 185 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 124 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.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.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.path = attributes[:'path'] if attributes[:'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.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.uri = attributes[:'uri'] if attributes[:'uri'] 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'] end |
Instance Attribute Details
#data_asset_key ⇒ String
Unique key of the parent data asset.
29 30 31 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 29 def data_asset_key @data_asset_key end |
#description ⇒ String
Detailed description of a data entity.
25 26 27 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 25 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.
21 22 23 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 21 def display_name @display_name end |
#external_key ⇒ String
Unique external key of this object in the source system.
37 38 39 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 37 def external_key @external_key end |
#folder_key ⇒ String
Key of the associated folder.
33 34 35 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 33 def folder_key @folder_key end |
#key ⇒ String
[Required] Unique data entity key that is immutable.
15 16 17 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 15 def key @key end |
#lifecycle_state ⇒ String
State of the data entity.
64 65 66 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 64 def lifecycle_state @lifecycle_state end |
#path ⇒ String
Full path of the data entity.
41 42 43 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 41 def path @path end |
#time_created ⇒ DateTime
The date and time the data entity was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
47 48 49 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 47 def time_created @time_created end |
#time_updated ⇒ DateTime
The last time that any change was made to the data entity. An RFC3339 formatted datetime string.
52 53 54 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 52 def time_updated @time_updated end |
#updated_by_id ⇒ String
OCID of the user who updated this object in the data catalog.
56 57 58 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 56 def updated_by_id @updated_by_id end |
#uri ⇒ String
URI to the data entity instance in the API.
60 61 62 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 60 def uri @uri end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 67 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'display_name': :'displayName', 'description': :'description', 'data_asset_key': :'dataAssetKey', 'folder_key': :'folderKey', 'external_key': :'externalKey', 'path': :'path', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'updated_by_id': :'updatedById', 'uri': :'uri', 'lifecycle_state': :'lifecycleState' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 87 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'display_name': :'String', 'description': :'String', 'data_asset_key': :'String', 'folder_key': :'String', 'external_key': :'String', 'path': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'updated_by_id': :'String', 'uri': :'String', 'lifecycle_state': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 194 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && display_name == other.display_name && description == other.description && data_asset_key == other.data_asset_key && folder_key == other.folder_key && external_key == other.external_key && path == other.path && time_created == other.time_created && time_updated == other.time_updated && updated_by_id == other.updated_by_id && uri == other.uri && lifecycle_state == other.lifecycle_state end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 235 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
215 216 217 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 215 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
224 225 226 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 224 def hash [key, display_name, description, data_asset_key, folder_key, external_key, path, time_created, time_updated, updated_by_id, uri, lifecycle_state].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
268 269 270 271 272 273 274 275 276 277 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 268 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
262 263 264 |
# File 'lib/oci/data_catalog/models/entity_summary.rb', line 262 def to_s to_hash.to_s end |