class OCI::DataCatalog::Models::ConnectionSummary
Summary representation of a connection to a data asset.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
The unique key of the parent data asset. @return [String]
A description of the connection. @return [String]
A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
@return [String]
Unique external key for this object as defined in the source systems. @return [String]
Indicates whether this connection is the default connection. @return [BOOLEAN]
[Required] Unique connection key that is immutable. @return [String]
The current state of the connection. @return [String]
The date and time the connection was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`
@return [DateTime]
The key of the object type. Type key's can be found via the '/types' endpoint. @return [String]
URI to the connection instance in the API. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/data_catalog/models/connection_summary.rb, line 68 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'description': :'description', 'display_name': :'displayName', 'data_asset_key': :'dataAssetKey', 'type_key': :'typeKey', 'uri': :'uri', 'external_key': :'externalKey', 'lifecycle_state': :'lifecycleState', 'is_default': :'isDefault', 'time_created': :'timeCreated' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :key The value to assign to the {#key} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :data_asset_key The value to assign to the {#data_asset_key} property @option attributes [String] :type_key The value to assign to the {#type_key} property @option attributes [String] :uri The value to assign to the {#uri} property @option attributes [String] :external_key The value to assign to the {#external_key} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [BOOLEAN] :is_default The value to assign to the {#is_default} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
# File lib/oci/data_catalog/models/connection_summary.rb, line 119 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.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'] 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.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.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'] end
Attribute type mapping.
# File lib/oci/data_catalog/models/connection_summary.rb, line 86 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'description': :'String', 'display_name': :'String', 'data_asset_key': :'String', 'type_key': :'String', 'uri': :'String', 'external_key': :'String', 'lifecycle_state': :'String', 'is_default': :'BOOLEAN', 'time_created': :'DateTime' # 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_catalog/models/connection_summary.rb, line 194 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && description == other.description && display_name == other.display_name && data_asset_key == other.data_asset_key && type_key == other.type_key && uri == other.uri && external_key == other.external_key && lifecycle_state == other.lifecycle_state && is_default == other.is_default && time_created == other.time_created 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_catalog/models/connection_summary.rb, line 233 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_catalog/models/connection_summary.rb, line 213 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/data_catalog/models/connection_summary.rb, line 222 def hash [key, description, display_name, data_asset_key, type_key, uri, external_key, lifecycle_state, is_default, time_created].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/data_catalog/models/connection_summary.rb, line 178 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/data_catalog/models/connection_summary.rb, line 266 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_catalog/models/connection_summary.rb, line 260 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_catalog/models/connection_summary.rb, line 283 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