Class: OCI::DataCatalog::Models::CatalogSummary
- Inherits:
-
Object
- Object
- OCI::DataCatalog::Models::CatalogSummary
- Defined in:
- lib/oci/data_catalog/models/catalog_summary.rb
Overview
Summary of the data catalog.
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, that 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] Unique identifier that is immutable on creation.
-
#lifecycle_details ⇒ String
An message describing the current state in more detail.
-
#lifecycle_state ⇒ String
The current state of the data catalog resource.
-
#number_of_objects ⇒ Integer
The number of high level objects added to the data catalog.
-
#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 = {}) ⇒ CatalogSummary
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 = {}) ⇒ CatalogSummary
Initializes the object
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 186 187 188 189 190 191 192 193 194 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 127 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.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[:'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'] end |
Instance Attribute Details
#attached_catalog_private_endpoints ⇒ Array<String>
The list of private reverse connection endpoints attached to the catalog
70 71 72 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 70 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_summary.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\"}}
66 67 68 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 66 def @defined_tags end |
#display_name ⇒ String
Data catalog identifier, that can be renamed.
30 31 32 |
# File 'lib/oci/data_catalog/models/catalog_summary.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\"}
60 61 62 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 60 def @freeform_tags end |
#id ⇒ String
[Required] Unique identifier that is immutable on creation.
26 27 28 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 26 def id @id end |
#lifecycle_details ⇒ String
An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
54 55 56 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 54 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
The current state of the data catalog resource.
50 51 52 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 50 def lifecycle_state @lifecycle_state end |
#number_of_objects ⇒ Integer
The number of high level objects added to the data catalog.
46 47 48 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 46 def number_of_objects @number_of_objects 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_summary.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_summary.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.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 73 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'number_of_objects': :'numberOfObjects', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'attached_catalog_private_endpoints': :'attachedCatalogPrivateEndpoints' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 92 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'number_of_objects': :'Integer', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'attached_catalog_private_endpoints': :'Array<String>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 216 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 && number_of_objects == other.number_of_objects && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && == other. && == other. && attached_catalog_private_endpoints == other.attached_catalog_private_endpoints end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 256 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
236 237 238 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 236 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
245 246 247 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 245 def hash [id, display_name, compartment_id, time_created, time_updated, number_of_objects, lifecycle_state, lifecycle_details, , , attached_catalog_private_endpoints].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
289 290 291 292 293 294 295 296 297 298 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 289 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
283 284 285 |
# File 'lib/oci/data_catalog/models/catalog_summary.rb', line 283 def to_s to_hash.to_s end |