Class: OCI::Psql::Models::ConnectionDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/psql/models/connection_details.rb

Overview

Database system connection information. Used to connect to PostgreSQL instance(s).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectionDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/psql/models/connection_details.rb', line 64

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.ca_certificate = attributes[:'caCertificate'] if attributes[:'caCertificate']

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

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

  self.primary_db_endpoint = attributes[:'primaryDbEndpoint'] if attributes[:'primaryDbEndpoint']

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

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

  self.instance_endpoints = attributes[:'instanceEndpoints'] if attributes[:'instanceEndpoints']

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

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

  self.reader_endpoint = attributes[:'readerEndpoint'] if attributes[:'readerEndpoint']

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

  self.reader_endpoint = attributes[:'reader_endpoint'] if attributes[:'reader_endpoint']
end

Instance Attribute Details

#ca_certificate ⇒ String

[Required] The CA certificate to be used by the PosgreSQL client to connect to the database. The CA certificate is used to authenticate the server identity. It is issued by PostgreSQL Service Private CA.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/psql/models/connection_details.rb', line 17

def ca_certificate
  @ca_certificate
end

#instance_endpoints ⇒ Array<OCI::Psql::Models::DbInstanceEndpoint>

[Required] The list of database instance node endpoints in the database system.

Returns:



25
26
27
 
# File 'lib/oci/psql/models/connection_details.rb', line 25

def instance_endpoints
  @instance_endpoints
end

#primary_db_endpoint ⇒ OCI::Psql::Models::Endpoint

This attribute is required.

Returns:



21
22
23
 
# File 'lib/oci/psql/models/connection_details.rb', line 21

def primary_db_endpoint
  @primary_db_endpoint
end

#reader_endpoint ⇒ OCI::Psql::Models::Endpoint

Returns:



28
29
30
 
# File 'lib/oci/psql/models/connection_details.rb', line 28

def reader_endpoint
  @reader_endpoint
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/psql/models/connection_details.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'ca_certificate': :'caCertificate',
    'primary_db_endpoint': :'primaryDbEndpoint',
    'instance_endpoints': :'instanceEndpoints',
    'reader_endpoint': :'readerEndpoint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/psql/models/connection_details.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'ca_certificate': :'String',
    'primary_db_endpoint': :'OCI::Psql::Models::Endpoint',
    'instance_endpoints': :'Array<OCI::Psql::Models::DbInstanceEndpoint>',
    'reader_endpoint': :'OCI::Psql::Models::Endpoint'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/psql/models/connection_details.rb', line 102

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    ca_certificate == other.ca_certificate &&
    primary_db_endpoint == other.primary_db_endpoint &&
    instance_endpoints == other.instance_endpoints &&
    reader_endpoint == other.reader_endpoint
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/psql/models/connection_details.rb', line 135

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


115
116
117
 
# File 'lib/oci/psql/models/connection_details.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/psql/models/connection_details.rb', line 124

def hash
  [ca_certificate, primary_db_endpoint, instance_endpoints, reader_endpoint].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/psql/models/connection_details.rb', line 168

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

Returns:

  • (String) —

    String presentation of the object



162
163
164
 
# File 'lib/oci/psql/models/connection_details.rb', line 162

def to_s
  to_hash.to_s
end