Class: OCI::GoldenGate::Models::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/models/connection.rb

Overview

Represents the metadata description of a connection used by deployments in the same compartment.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

CONNECTION_TYPE_ENUM =
[
  CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'.freeze,
  CONNECTION_TYPE_KAFKA = 'KAFKA'.freeze,
  CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'.freeze,
  CONNECTION_TYPE_MYSQL = 'MYSQL'.freeze,
  CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'.freeze,
  CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'.freeze,
  CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'.freeze,
  CONNECTION_TYPE_ORACLE = 'ORACLE'.freeze,
  CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'.freeze,
  CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'.freeze,
  CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'.freeze,
  CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'.freeze,
  CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'.freeze,
  CONNECTION_TYPE_HDFS = 'HDFS'.freeze,
  CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'.freeze,
  CONNECTION_TYPE_MONGODB = 'MONGODB'.freeze,
  CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'.freeze,
  CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'.freeze,
  CONNECTION_TYPE_REDIS = 'REDIS'.freeze,
  CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'.freeze,
  CONNECTION_TYPE_GENERIC = 'GENERIC'.freeze,
  CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'.freeze,
  CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'.freeze,
  CONNECTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Connection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :connection_type (String)

    The value to assign to the #connection_type property

  • :id (String)

    The value to assign to the #id property

  • :display_name (String)

    The value to assign to the #display_name property

  • :description (String)

    The value to assign to the #description property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #system_tags property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String)

    The value to assign to the #lifecycle_details property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_updated (DateTime)

    The value to assign to the #time_updated property

  • :vault_id (String)

    The value to assign to the #vault_id property

  • :key_id (String)

    The value to assign to the #key_id property

  • :ingress_ips (Array<OCI::GoldenGate::Models::IngressIpDetails>)

    The value to assign to the #ingress_ips property

  • :nsg_ids (Array<String>)

    The value to assign to the #nsg_ids property

  • :subnet_id (String)

    The value to assign to the #subnet_id property



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
# File 'lib/oci/golden_gate/models/connection.rb', line 263

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

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

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

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

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

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.vault_id = attributes[:'vaultId'] if attributes[:'vaultId']

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

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

  self.key_id = attributes[:'keyId'] if attributes[:'keyId']

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

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

  self.ingress_ips = attributes[:'ingressIps'] if attributes[:'ingressIps']

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

Instance Attribute Details

#compartment_idString

[Required] The OCID of the compartment being referenced.

Returns:

  • (String)


75
76
77
# File 'lib/oci/golden_gate/models/connection.rb', line 75

def compartment_id
  @compartment_id
end

#connection_typeString

[Required] The connection type.

Returns:

  • (String)


54
55
56
# File 'lib/oci/golden_gate/models/connection.rb', line 54

def connection_type
  @connection_type
end

#defined_tagsHash<String, Hash<String, Object>>

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


90
91
92
# File 'lib/oci/golden_gate/models/connection.rb', line 90

def defined_tags
  @defined_tags
end

#descriptionString

Metadata about this specific object.

Returns:

  • (String)


70
71
72
# File 'lib/oci/golden_gate/models/connection.rb', line 70

def description
  @description
end

#display_nameString

[Required] An object's Display Name.

Returns:

  • (String)


65
66
67
# File 'lib/oci/golden_gate/models/connection.rb', line 65

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>)


83
84
85
# File 'lib/oci/golden_gate/models/connection.rb', line 83

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the connection being referenced.

Returns:

  • (String)


60
61
62
# File 'lib/oci/golden_gate/models/connection.rb', line 60

def id
  @id
end

#ingress_ipsArray<OCI::GoldenGate::Models::IngressIpDetails>

List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.



141
142
143
# File 'lib/oci/golden_gate/models/connection.rb', line 141

def ingress_ips
  @ingress_ips
end

#key_idString

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

Returns:

  • (String)


135
136
137
# File 'lib/oci/golden_gate/models/connection.rb', line 135

def key_id
  @key_id
end

#lifecycle_detailsString

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Returns:

  • (String)


110
111
112
# File 'lib/oci/golden_gate/models/connection.rb', line 110

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

[Required] Possible lifecycle states for connection.

Returns:

  • (String)


104
105
106
# File 'lib/oci/golden_gate/models/connection.rb', line 104

def lifecycle_state
  @lifecycle_state
end

#nsg_idsArray<String>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns:

  • (Array<String>)


146
147
148
# File 'lib/oci/golden_gate/models/connection.rb', line 146

def nsg_ids
  @nsg_ids
end

#subnet_idString

The OCID of the subnet being referenced.

Returns:

  • (String)


151
152
153
# File 'lib/oci/golden_gate/models/connection.rb', line 151

def subnet_id
  @subnet_id
end

#system_tagsHash<String, Hash<String, Object>>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.

Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

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


99
100
101
# File 'lib/oci/golden_gate/models/connection.rb', line 99

def system_tags
  @system_tags
end

#time_createdDateTime

[Required] The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime)


116
117
118
# File 'lib/oci/golden_gate/models/connection.rb', line 116

def time_created
  @time_created
end

#time_updatedDateTime

[Required] The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime)


122
123
124
# File 'lib/oci/golden_gate/models/connection.rb', line 122

def time_updated
  @time_updated
end

#vault_idString

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Returns:

  • (String)


129
130
131
# File 'lib/oci/golden_gate/models/connection.rb', line 129

def vault_id
  @vault_id
end

Class Method Details

.attribute_mapObject

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/oci/golden_gate/models/connection.rb', line 154

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/oci/golden_gate/models/connection.rb', line 208

def self.get_subtype(object_hash)
  type = object_hash[:'connectionType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::GoldenGate::Models::KafkaConnection' if type == 'KAFKA'
  return 'OCI::GoldenGate::Models::PostgresqlConnection' if type == 'POSTGRESQL'
  return 'OCI::GoldenGate::Models::JavaMessageServiceConnection' if type == 'JAVA_MESSAGE_SERVICE'
  return 'OCI::GoldenGate::Models::ElasticsearchConnection' if type == 'ELASTICSEARCH'
  return 'OCI::GoldenGate::Models::AmazonRedshiftConnection' if type == 'AMAZON_REDSHIFT'
  return 'OCI::GoldenGate::Models::SnowflakeConnection' if type == 'SNOWFLAKE'
  return 'OCI::GoldenGate::Models::GoldenGateConnection' if type == 'GOLDENGATE'
  return 'OCI::GoldenGate::Models::MysqlConnection' if type == 'MYSQL'
  return 'OCI::GoldenGate::Models::AmazonS3Connection' if type == 'AMAZON_S3'
  return 'OCI::GoldenGate::Models::GoogleBigQueryConnection' if type == 'GOOGLE_BIGQUERY'
  return 'OCI::GoldenGate::Models::OracleConnection' if type == 'ORACLE'
  return 'OCI::GoldenGate::Models::AzureDataLakeStorageConnection' if type == 'AZURE_DATA_LAKE_STORAGE'
  return 'OCI::GoldenGate::Models::MongoDbConnection' if type == 'MONGODB'
  return 'OCI::GoldenGate::Models::HdfsConnection' if type == 'HDFS'
  return 'OCI::GoldenGate::Models::GoogleCloudStorageConnection' if type == 'GOOGLE_CLOUD_STORAGE'
  return 'OCI::GoldenGate::Models::OciObjectStorageConnection' if type == 'OCI_OBJECT_STORAGE'
  return 'OCI::GoldenGate::Models::KafkaSchemaRegistryConnection' if type == 'KAFKA_SCHEMA_REGISTRY'
  return 'OCI::GoldenGate::Models::MicrosoftSqlserverConnection' if type == 'MICROSOFT_SQLSERVER'
  return 'OCI::GoldenGate::Models::AmazonKinesisConnection' if type == 'AMAZON_KINESIS'
  return 'OCI::GoldenGate::Models::GenericConnection' if type == 'GENERIC'
  return 'OCI::GoldenGate::Models::OracleNosqlConnection' if type == 'ORACLE_NOSQL'
  return 'OCI::GoldenGate::Models::AzureSynapseConnection' if type == 'AZURE_SYNAPSE_ANALYTICS'
  return 'OCI::GoldenGate::Models::RedisConnection' if type == 'REDIS'

  # TODO: Log a warning when the subtype is not found.
  'OCI::GoldenGate::Models::Connection'
end

.swagger_typesObject

Attribute type mapping.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/oci/golden_gate/models/connection.rb', line 179

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'lib/oci/golden_gate/models/connection.rb', line 397

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    ingress_ips == other.ingress_ips &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_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



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
# File 'lib/oci/golden_gate/models/connection.rb', line 443

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


423
424
425
# File 'lib/oci/golden_gate/models/connection.rb', line 423

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



432
433
434
# File 'lib/oci/golden_gate/models/connection.rb', line 432

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, vault_id, key_id, ingress_ips, nsg_ids, subnet_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



476
477
478
479
480
481
482
483
484
485
# File 'lib/oci/golden_gate/models/connection.rb', line 476

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



470
471
472
# File 'lib/oci/golden_gate/models/connection.rb', line 470

def to_s
  to_hash.to_s
end