Class: OCI::StackMonitoring::Models::ConnectionDetails

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

Overview

Connection details for the database.

Constant Summary collapse

PROTOCOL_ENUM = 
[
  PROTOCOL_TCP = 'TCP'.freeze,
  PROTOCOL_TCPS = 'TCPS'.freeze,
  PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

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):

  • :protocol (String) —

    The value to assign to the #protocol property

  • :port (Integer) —

    The value to assign to the #port property

  • :connector_id (String) —

    The value to assign to the #connector_id property

  • :service_name (String) —

    The value to assign to the #service_name property

  • :db_unique_name (String) —

    The value to assign to the #db_unique_name property

  • :db_id (String) —

    The value to assign to the #db_id property

  • :ssl_secret_id (String) —

    The value to assign to the #ssl_secret_id property



93
94
95
96
97
98
99
100
101
102
103
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
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 93

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

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

  self.connector_id = attributes[:'connectorId'] if attributes[:'connectorId']

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

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

  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']

  self.db_unique_name = attributes[:'dbUniqueName'] if attributes[:'dbUniqueName']

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

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

  self.db_id = attributes[:'dbId'] if attributes[:'dbId']

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

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

  self.ssl_secret_id = attributes[:'sslSecretId'] if attributes[:'sslSecretId']

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

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

Instance Attribute Details

#connector_id ⇒ String

Database connector Identifier OCID.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 30

def connector_id
  @connector_id
end

#db_id ⇒ String

dbId of the database.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 43

def db_id
  @db_id
end

#db_unique_name ⇒ String

UniqueName used for database connection requests.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 38

def db_unique_name
  @db_unique_name
end

#port ⇒ Integer

[Required] Listener Port number used for connection requests.

Returns:

  • (Integer) 


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

def port
  @port
end

#protocol ⇒ String

[Required] Protocol used in DB connection string when connecting to external database service.

Returns:

  • (String) 


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

def protocol
  @protocol
end

#service_name ⇒ String

[Required] Service name used for connection requests.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 34

def service_name
  @service_name
end

#ssl_secret_id ⇒ String

SSL Secret Identifier for TCPS connector in OCI VaultOCID.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 48

def ssl_secret_id
  @ssl_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'protocol',
    'port': :'port',
    'connector_id': :'connectorId',
    'service_name': :'serviceName',
    'db_unique_name': :'dbUniqueName',
    'db_id': :'dbId',
    'ssl_secret_id': :'sslSecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 66

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'String',
    'port': :'Integer',
    'connector_id': :'String',
    'service_name': :'String',
    'db_unique_name': :'String',
    'db_id': :'String',
    'ssl_secret_id': :'String'
    # 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



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 154

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

  self.class == other.class &&
    protocol == other.protocol &&
    port == other.port &&
    connector_id == other.connector_id &&
    service_name == other.service_name &&
    db_unique_name == other.db_unique_name &&
    db_id == other.db_id &&
    ssl_secret_id == other.ssl_secret_id
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 190

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


170
171
172
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 170

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 179

def hash
  [protocol, port, connector_id, service_name, db_unique_name, db_id, ssl_secret_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 223

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



217
218
219
 
# File 'lib/oci/stack_monitoring/models/connection_details.rb', line 217

def to_s
  to_hash.to_s
end