Class: OCI::DataCatalog::Models::CreateConnectionDetails
- Inherits:
-
Object
- Object
- OCI::DataCatalog::Models::CreateConnectionDetails
- Defined in:
- lib/oci/data_catalog/models/create_connection_details.rb
Overview
Properties used in connection create operations.
Instance Attribute Summary collapse
-
#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertySetUsage>
The list of customized properties along with the values for this object.
-
#description ⇒ String
A description of the connection.
-
#display_name ⇒ String
[Required] A user-friendly display name.
-
#enc_properties ⇒ Hash<String, Hash<String, String>>
A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type.
-
#is_default ⇒ BOOLEAN
Indicates whether this connection is the default connection.
-
#properties ⇒ Hash<String, Hash<String, String>>
[Required] A map of maps that contains the properties which are specific to the connection type.
-
#type_key ⇒ String
[Required] The key of the object type.
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 = {}) ⇒ CreateConnectionDetails
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 = {}) ⇒ CreateConnectionDetails
Initializes the object
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 104 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.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.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.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.enc_properties = attributes[:'encProperties'] if attributes[:'encProperties'] raise 'You cannot provide both :encProperties and :enc_properties' if attributes.key?(:'encProperties') && attributes.key?(:'enc_properties') self.enc_properties = attributes[:'enc_properties'] if attributes[:'enc_properties'] 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? end |
Instance Attribute Details
#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertySetUsage>
The list of customized properties along with the values for this object
27 28 29 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 27 def custom_property_members @custom_property_members end |
#description ⇒ String
A description of the connection.
13 14 15 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 13 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.
19 20 21 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 19 def display_name @display_name end |
#enc_properties ⇒ Hash<String, Hash<String, String>>
A map of maps that contains the encrypted values for sensitive 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. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {\"encProperties\": { \"default\": { \"password\": \"example-password\"}}}
51 52 53 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 51 def enc_properties @enc_properties end |
#is_default ⇒ BOOLEAN
Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
59 60 61 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 59 def is_default @is_default end |
#properties ⇒ Hash<String, Hash<String, String>>
[Required] 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. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {\"properties\": { \"default\": { \"username\": \"user1\"}}}
39 40 41 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 39 def properties @properties end |
#type_key ⇒ String
[Required] The key of the object type. Type key's can be found via the '/types' endpoint.
23 24 25 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 23 def type_key @type_key end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 62 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'description': :'description', 'display_name': :'displayName', 'type_key': :'typeKey', 'custom_property_members': :'customPropertyMembers', 'properties': :'properties', 'enc_properties': :'encProperties', 'is_default': :'isDefault' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 77 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'description': :'String', 'display_name': :'String', 'type_key': :'String', 'custom_property_members': :'Array<OCI::DataCatalog::Models::CustomPropertySetUsage>', 'properties': :'Hash<String, Hash<String, String>>', 'enc_properties': :'Hash<String, Hash<String, String>>', 'is_default': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 152 def ==(other) return true if equal?(other) self.class == other.class && description == other.description && display_name == other.display_name && type_key == other.type_key && custom_property_members == other.custom_property_members && properties == other.properties && enc_properties == other.enc_properties && is_default == other.is_default end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 188 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
168 169 170 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 168 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
177 178 179 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 177 def hash [description, display_name, type_key, custom_property_members, properties, enc_properties, is_default].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
221 222 223 224 225 226 227 228 229 230 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 221 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
215 216 217 |
# File 'lib/oci/data_catalog/models/create_connection_details.rb', line 215 def to_s to_hash.to_s end |