Class: OCI::DataCatalog::Models::CreateEntityDetails
- Inherits:
-
Object
- Object
- OCI::DataCatalog::Models::CreateEntityDetails
- Defined in:
- lib/oci/data_catalog/models/create_entity_details.rb
Overview
Properties used in data entity create operations.
Constant Summary collapse
- 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 ].freeze
Instance Attribute Summary collapse
-
#business_name ⇒ String
Optional user friendly business name of the data entity.
-
#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertySetUsage>
The list of customized properties along with the values for this object.
-
#description ⇒ String
Detailed description of a data entity.
-
#display_name ⇒ String
[Required] A user-friendly display name.
-
#folder_key ⇒ String
Key of the associated folder.
-
#harvest_status ⇒ String
Status of the object as updated by the harvest process.
-
#is_logical ⇒ BOOLEAN
Property to indicate if the object is a physical materialized object or virtual.
-
#is_partition ⇒ BOOLEAN
Property to indicate if the object is a sub object of a parent physical object.
-
#last_job_key ⇒ String
Key of the last harvest process to update this object.
-
#pattern_key ⇒ String
Key of the associated pattern if this is a logical entity.
-
#properties ⇒ Hash<String, Hash<String, String>>
A map of maps that contains the properties which are specific to the entity type.
-
#realized_expression ⇒ String
The expression realized after resolving qualifiers .
-
#time_external ⇒ DateTime
[Required] Last modified timestamp of the object in the external system.
-
#type_key ⇒ String
The type of data entity object.
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 = {}) ⇒ CreateEntityDetails
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 = {}) ⇒ CreateEntityDetails
Initializes the object
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 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 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 152 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.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.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.description = attributes[:'description'] if attributes[:'description'] 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.is_logical = attributes[:'isLogical'] unless attributes[:'isLogical'].nil? self.is_logical = false if is_logical.nil? && !attributes.key?(:'isLogical') # rubocop:disable Style/StringLiterals 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_logical = false if is_logical.nil? && !attributes.key?(:'isLogical') && !attributes.key?(:'is_logical') # rubocop:disable Style/StringLiterals self.is_partition = attributes[:'isPartition'] unless attributes[:'isPartition'].nil? self.is_partition = false if is_partition.nil? && !attributes.key?(:'isPartition') # rubocop:disable Style/StringLiterals 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.is_partition = false if is_partition.nil? && !attributes.key?(:'isPartition') && !attributes.key?(:'is_partition') # rubocop:disable Style/StringLiterals 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.pattern_key = attributes[:'patternKey'] if attributes[:'patternKey'] raise 'You cannot provide both :patternKey and :pattern_key' if attributes.key?(:'patternKey') && attributes.key?(:'pattern_key') self.pattern_key = attributes[:'pattern_key'] if attributes[:'pattern_key'] self.realized_expression = attributes[:'realizedExpression'] if attributes[:'realizedExpression'] raise 'You cannot provide both :realizedExpression and :realized_expression' if attributes.key?(:'realizedExpression') && attributes.key?(:'realized_expression') self.realized_expression = attributes[:'realized_expression'] if attributes[:'realized_expression'] 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.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'] end |
Instance Attribute Details
#business_name ⇒ String
Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
26 27 28 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 26 def business_name @business_name end |
#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertySetUsage>
The list of customized properties along with the values for this object
74 75 76 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 74 def custom_property_members @custom_property_members end |
#description ⇒ String
Detailed description of a data entity.
34 35 36 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 34 def description @description end |
#display_name ⇒ String
[Required] A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
22 23 24 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 22 def display_name @display_name end |
#folder_key ⇒ String
Key of the associated folder.
50 51 52 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 50 def folder_key @folder_key end |
#harvest_status ⇒ String
Status of the object as updated by the harvest process. When an entity object is created , it's harvest status will indicate if the entity's metadata has been fully harvested or not. The harvest process can perform shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object This requires a harvest status indicator for catalog objects.
66 67 68 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 66 def harvest_status @harvest_status end |
#is_logical ⇒ BOOLEAN
Property to indicate if the object is a physical materialized object or virtual. For example, View.
42 43 44 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 42 def is_logical @is_logical end |
#is_partition ⇒ BOOLEAN
Property to indicate if the object is a sub object of a parent physical object.
46 47 48 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 46 def is_partition @is_partition end |
#last_job_key ⇒ String
Key of the last harvest process to update this object.
70 71 72 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 70 def last_job_key @last_job_key end |
#pattern_key ⇒ String
Key of the associated pattern if this is a logical entity.
54 55 56 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 54 def pattern_key @pattern_key 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 entities have required properties within the "default" category. To determine the set of required and optional properties for an entity type, a query can be done on '/types?type=dataEntity' that returns a collection of all entity types. The appropriate entity type, which includes definitions of all of it's properties, can be identified from this collection. Example: {\"properties\": { \"default\": { \"key1\": \"value1\"}}}
86 87 88 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 86 def properties @properties end |
#realized_expression ⇒ String
The expression realized after resolving qualifiers . Used in deriving this logical entity
58 59 60 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 58 def realized_expression @realized_expression end |
#time_external ⇒ DateTime
[Required] Last modified timestamp of the object in the external system.
38 39 40 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 38 def time_external @time_external end |
#type_key ⇒ String
The type of data entity object. Type key's can be found via the '/types' endpoint.
30 31 32 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 30 def type_key @type_key end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 89 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'business_name': :'businessName', 'type_key': :'typeKey', 'description': :'description', 'time_external': :'timeExternal', 'is_logical': :'isLogical', 'is_partition': :'isPartition', 'folder_key': :'folderKey', 'pattern_key': :'patternKey', 'realized_expression': :'realizedExpression', 'harvest_status': :'harvestStatus', 'last_job_key': :'lastJobKey', 'custom_property_members': :'customPropertyMembers', 'properties': :'properties' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 111 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'business_name': :'String', 'type_key': :'String', 'description': :'String', 'time_external': :'DateTime', 'is_logical': :'BOOLEAN', 'is_partition': :'BOOLEAN', 'folder_key': :'String', 'pattern_key': :'String', 'realized_expression': :'String', 'harvest_status': :'String', 'last_job_key': :'String', 'custom_property_members': :'Array<OCI::DataCatalog::Models::CustomPropertySetUsage>', 'properties': :'Hash<String, Hash<String, String>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 254 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && business_name == other.business_name && type_key == other.type_key && description == other.description && time_external == other.time_external && is_logical == other.is_logical && is_partition == other.is_partition && folder_key == other.folder_key && pattern_key == other.pattern_key && realized_expression == other.realized_expression && harvest_status == other.harvest_status && last_job_key == other.last_job_key && custom_property_members == other.custom_property_members && properties == other.properties end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 297 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
277 278 279 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 277 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
286 287 288 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 286 def hash [display_name, business_name, type_key, description, time_external, is_logical, is_partition, folder_key, pattern_key, realized_expression, harvest_status, last_job_key, custom_property_members, properties].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
330 331 332 333 334 335 336 337 338 339 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 330 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
324 325 326 |
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 324 def to_s to_hash.to_s end |