Class: OCI::DataCatalog::Models::Connection
- Inherits:
-
Object
- Object
- OCI::DataCatalog::Models::Connection
- Defined in:
- lib/oci/data_catalog/models/connection.rb
Overview
Detailed representation of a connection to a data asset, minus any sensitive properties.
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
-
#created_by_id ⇒ String
OCID of the user who created the connection.
-
#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>
The list of customized properties along with the values for this object.
-
#data_asset_key ⇒ String
Unique key of the parent data asset.
-
#description ⇒ String
A description of the connection.
-
#display_name ⇒ String
A user-friendly display name.
-
#external_key ⇒ String
Unique external key of this object from the source system.
-
#is_default ⇒ BOOLEAN
Indicates whether this connection is the default connection.
-
#key ⇒ String
[Required] Unique connection key that is immutable.
-
#lifecycle_state ⇒ String
The current state of the connection.
-
#properties ⇒ Hash<String, Hash<String, String>>
A map of maps that contains the properties which are specific to the connection type.
-
#time_created ⇒ DateTime
The date and time the connection was created, in the format defined by RFC3339.
-
#time_status_updated ⇒ DateTime
Time that the connections status was last updated.
-
#time_updated ⇒ DateTime
The last time that any change was made to the connection.
-
#type_key ⇒ String
The key of the object type.
-
#updated_by_id ⇒ String
OCID of the user who modified the connection.
-
#uri ⇒ String
URI to the connection 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 = {}) ⇒ Connection
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 = {}) ⇒ Connection
Initializes the object
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 252 253 |
# File 'lib/oci/data_catalog/models/connection.rb', line 168 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.description = attributes[:'description'] if attributes[:'description'] 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.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.created_by_id = attributes[:'createdById'] if attributes[:'createdById'] raise 'You cannot provide both :createdById and :created_by_id' if attributes.key?(:'createdById') && attributes.key?(:'created_by_id') self.created_by_id = attributes[:'created_by_id'] if attributes[:'created_by_id'] 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.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'] 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.time_status_updated = attributes[:'timeStatusUpdated'] if attributes[:'timeStatusUpdated'] raise 'You cannot provide both :timeStatusUpdated and :time_status_updated' if attributes.key?(:'timeStatusUpdated') && attributes.key?(:'time_status_updated') self.time_status_updated = attributes[:'time_status_updated'] if attributes[:'time_status_updated'] 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.is_default = attributes[:'isDefault'] unless attributes[:'isDefault'].nil? raise 'You cannot provide both :isDefault and :is_default' if attributes.key?(:'isDefault') && attributes.key?(:'is_default') self.is_default = attributes[:'is_default'] unless attributes[:'is_default'].nil? 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.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.uri = attributes[:'uri'] if attributes[:'uri'] end |
Instance Attribute Details
#created_by_id ⇒ String
OCID of the user who created the connection.
51 52 53 |
# File 'lib/oci/data_catalog/models/connection.rb', line 51 def created_by_id @created_by_id end |
#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>
The list of customized properties along with the values for this object
59 60 61 |
# File 'lib/oci/data_catalog/models/connection.rb', line 59 def custom_property_members @custom_property_members end |
#data_asset_key ⇒ String
Unique key of the parent data asset.
88 89 90 |
# File 'lib/oci/data_catalog/models/connection.rb', line 88 def data_asset_key @data_asset_key end |
#description ⇒ String
A description of the connection.
30 31 32 |
# File 'lib/oci/data_catalog/models/connection.rb', line 30 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.
36 37 38 |
# File 'lib/oci/data_catalog/models/connection.rb', line 36 def display_name @display_name end |
#external_key ⇒ String
Unique external key of this object from the source system.
72 73 74 |
# File 'lib/oci/data_catalog/models/connection.rb', line 72 def external_key @external_key end |
#is_default ⇒ BOOLEAN
Indicates whether this connection is the default connection.
84 85 86 |
# File 'lib/oci/data_catalog/models/connection.rb', line 84 def is_default @is_default end |
#key ⇒ String
[Required] Unique connection key that is immutable.
26 27 28 |
# File 'lib/oci/data_catalog/models/connection.rb', line 26 def key @key end |
#lifecycle_state ⇒ String
The current state of the connection.
80 81 82 |
# File 'lib/oci/data_catalog/models/connection.rb', line 80 def lifecycle_state @lifecycle_state end |
#properties ⇒ Hash<String, Hash<String, String>>
A map of maps that contains the properties which are specific to the connection type. Each connection 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 connections have required properties within the "default" category. Example: {\"properties\": { \"default\": { \"username\": \"user1\"}}}
68 69 70 |
# File 'lib/oci/data_catalog/models/connection.rb', line 68 def properties @properties end |
#time_created ⇒ DateTime
The date and time the connection was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
42 43 44 |
# File 'lib/oci/data_catalog/models/connection.rb', line 42 def time_created @time_created end |
#time_status_updated ⇒ DateTime
Time that the connections status was last updated. An RFC3339 formatted datetime string.
76 77 78 |
# File 'lib/oci/data_catalog/models/connection.rb', line 76 def time_status_updated @time_status_updated end |
#time_updated ⇒ DateTime
The last time that any change was made to the connection. An RFC3339 formatted datetime string.
47 48 49 |
# File 'lib/oci/data_catalog/models/connection.rb', line 47 def time_updated @time_updated end |
#type_key ⇒ String
The key of the object type. Type key's can be found via the '/types' endpoint.
92 93 94 |
# File 'lib/oci/data_catalog/models/connection.rb', line 92 def type_key @type_key end |
#updated_by_id ⇒ String
OCID of the user who modified the connection.
55 56 57 |
# File 'lib/oci/data_catalog/models/connection.rb', line 55 def updated_by_id @updated_by_id end |
#uri ⇒ String
URI to the connection instance in the API.
96 97 98 |
# File 'lib/oci/data_catalog/models/connection.rb', line 96 def uri @uri end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/oci/data_catalog/models/connection.rb', line 99 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'description': :'description', 'display_name': :'displayName', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'created_by_id': :'createdById', 'updated_by_id': :'updatedById', 'custom_property_members': :'customPropertyMembers', 'properties': :'properties', 'external_key': :'externalKey', 'time_status_updated': :'timeStatusUpdated', 'lifecycle_state': :'lifecycleState', 'is_default': :'isDefault', 'data_asset_key': :'dataAssetKey', 'type_key': :'typeKey', 'uri': :'uri' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/oci/data_catalog/models/connection.rb', line 123 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'description': :'String', 'display_name': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'created_by_id': :'String', 'updated_by_id': :'String', 'custom_property_members': :'Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>', 'properties': :'Hash<String, Hash<String, String>>', 'external_key': :'String', 'time_status_updated': :'DateTime', 'lifecycle_state': :'String', 'is_default': :'BOOLEAN', 'data_asset_key': :'String', 'type_key': :'String', 'uri': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/oci/data_catalog/models/connection.rb', line 275 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && description == other.description && display_name == other.display_name && time_created == other.time_created && time_updated == other.time_updated && created_by_id == other.created_by_id && updated_by_id == other.updated_by_id && custom_property_members == other.custom_property_members && properties == other.properties && external_key == other.external_key && time_status_updated == other.time_status_updated && lifecycle_state == other.lifecycle_state && is_default == other.is_default && data_asset_key == other.data_asset_key && type_key == other.type_key && uri == other.uri end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/oci/data_catalog/models/connection.rb', line 320 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
300 301 302 |
# File 'lib/oci/data_catalog/models/connection.rb', line 300 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
309 310 311 |
# File 'lib/oci/data_catalog/models/connection.rb', line 309 def hash [key, description, display_name, time_created, time_updated, created_by_id, updated_by_id, custom_property_members, properties, external_key, time_status_updated, lifecycle_state, is_default, data_asset_key, type_key, uri].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
353 354 355 356 357 358 359 360 361 362 |
# File 'lib/oci/data_catalog/models/connection.rb', line 353 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
347 348 349 |
# File 'lib/oci/data_catalog/models/connection.rb', line 347 def to_s to_hash.to_s end |