Class: OCI::GoldenGate::Models::CreateMongoDbConnectionDetails

Inherits:
CreateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/create_mongo_db_connection_details.rb

Overview

The information about a new MongoDB Connection.

Constant Summary

Constants inherited from CreateConnectionDetails

OCI::GoldenGate::Models::CreateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::CreateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateConnectionDetails

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #freeform_tags, #key_id, #nsg_ids, #routing_method, #subnet_id, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateMongoDbConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String)

    The value to assign to the #display_name proprety

  • :description (String)

    The value to assign to the #description proprety

  • :compartment_id (String)

    The value to assign to the #compartment_id proprety

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #defined_tags proprety

  • :vault_id (String)

    The value to assign to the #vault_id proprety

  • :key_id (String)

    The value to assign to the #key_id proprety

  • :nsg_ids (Array<String>)

    The value to assign to the #nsg_ids proprety

  • :subnet_id (String)

    The value to assign to the #subnet_id proprety

  • :routing_method (String)

    The value to assign to the #routing_method proprety

  • :technology_type (String)

    The value to assign to the #technology_type property

  • :connection_string (String)

    The value to assign to the #connection_string property

  • :username (String)

    The value to assign to the #username property

  • :password (String)

    The value to assign to the #password property

  • :database_id (String)

    The value to assign to the #database_id property



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
133
134
135
136
137
138
139
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 108

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['connectionType'] = 'MONGODB'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.technology_type = attributes[:'technologyType'] if attributes[:'technologyType']

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

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

  self.connection_string = attributes[:'connectionString'] if attributes[:'connectionString']

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

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

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

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

  self.database_id = attributes[:'databaseId'] if attributes[:'databaseId']

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

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

Instance Attribute Details

#connection_stringString

MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'

Returns:

  • (String)


21
22
23
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 21

def connection_string
  @connection_string
end

#database_idString

The OCID of the Oracle Autonomous Json Database.

Returns:

  • (String)


37
38
39
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 37

def database_id
  @database_id
end

#passwordString

The password Oracle GoldenGate uses to connect the associated database.

Returns:

  • (String)


32
33
34
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 32

def password
  @password
end

#technology_typeString

[Required] The MongoDB technology type.

Returns:

  • (String)


15
16
17
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 15

def technology_type
  @technology_type
end

#usernameString

The username Oracle GoldenGate uses to connect to the database. This username must already exist and be available by the database to be connected to.

Returns:

  • (String)


27
28
29
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 27

def username
  @username
end

Class Method Details

.attribute_mapObject

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 40

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'technology_type': :'technologyType',
    'connection_string': :'connectionString',
    'username': :'username',
    'password': :'password',
    'database_id': :'databaseId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'vault_id': :'String',
    'key_id': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'technology_type': :'String',
    'connection_string': :'String',
    'username': :'String',
    'password': :'String',
    'database_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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 148

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    technology_type == other.technology_type &&
    connection_string == other.connection_string &&
    username == other.username &&
    password == other.password &&
    database_id == other.database_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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 193

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


173
174
175
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 173

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



182
183
184
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 182

def hash
  [connection_type, display_name, description, compartment_id, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, technology_type, connection_string, username, password, database_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
235
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 226

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



220
221
222
# File 'lib/oci/golden_gate/models/create_mongo_db_connection_details.rb', line 220

def to_s
  to_hash.to_s
end