Class: OCI::GoldenGate::Models::ConnectionSummary

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

Overview

Summary of the Connection.

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_AI_DATA_PLATFORM = 'ORACLE_AI_DATA_PLATFORM'.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_DB2 = 'DB2'.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_DATABRICKS = 'DATABRICKS'.freeze,
  CONNECTION_TYPE_GOOGLE_PUBSUB = 'GOOGLE_PUBSUB'.freeze,
  CONNECTION_TYPE_MICROSOFT_FABRIC = 'MICROSOFT_FABRIC'.freeze,
  CONNECTION_TYPE_ICEBERG = 'ICEBERG'.freeze,
  CONNECTION_TYPE_AI_MODEL = 'AI_MODEL'.freeze,
  CONNECTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ROUTING_METHOD_ENUM = 
[
  ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'.freeze,
  ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'.freeze,
  ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'.freeze,
  ROUTING_METHOD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectionSummary

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

  • :routing_method (String) —

    The value to assign to the #routing_method property

  • :locks (Array<OCI::GoldenGate::Models::ResourceLock>) —

    The value to assign to the #locks property

  • :does_use_secret_ids (BOOLEAN) —

    The value to assign to the #does_use_secret_ids property

  • :subscription_id (String) —

    The value to assign to the #subscription_id property

  • :cluster_placement_group_id (String) —

    The value to assign to the #cluster_placement_group_id property

  • :security_attributes (Hash<String, Hash<String, Object>>) —

    The value to assign to the #security_attributes property



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 362

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

  self.routing_method = attributes[:'routingMethod'] if attributes[:'routingMethod']

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

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

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

  self.does_use_secret_ids = attributes[:'doesUseSecretIds'] unless attributes[:'doesUseSecretIds'].nil?
  self.does_use_secret_ids = false if does_use_secret_ids.nil? && !attributes.key?(:'doesUseSecretIds') # rubocop:disable Style/StringLiterals

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

  self.does_use_secret_ids = attributes[:'does_use_secret_ids'] unless attributes[:'does_use_secret_ids'].nil?
  self.does_use_secret_ids = false if does_use_secret_ids.nil? && !attributes.key?(:'doesUseSecretIds') && !attributes.key?(:'does_use_secret_ids') # rubocop:disable Style/StringLiterals

  self.subscription_id = attributes[:'subscriptionId'] if attributes[:'subscriptionId']

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

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

  self.cluster_placement_group_id = attributes[:'clusterPlacementGroupId'] if attributes[:'clusterPlacementGroupId']

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

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

Instance Attribute Details

#cluster_placement_group_id ⇒ String

The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.

Returns:

  • (String) 


217
218
219
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 217

def cluster_placement_group_id
  @cluster_placement_group_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment being referenced.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 79

def compartment_id
  @compartment_id
end

#connection_type ⇒ String

[Required] The connection type.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 58

def connection_type
  @connection_type
end

#defined_tags ⇒ Hash<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>>) 


94
95
96
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 94

def defined_tags
  @defined_tags
end

#description ⇒ String

Metadata about this specific object.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 74

def description
  @description
end

#display_name ⇒ String

[Required] An object's Display Name.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 69

def display_name
  @display_name
end

#does_use_secret_ids ⇒ BOOLEAN

Indicates that sensitive attributes are provided via Secrets.

Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

When set to true, all sensitive information must be provided as OCI Vault secrets using the corresponding *SecretId attributes of the connection (for example, passwordSecretId). Plain-text sensitive attributes (for example, password) must not be used. This ensures that sensitive information remains stored and managed in the customer's OCI Vault rather than by the GoldenGate service.

When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. If vaultId and keyId are not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.

If vaultId and keyId are provided, the specified customer-managed key is used.

Returns:

  • (BOOLEAN) 


206
207
208
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 206

def does_use_secret_ids
  @does_use_secret_ids
end

#freeform_tags ⇒ Hash<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>) 


87
88
89
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 87

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the connection being referenced.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 64

def id
  @id
end

#ingress_ips ⇒ Array<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.

Returns:



160
161
162
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 160

def ingress_ips
  @ingress_ips
end

#key_id ⇒ String

References the OCI Vault key in the OCI Vault identified by vaultId.

Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

The GoldenGate service uses this key to encrypt sensitive information (for example, password) that is provided in plain-text connection attributes through the API. This field is applicable only when doesUseSecretIds is set to false. If both vaultId and keyId are provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neither vaultId nor keyId is provided, the GoldenGate service uses Oracle-managed encryption keys.

Returns:

  • (String) 


154
155
156
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 154

def key_id
  @key_id
end

#lifecycle_details ⇒ String

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) 


114
115
116
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 114

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] Possible lifecycle states for connection.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 108

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::GoldenGate::Models::ResourceLock>

Locks associated with this resource.

Returns:



186
187
188
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 186

def locks
  @locks
end

#nsg_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


165
166
167
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 165

def nsg_ids
  @nsg_ids
end

#routing_method ⇒ String

Controls the network traffic direction to the target: SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.

Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns:

  • (String) 


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

def routing_method
  @routing_method
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


225
226
227
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 225

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

The OCID of the target subnet of the dedicated connection.

Returns:

  • (String) 


170
171
172
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 170

def subnet_id
  @subnet_id
end

#subscription_id ⇒ String

The OCID of the subscription with which resource needs to be associated with.

Returns:

  • (String) 


210
211
212
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 210

def subscription_id
  @subscription_id
end

#system_tags ⇒ Hash<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>>) 


103
104
105
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 103

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


120
121
122
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 120

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


126
127
128
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 126

def time_updated
  @time_updated
end

#vault_id ⇒ String

References the OCI Vault that contains the customer-managed encryption key identified by keyId.

Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

This field is applicable only when doesUseSecretIds is set to false. If vaultId is provided, keyId must also be provided.

Returns:

  • (String) 


139
140
141
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 139

def vault_id
  @vault_id
end

Class Method Details

.attribute_map ⇒ Object

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 228

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',
    'routing_method': :'routingMethod',
    'locks': :'locks',
    'does_use_secret_ids': :'doesUseSecretIds',
    'subscription_id': :'subscriptionId',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'security_attributes': :'securityAttributes'
    # 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.



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
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 294

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

  return 'OCI::GoldenGate::Models::MicrosoftFabricConnectionSummary' if type == 'MICROSOFT_FABRIC'
  return 'OCI::GoldenGate::Models::KafkaSchemaRegistryConnectionSummary' if type == 'KAFKA_SCHEMA_REGISTRY'
  return 'OCI::GoldenGate::Models::MicrosoftSqlserverConnectionSummary' if type == 'MICROSOFT_SQLSERVER'
  return 'OCI::GoldenGate::Models::OracleNosqlConnectionSummary' if type == 'ORACLE_NOSQL'
  return 'OCI::GoldenGate::Models::OracleConnectionSummary' if type == 'ORACLE'
  return 'OCI::GoldenGate::Models::OciObjectStorageConnectionSummary' if type == 'OCI_OBJECT_STORAGE'
  return 'OCI::GoldenGate::Models::AzureSynapseConnectionSummary' if type == 'AZURE_SYNAPSE_ANALYTICS'
  return 'OCI::GoldenGate::Models::OracleAiDataPlatformConnectionSummary' if type == 'ORACLE_AI_DATA_PLATFORM'
  return 'OCI::GoldenGate::Models::MongoDbConnectionSummary' if type == 'MONGODB'
  return 'OCI::GoldenGate::Models::AmazonS3ConnectionSummary' if type == 'AMAZON_S3'
  return 'OCI::GoldenGate::Models::MysqlConnectionSummary' if type == 'MYSQL'
  return 'OCI::GoldenGate::Models::ElasticsearchConnectionSummary' if type == 'ELASTICSEARCH'
  return 'OCI::GoldenGate::Models::GooglePubSubConnectionSummary' if type == 'GOOGLE_PUBSUB'
  return 'OCI::GoldenGate::Models::GoogleCloudStorageConnectionSummary' if type == 'GOOGLE_CLOUD_STORAGE'
  return 'OCI::GoldenGate::Models::GoldenGateConnectionSummary' if type == 'GOLDENGATE'
  return 'OCI::GoldenGate::Models::JavaMessageServiceConnectionSummary' if type == 'JAVA_MESSAGE_SERVICE'
  return 'OCI::GoldenGate::Models::SnowflakeConnectionSummary' if type == 'SNOWFLAKE'
  return 'OCI::GoldenGate::Models::AmazonKinesisConnectionSummary' if type == 'AMAZON_KINESIS'
  return 'OCI::GoldenGate::Models::RedisConnectionSummary' if type == 'REDIS'
  return 'OCI::GoldenGate::Models::AzureDataLakeStorageConnectionSummary' if type == 'AZURE_DATA_LAKE_STORAGE'
  return 'OCI::GoldenGate::Models::GoogleBigQueryConnectionSummary' if type == 'GOOGLE_BIGQUERY'
  return 'OCI::GoldenGate::Models::IcebergConnectionSummary' if type == 'ICEBERG'
  return 'OCI::GoldenGate::Models::PostgresqlConnectionSummary' if type == 'POSTGRESQL'
  return 'OCI::GoldenGate::Models::GenericConnectionSummary' if type == 'GENERIC'
  return 'OCI::GoldenGate::Models::KafkaConnectionSummary' if type == 'KAFKA'
  return 'OCI::GoldenGate::Models::AiModelConnectionSummary' if type == 'AI_MODEL'
  return 'OCI::GoldenGate::Models::Db2ConnectionSummary' if type == 'DB2'
  return 'OCI::GoldenGate::Models::AmazonRedshiftConnectionSummary' if type == 'AMAZON_REDSHIFT'
  return 'OCI::GoldenGate::Models::DatabricksConnectionSummary' if type == 'DATABRICKS'
  return 'OCI::GoldenGate::Models::HdfsConnectionSummary' if type == 'HDFS'

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

.swagger_types ⇒ Object

Attribute type mapping.



259
260
261
262
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
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 259

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',
    'routing_method': :'String',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'does_use_secret_ids': :'BOOLEAN',
    'subscription_id': :'String',
    'cluster_placement_group_id': :'String',
    'security_attributes': :'Hash<String, Hash<String, Object>>'
    # 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



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 530

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 &&
    routing_method == other.routing_method &&
    locks == other.locks &&
    does_use_secret_ids == other.does_use_secret_ids &&
    subscription_id == other.subscription_id &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    security_attributes == other.security_attributes
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



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 582

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


562
563
564
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 562

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



571
572
573
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 571

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, routing_method, locks, does_use_secret_ids, subscription_id, cluster_placement_group_id, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



615
616
617
618
619
620
621
622
623
624
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 615

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



609
610
611
 
# File 'lib/oci/golden_gate/models/connection_summary.rb', line 609

def to_s
  to_hash.to_s
end