class OCI::Opsi::Models::ConnectionDetails

Connection details to connect to the database. HostName, protocol, and port should be specified.

Constants

PROTOCOL_ENUM

Attributes

host_name[RW]

[Required] Name of the listener host that will be used to create the connect string to the database. @return [String]

port[RW]

[Required] Listener port number used for connection requests. @return [Integer]

protocol[R]

[Required] Protocol used for connection requests. @return [String]

service_name[RW]

[Required] Service name used for connection requests. @return [String]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/opsi/models/connection_details.rb, line 34
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'host_name': :'hostName',
    'protocol': :'protocol',
    'port': :'port',
    'service_name': :'serviceName'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :host_name The value to assign to the {#host_name} property @option attributes [String] :protocol The value to assign to the {#protocol} property @option attributes [Integer] :port The value to assign to the {#port} property @option attributes [String] :service_name The value to assign to the {#service_name} property

# File lib/oci/opsi/models/connection_details.rb, line 67
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.host_name = attributes[:'hostName'] if attributes[:'hostName']

  raise 'You cannot provide both :hostName and :host_name' if attributes.key?(:'hostName') && attributes.key?(:'host_name')

  self.host_name = attributes[:'host_name'] if attributes[:'host_name']

  self.protocol = attributes[:'protocol'] if attributes[:'protocol']

  self.port = attributes[:'port'] if attributes[:'port']

  self.service_name = attributes[:'serviceName'] if attributes[:'serviceName']

  raise 'You cannot provide both :serviceName and :service_name' if attributes.key?(:'serviceName') && attributes.key?(:'service_name')

  self.service_name = attributes[:'service_name'] if attributes[:'service_name']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/opsi/models/connection_details.rb, line 46
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'host_name': :'String',
    'protocol': :'String',
    'port': :'Integer',
    'service_name': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/opsi/models/connection_details.rb, line 110
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    host_name == other.host_name &&
    protocol == other.protocol &&
    port == other.port &&
    service_name == other.service_name
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/opsi/models/connection_details.rb, line 143
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/opsi/models/connection_details.rb, line 123
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/opsi/models/connection_details.rb, line 132
def hash
  [host_name, protocol, port, service_name].hash
end
protocol=(protocol) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] protocol Object to be assigned

# File lib/oci/opsi/models/connection_details.rb, line 94
def protocol=(protocol)
  # rubocop:disable Style/ConditionalAssignment
  if protocol && !PROTOCOL_ENUM.include?(protocol)
    OCI.logger.debug("Unknown value for 'protocol' [" + protocol + "]. Mapping to 'PROTOCOL_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @protocol = PROTOCOL_UNKNOWN_ENUM_VALUE
  else
    @protocol = protocol
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/opsi/models/connection_details.rb, line 176
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/opsi/models/connection_details.rb, line 170
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/opsi/models/connection_details.rb, line 193
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