class OCI::DataIntegration::Models::ConnectionDetails
The connection details for a data asset. 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
Constants
- MODEL_TYPE_ENUM
Attributes
The properties for the connection. @return [Array<OCI::DataIntegration::Models::ConnectionProperty>]
User-defined description for the connection. @return [String]
Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. @return [String]
The default property for the connection. @return [BOOLEAN]
Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. @return [String]
@return [OCI::DataIntegration::Models::ObjectMetadata]
[Required] The type of the connection. @return [String]
The model version of an object. @return [String]
Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. @return [String]
The status of an object that can be set to value 1 for shallow references across objects, other values reserved. @return [Integer]
The version of the object that is used to track changes in the object instance. @return [Integer]
@return [OCI::DataIntegration::Models::ParentReference]
@return [OCI::DataIntegration::Models::Schema]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/data_integration/models/connection_details.rb, line 72 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'model_type': :'modelType', 'key': :'key', 'model_version': :'modelVersion', 'parent_ref': :'parentRef', 'name': :'name', 'description': :'description', 'object_version': :'objectVersion', 'object_status': :'objectStatus', 'identifier': :'identifier', 'primary_schema': :'primarySchema', 'connection_properties': :'connectionProperties', 'is_default': :'isDefault', 'metadata': :'metadata' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/data_integration/models/connection_details.rb, line 118 def self.get_subtype(object_hash) type = object_hash[:'modelType'] # rubocop:disable Style/SymbolLiteral return 'OCI::DataIntegration::Models::ConnectionFromJdbcDetails' if type == 'GENERIC_JDBC_CONNECTION' return 'OCI::DataIntegration::Models::ConnectionFromAmazonS3Details' if type == 'AMAZON_S3_CONNECTION' return 'OCI::DataIntegration::Models::ConnectionFromObjectStorageDetails' if type == 'ORACLE_OBJECT_STORAGE_CONNECTION' return 'OCI::DataIntegration::Models::ConnectionFromBICCDetails' if type == 'BICC_CONNECTION' return 'OCI::DataIntegration::Models::ConnectionFromMySQLDetails' if type == 'MYSQL_CONNECTION' return 'OCI::DataIntegration::Models::ConnectionFromAdwcDetails' if type == 'ORACLE_ADWC_CONNECTION' return 'OCI::DataIntegration::Models::ConnectionFromAtpDetails' if type == 'ORACLE_ATP_CONNECTION' return 'OCI::DataIntegration::Models::ConnectionFromOracleDetails' if type == 'ORACLEDB_CONNECTION' # TODO: Log a warning when the subtype is not found. 'OCI::DataIntegration::Models::ConnectionDetails' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :model_type The value to assign to the {#model_type} property @option attributes [String] :key The value to assign to the {#key} property @option attributes [String] :model_version The value to assign to the {#model_version} property @option attributes [OCI::DataIntegration::Models::ParentReference] :parent_ref The value to assign to the {#parent_ref} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [Integer] :object_version The value to assign to the {#object_version} property @option attributes [Integer] :object_status The value to assign to the {#object_status} property @option attributes [String] :identifier The value to assign to the {#identifier} property @option attributes [OCI::DataIntegration::Models::Schema] :primary_schema The value to assign to the {#primary_schema} property @option attributes [Array<OCI::DataIntegration::Models::ConnectionProperty>] :connection_properties The value to assign to the {#connection_properties} property @option attributes [BOOLEAN] :is_default The value to assign to the {#is_default} property @option attributes [OCI::DataIntegration::Models::ObjectMetadata] :metadata The value to assign to the {#metadata} property
# File lib/oci/data_integration/models/connection_details.rb, line 154 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.model_type = attributes[:'modelType'] if attributes[:'modelType'] raise 'You cannot provide both :modelType and :model_type' if attributes.key?(:'modelType') && attributes.key?(:'model_type') self.model_type = attributes[:'model_type'] if attributes[:'model_type'] self.key = attributes[:'key'] if attributes[:'key'] self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion'] raise 'You cannot provide both :modelVersion and :model_version' if attributes.key?(:'modelVersion') && attributes.key?(:'model_version') self.model_version = attributes[:'model_version'] if attributes[:'model_version'] self.parent_ref = attributes[:'parentRef'] if attributes[:'parentRef'] raise 'You cannot provide both :parentRef and :parent_ref' if attributes.key?(:'parentRef') && attributes.key?(:'parent_ref') self.parent_ref = attributes[:'parent_ref'] if attributes[:'parent_ref'] self.name = attributes[:'name'] if attributes[:'name'] self.description = attributes[:'description'] if attributes[:'description'] self.object_version = attributes[:'objectVersion'] if attributes[:'objectVersion'] raise 'You cannot provide both :objectVersion and :object_version' if attributes.key?(:'objectVersion') && attributes.key?(:'object_version') self.object_version = attributes[:'object_version'] if attributes[:'object_version'] self.object_status = attributes[:'objectStatus'] if attributes[:'objectStatus'] raise 'You cannot provide both :objectStatus and :object_status' if attributes.key?(:'objectStatus') && attributes.key?(:'object_status') self.object_status = attributes[:'object_status'] if attributes[:'object_status'] self.identifier = attributes[:'identifier'] if attributes[:'identifier'] self.primary_schema = attributes[:'primarySchema'] if attributes[:'primarySchema'] raise 'You cannot provide both :primarySchema and :primary_schema' if attributes.key?(:'primarySchema') && attributes.key?(:'primary_schema') self.primary_schema = attributes[:'primary_schema'] if attributes[:'primary_schema'] self.connection_properties = attributes[:'connectionProperties'] if attributes[:'connectionProperties'] raise 'You cannot provide both :connectionProperties and :connection_properties' if attributes.key?(:'connectionProperties') && attributes.key?(:'connection_properties') self.connection_properties = attributes[:'connection_properties'] if attributes[:'connection_properties'] self.is_default = attributes[:'isDefault'] unless attributes[:'isDefault'].nil? self.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') # rubocop:disable Style/StringLiterals 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.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') && !attributes.key?(:'is_default') # rubocop:disable Style/StringLiterals self.metadata = attributes[:'metadata'] if attributes[:'metadata'] end
Attribute type mapping.
# File lib/oci/data_integration/models/connection_details.rb, line 93 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'model_type': :'String', 'key': :'String', 'model_version': :'String', 'parent_ref': :'OCI::DataIntegration::Models::ParentReference', 'name': :'String', 'description': :'String', 'object_version': :'Integer', 'object_status': :'Integer', 'identifier': :'String', 'primary_schema': :'OCI::DataIntegration::Models::Schema', 'connection_properties': :'Array<OCI::DataIntegration::Models::ConnectionProperty>', 'is_default': :'BOOLEAN', 'metadata': :'OCI::DataIntegration::Models::ObjectMetadata' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/data_integration/models/connection_details.rb, line 236 def ==(other) return true if equal?(other) self.class == other.class && model_type == other.model_type && key == other.key && model_version == other.model_version && parent_ref == other.parent_ref && name == other.name && description == other.description && object_version == other.object_version && object_status == other.object_status && identifier == other.identifier && primary_schema == other.primary_schema && connection_properties == other.connection_properties && is_default == other.is_default && metadata == other.metadata end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/data_integration/models/connection_details.rb, line 278 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/data_integration/models/connection_details.rb, line 258 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/data_integration/models/connection_details.rb, line 267 def hash [model_type, key, model_version, parent_ref, name, description, object_version, object_status, identifier, primary_schema, connection_properties, is_default, metadata].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] model_type
Object
to be assigned
# File lib/oci/data_integration/models/connection_details.rb, line 225 def model_type=(model_type) raise "Invalid value for 'model_type': this must be one of the values in MODEL_TYPE_ENUM." if model_type && !MODEL_TYPE_ENUM.include?(model_type) @model_type = model_type end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/data_integration/models/connection_details.rb, line 311 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/data_integration/models/connection_details.rb, line 305 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/data_integration/models/connection_details.rb, line 328 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end