Class: OCI::DataCatalog::Models::Catalog
- Inherits:
-
Object
- Object
- OCI::DataCatalog::Models::Catalog
- Defined in:
- lib/oci/data_catalog/models/catalog.rb
Overview
A data catalog enables you to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.
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
-
#attached_catalog_private_endpoints ⇒ Array<String>
The list of private reverse connection endpoints attached to the catalog.
-
#compartment_id ⇒ String
[Required] Compartment identifier.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys.
-
#display_name ⇒ String
Data catalog identifier, which can be renamed.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type, or scope.
-
#id ⇒ String
[Required] OCID of the data catalog instance.
-
#lifecycle_details ⇒ String
An message describing the current state in more detail.
-
#lifecycle_state ⇒ String
The current state of the data catalog resource.
-
#locks ⇒ Array<OCI::DataCatalog::Models::ResourceLock>
Locks associated with this resource.
-
#number_of_objects ⇒ Integer
The number of data objects added to the data catalog.
-
#service_api_url ⇒ String
The REST front endpoint URL to the data catalog instance.
-
#service_console_url ⇒ String
The console front endpoint URL to the data catalog instance.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
The time the data catalog was created.
-
#time_updated ⇒ DateTime
The time the data catalog was updated.
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 = {}) ⇒ Catalog
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 = {}) ⇒ Catalog
Initializes the object
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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 164 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.id = attributes[:'id'] if attributes[:'id'] 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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] 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.service_api_url = attributes[:'serviceApiUrl'] if attributes[:'serviceApiUrl'] raise 'You cannot provide both :serviceApiUrl and :service_api_url' if attributes.key?(:'serviceApiUrl') && attributes.key?(:'service_api_url') self.service_api_url = attributes[:'service_api_url'] if attributes[:'service_api_url'] self.service_console_url = attributes[:'serviceConsoleUrl'] if attributes[:'serviceConsoleUrl'] raise 'You cannot provide both :serviceConsoleUrl and :service_console_url' if attributes.key?(:'serviceConsoleUrl') && attributes.key?(:'service_console_url') self.service_console_url = attributes[:'service_console_url'] if attributes[:'service_console_url'] self.number_of_objects = attributes[:'numberOfObjects'] if attributes[:'numberOfObjects'] raise 'You cannot provide both :numberOfObjects and :number_of_objects' if attributes.key?(:'numberOfObjects') && attributes.key?(:'number_of_objects') self.number_of_objects = attributes[:'number_of_objects'] if attributes[:'number_of_objects'] 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.attached_catalog_private_endpoints = attributes[:'attachedCatalogPrivateEndpoints'] if attributes[:'attachedCatalogPrivateEndpoints'] raise 'You cannot provide both :attachedCatalogPrivateEndpoints and :attached_catalog_private_endpoints' if attributes.key?(:'attachedCatalogPrivateEndpoints') && attributes.key?(:'attached_catalog_private_endpoints') self.attached_catalog_private_endpoints = attributes[:'attached_catalog_private_endpoints'] if attributes[:'attached_catalog_private_endpoints'] self.locks = attributes[:'locks'] if attributes[:'locks'] end |
Instance Attribute Details
#attached_catalog_private_endpoints ⇒ Array<String>
The list of private reverse connection endpoints attached to the catalog
91 92 93 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 91 def attached_catalog_private_endpoints @attached_catalog_private_endpoints end |
#compartment_id ⇒ String
[Required] Compartment identifier.
34 35 36 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 34 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
87 88 89 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 87 def @defined_tags end |
#display_name ⇒ String
Data catalog identifier, which can be renamed.
30 31 32 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 30 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
72 73 74 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 72 def @freeform_tags end |
#id ⇒ String
[Required] OCID of the data catalog instance.
26 27 28 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 26 def id @id end |
#lifecycle_details ⇒ String
An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.
66 67 68 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 66 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
The current state of the data catalog resource.
60 61 62 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 60 def lifecycle_state @lifecycle_state end |
#locks ⇒ Array<OCI::DataCatalog::Models::ResourceLock>
Locks associated with this resource.
95 96 97 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 95 def locks @locks end |
#number_of_objects ⇒ Integer
The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.
56 57 58 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 56 def number_of_objects @number_of_objects end |
#service_api_url ⇒ String
The REST front endpoint URL to the data catalog instance.
46 47 48 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 46 def service_api_url @service_api_url end |
#service_console_url ⇒ String
The console front endpoint URL to the data catalog instance.
50 51 52 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 50 def service_console_url @service_console_url end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
81 82 83 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 81 def @system_tags end |
#time_created ⇒ DateTime
The time the data catalog was created. An RFC3339 formatted datetime string.
38 39 40 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 38 def time_created @time_created end |
#time_updated ⇒ DateTime
The time the data catalog was updated. An RFC3339 formatted datetime string.
42 43 44 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 42 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 98 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'service_api_url': :'serviceApiUrl', 'service_console_url': :'serviceConsoleUrl', 'number_of_objects': :'numberOfObjects', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'freeform_tags': :'freeformTags', 'system_tags': :'systemTags', 'defined_tags': :'definedTags', 'attached_catalog_private_endpoints': :'attachedCatalogPrivateEndpoints', 'locks': :'locks' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 121 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'service_api_url': :'String', 'service_console_url': :'String', 'number_of_objects': :'Integer', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'freeform_tags': :'Hash<String, String>', 'system_tags': :'Hash<String, Hash<String, Object>>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'attached_catalog_private_endpoints': :'Array<String>', 'locks': :'Array<OCI::DataCatalog::Models::ResourceLock>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 273 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && time_created == other.time_created && time_updated == other.time_updated && service_api_url == other.service_api_url && service_console_url == other.service_console_url && number_of_objects == other.number_of_objects && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && == other. && == other. && == other. && attached_catalog_private_endpoints == other.attached_catalog_private_endpoints && locks == other.locks end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
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/catalog.rb', line 317 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
297 298 299 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 297 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
306 307 308 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 306 def hash [id, display_name, compartment_id, time_created, time_updated, service_api_url, service_console_url, number_of_objects, lifecycle_state, lifecycle_details, , , , attached_catalog_private_endpoints, locks].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
350 351 352 353 354 355 356 357 358 359 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 350 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
344 345 346 |
# File 'lib/oci/data_catalog/models/catalog.rb', line 344 def to_s to_hash.to_s end |