Class: OCI::DatabaseTools::Models::DatabaseToolsConnectionSummary
- Inherits:
-
Object
- Object
- OCI::DatabaseTools::Models::DatabaseToolsConnectionSummary
- Defined in:
- lib/oci/database_tools/models/database_tools_connection_summary.rb
Overview
Summary of the Database Tools connection. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Direct Known Subclasses
DatabaseToolsConnectionGenericJdbcSummary, DatabaseToolsConnectionMySqlSummary, DatabaseToolsConnectionOracleDatabaseSummary, DatabaseToolsConnectionPostgresqlSummary
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- TYPE_ENUM =
[ TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'.freeze, TYPE_MYSQL = 'MYSQL'.freeze, TYPE_POSTGRESQL = 'POSTGRESQL'.freeze, TYPE_GENERIC_JDBC = 'GENERIC_JDBC'.freeze, TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- RUNTIME_SUPPORT_ENUM =
[ RUNTIME_SUPPORT_SUPPORTED = 'SUPPORTED'.freeze, RUNTIME_SUPPORT_UNSUPPORTED = 'UNSUPPORTED'.freeze, RUNTIME_SUPPORT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the Database Tools connection.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the
DatabaseToolsConnection
. -
#lifecycle_details ⇒ String
A message describing the current state in more detail.
-
#lifecycle_state ⇒ String
[Required] The current state of the Database Tools connection.
-
#locks ⇒ Array<OCI::DatabaseTools::Models::ResourceLock>
Locks associated with this resource.
-
#runtime_support ⇒ String
[Required] Specifies whether this connection is supported by the Database Tools Runtime.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
[Required] The time the Database Tools connection was created.
-
#time_updated ⇒ DateTime
[Required] The time the Database Tools connection was updated.
-
#type ⇒ String
[Required] The Database Tools connection type.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
.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 = {}) ⇒ DatabaseToolsConnectionSummary
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 = {}) ⇒ DatabaseToolsConnectionSummary
Initializes the object
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 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 175 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.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.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. = 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. = 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.locks = attributes[:'locks'] if attributes[:'locks'] self.type = attributes[:'type'] if attributes[:'type'] self.runtime_support = attributes[:'runtimeSupport'] if attributes[:'runtimeSupport'] raise 'You cannot provide both :runtimeSupport and :runtime_support' if attributes.key?(:'runtimeSupport') && attributes.key?(:'runtime_support') self.runtime_support = attributes[:'runtime_support'] if attributes[:'runtime_support'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the Database Tools connection.
48 49 50 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 48 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
70 71 72 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 70 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
44 45 46 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 44 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\"}
76 77 78 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 76 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the DatabaseToolsConnection
.
40 41 42 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 40 def id @id end |
#lifecycle_details ⇒ String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
56 57 58 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 56 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the Database Tools connection.
52 53 54 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 52 def lifecycle_state @lifecycle_state end |
#locks ⇒ Array<OCI::DatabaseTools::Models::ResourceLock>
Locks associated with this resource.
86 87 88 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 86 def locks @locks end |
#runtime_support ⇒ String
[Required] Specifies whether this connection is supported by the Database Tools Runtime.
94 95 96 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 94 def runtime_support @runtime_support end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
82 83 84 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 82 def @system_tags end |
#time_created ⇒ DateTime
[Required] The time the Database Tools connection was created. An RFC3339 formatted datetime string.
60 61 62 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 60 def time_created @time_created end |
#time_updated ⇒ DateTime
[Required] The time the Database Tools connection was updated. An RFC3339 formatted datetime string.
64 65 66 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 64 def time_updated @time_updated end |
#type ⇒ String
[Required] The Database Tools connection type.
90 91 92 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 90 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 97 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'defined_tags': :'definedTags', 'freeform_tags': :'freeformTags', 'system_tags': :'systemTags', 'locks': :'locks', 'type': :'type', 'runtime_support': :'runtimeSupport' # rubocop:enable Style/SymbolLiteral } end |
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 143 def self.get_subtype(object_hash) type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral return 'OCI::DatabaseTools::Models::DatabaseToolsConnectionPostgresqlSummary' if type == 'POSTGRESQL' return 'OCI::DatabaseTools::Models::DatabaseToolsConnectionOracleDatabaseSummary' if type == 'ORACLE_DATABASE' return 'OCI::DatabaseTools::Models::DatabaseToolsConnectionMySqlSummary' if type == 'MYSQL' return 'OCI::DatabaseTools::Models::DatabaseToolsConnectionGenericJdbcSummary' if type == 'GENERIC_JDBC' # TODO: Log a warning when the subtype is not found. 'OCI::DatabaseTools::Models::DatabaseToolsConnectionSummary' end |
.swagger_types ⇒ Object
Attribute type mapping.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 118 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'freeform_tags': :'Hash<String, String>', 'system_tags': :'Hash<String, Hash<String, Object>>', 'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>', 'type': :'String', 'runtime_support': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 294 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && time_created == other.time_created && time_updated == other.time_updated && == other. && == other. && == other. && locks == other.locks && type == other.type && runtime_support == other.runtime_support end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 336 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
316 317 318 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 316 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
325 326 327 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 325 def hash [id, display_name, compartment_id, lifecycle_state, lifecycle_details, time_created, time_updated, , , , locks, type, runtime_support].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
369 370 371 372 373 374 375 376 377 378 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 369 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
363 364 365 |
# File 'lib/oci/database_tools/models/database_tools_connection_summary.rb', line 363 def to_s to_hash.to_s end |