Class: OCI::GoldenGate::Models::UpdateConnectionDetails

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

Overview

The information to update a 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
].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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateConnectionDetails

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description 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

  • :vault_id (String) —

    The value to assign to the #vault_id property

  • :key_id (String) —

    The value to assign to the #key_id 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

  • :does_use_secret_ids (BOOLEAN) —

    The value to assign to the #does_use_secret_ids property

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

    The value to assign to the #security_attributes property



226
227
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
257
258
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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 226

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.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.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.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.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.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.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

#connection_type ⇒ String

The connection type.

Returns:

  • (String) 


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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

Metadata about this specific object.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

An object's Display Name.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 59

def display_name
  @display_name
end

#does_use_secret_ids ⇒ BOOLEAN

Indicates that sensitive attributes are provided via Secrets.

Returns:

  • (BOOLEAN) 


115
116
117
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 115

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


72
73
74
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 72

def freeform_tags
  @freeform_tags
end

#key_id ⇒ String

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) 


92
93
94
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 92

def key_id
  @key_id
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>) 


97
98
99
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 97

def nsg_ids
  @nsg_ids
end

#routing_method ⇒ String

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. 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.

Returns:

  • (String) 


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

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


123
124
125
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 123

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

The OCID of the target subnet of the dedicated connection.

Returns:

  • (String) 


102
103
104
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 102

def subnet_id
  @subnet_id
end

#vault_id ⇒ String

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) 


86
87
88
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 86

def vault_id
  @vault_id
end

Class Method Details

.attribute_map ⇒ Object

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 126

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    '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.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 170

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

  return 'OCI::GoldenGate::Models::UpdateElasticsearchConnectionDetails' if type == 'ELASTICSEARCH'
  return 'OCI::GoldenGate::Models::UpdateGoogleBigQueryConnectionDetails' if type == 'GOOGLE_BIGQUERY'
  return 'OCI::GoldenGate::Models::UpdateOracleConnectionDetails' if type == 'ORACLE'
  return 'OCI::GoldenGate::Models::UpdateAmazonRedshiftConnectionDetails' if type == 'AMAZON_REDSHIFT'
  return 'OCI::GoldenGate::Models::UpdateOciObjectStorageConnectionDetails' if type == 'OCI_OBJECT_STORAGE'
  return 'OCI::GoldenGate::Models::UpdateRedisConnectionDetails' if type == 'REDIS'
  return 'OCI::GoldenGate::Models::UpdateMongoDbConnectionDetails' if type == 'MONGODB'
  return 'OCI::GoldenGate::Models::UpdateGoogleCloudStorageConnectionDetails' if type == 'GOOGLE_CLOUD_STORAGE'
  return 'OCI::GoldenGate::Models::UpdateOracleAiDataPlatformConnectionDetails' if type == 'ORACLE_AI_DATA_PLATFORM'
  return 'OCI::GoldenGate::Models::UpdateMicrosoftFabricConnectionDetails' if type == 'MICROSOFT_FABRIC'
  return 'OCI::GoldenGate::Models::UpdatePostgresqlConnectionDetails' if type == 'POSTGRESQL'
  return 'OCI::GoldenGate::Models::UpdateMicrosoftSqlserverConnectionDetails' if type == 'MICROSOFT_SQLSERVER'
  return 'OCI::GoldenGate::Models::UpdateSnowflakeConnectionDetails' if type == 'SNOWFLAKE'
  return 'OCI::GoldenGate::Models::UpdateHdfsConnectionDetails' if type == 'HDFS'
  return 'OCI::GoldenGate::Models::UpdateDatabricksConnectionDetails' if type == 'DATABRICKS'
  return 'OCI::GoldenGate::Models::UpdateKafkaConnectionDetails' if type == 'KAFKA'
  return 'OCI::GoldenGate::Models::UpdateAzureDataLakeStorageConnectionDetails' if type == 'AZURE_DATA_LAKE_STORAGE'
  return 'OCI::GoldenGate::Models::UpdateAmazonKinesisConnectionDetails' if type == 'AMAZON_KINESIS'
  return 'OCI::GoldenGate::Models::UpdateJavaMessageServiceConnectionDetails' if type == 'JAVA_MESSAGE_SERVICE'
  return 'OCI::GoldenGate::Models::UpdateGoldenGateConnectionDetails' if type == 'GOLDENGATE'
  return 'OCI::GoldenGate::Models::UpdateGooglePubSubConnectionDetails' if type == 'GOOGLE_PUBSUB'
  return 'OCI::GoldenGate::Models::UpdateOracleNosqlConnectionDetails' if type == 'ORACLE_NOSQL'
  return 'OCI::GoldenGate::Models::UpdateKafkaSchemaRegistryConnectionDetails' if type == 'KAFKA_SCHEMA_REGISTRY'
  return 'OCI::GoldenGate::Models::UpdateAmazonS3ConnectionDetails' if type == 'AMAZON_S3'
  return 'OCI::GoldenGate::Models::UpdateMysqlConnectionDetails' if type == 'MYSQL'
  return 'OCI::GoldenGate::Models::UpdateDb2ConnectionDetails' if type == 'DB2'
  return 'OCI::GoldenGate::Models::UpdateIcebergConnectionDetails' if type == 'ICEBERG'
  return 'OCI::GoldenGate::Models::UpdateGenericConnectionDetails' if type == 'GENERIC'
  return 'OCI::GoldenGate::Models::UpdateAzureSynapseConnectionDetails' if type == 'AZURE_SYNAPSE_ANALYTICS'

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

.swagger_types ⇒ Object

Attribute type mapping.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 146

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'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',
    'does_use_secret_ids': :'BOOLEAN',
    '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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 326

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    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 &&
    does_use_secret_ids == other.does_use_secret_ids &&
    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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 367

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


347
348
349
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 347

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



356
357
358
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 356

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, does_use_secret_ids, 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



400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 400

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



394
395
396
 
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 394

def to_s
  to_hash.to_s
end