Class: OCI::GoldenGate::Models::CreateConnectionDetails
- Inherits:
-
Object
- Object
- OCI::GoldenGate::Models::CreateConnectionDetails
- Defined in:
- lib/oci/golden_gate/models/create_connection_details.rb
Overview
The information about a new 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
Direct Known Subclasses
CreateAmazonKinesisConnectionDetails, CreateAmazonRedshiftConnectionDetails, CreateAmazonS3ConnectionDetails, CreateAzureDataLakeStorageConnectionDetails, CreateAzureSynapseConnectionDetails, CreateElasticsearchConnectionDetails, CreateGenericConnectionDetails, CreateGoldenGateConnectionDetails, CreateGoogleBigQueryConnectionDetails, CreateGoogleCloudStorageConnectionDetails, CreateHdfsConnectionDetails, CreateJavaMessageServiceConnectionDetails, CreateKafkaConnectionDetails, CreateKafkaSchemaRegistryConnectionDetails, CreateMicrosoftSqlserverConnectionDetails, CreateMongoDbConnectionDetails, CreateMysqlConnectionDetails, CreateOciObjectStorageConnectionDetails, CreateOracleConnectionDetails, CreateOracleNosqlConnectionDetails, CreatePostgresqlConnectionDetails, CreateRedisConnectionDetails, CreateSnowflakeConnectionDetails
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 ].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
-
#compartment_id ⇒ String
[Required] The OCID of the compartment being referenced.
-
#connection_type ⇒ String
[Required] The connection type.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Tags defined for this resource.
-
#description ⇒ String
Metadata about this specific object.
-
#display_name ⇒ String
[Required] An object's Display Name.
-
#freeform_tags ⇒ Hash<String, String>
A simple key-value pair that is applied without any predefined name, type, or scope.
-
#key_id ⇒ String
Refers to the customer's master key OCID.
-
#nsg_ids ⇒ Array<String>
An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
-
#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.
-
#subnet_id ⇒ String
The OCID of the target subnet of the dedicated connection.
-
#vault_id ⇒ String
Refers to the customer's vault OCID.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.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.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateConnectionDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CreateConnectionDetails
Initializes the object
203 204 205 206 207 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 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 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 203 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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = 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'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment being referenced.
63 64 65 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 63 def compartment_id @compartment_id end |
#connection_type ⇒ String
[Required] The connection type.
48 49 50 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 48 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\"}}
78 79 80 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 78 def @defined_tags end |
#description ⇒ String
Metadata about this specific object.
58 59 60 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 58 def description @description end |
#display_name ⇒ String
[Required] An object's Display Name.
53 54 55 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 53 def display_name @display_name 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\"}
71 72 73 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 71 def @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.
91 92 93 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 91 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.
96 97 98 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 96 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.
109 110 111 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 109 def routing_method @routing_method end |
#subnet_id ⇒ String
The OCID of the target subnet of the dedicated connection.
101 102 103 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 101 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.
85 86 87 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 85 def vault_id @vault_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 112 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' # 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.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 154 def self.get_subtype(object_hash) type = object_hash[:'connectionType'] # rubocop:disable Style/SymbolLiteral return 'OCI::GoldenGate::Models::CreatePostgresqlConnectionDetails' if type == 'POSTGRESQL' return 'OCI::GoldenGate::Models::CreateKafkaSchemaRegistryConnectionDetails' if type == 'KAFKA_SCHEMA_REGISTRY' return 'OCI::GoldenGate::Models::CreateMicrosoftSqlserverConnectionDetails' if type == 'MICROSOFT_SQLSERVER' return 'OCI::GoldenGate::Models::CreateJavaMessageServiceConnectionDetails' if type == 'JAVA_MESSAGE_SERVICE' return 'OCI::GoldenGate::Models::CreateGoogleBigQueryConnectionDetails' if type == 'GOOGLE_BIGQUERY' return 'OCI::GoldenGate::Models::CreateAmazonKinesisConnectionDetails' if type == 'AMAZON_KINESIS' return 'OCI::GoldenGate::Models::CreateSnowflakeConnectionDetails' if type == 'SNOWFLAKE' return 'OCI::GoldenGate::Models::CreateAzureDataLakeStorageConnectionDetails' if type == 'AZURE_DATA_LAKE_STORAGE' return 'OCI::GoldenGate::Models::CreateMongoDbConnectionDetails' if type == 'MONGODB' return 'OCI::GoldenGate::Models::CreateAmazonS3ConnectionDetails' if type == 'AMAZON_S3' return 'OCI::GoldenGate::Models::CreateHdfsConnectionDetails' if type == 'HDFS' return 'OCI::GoldenGate::Models::CreateOciObjectStorageConnectionDetails' if type == 'OCI_OBJECT_STORAGE' return 'OCI::GoldenGate::Models::CreateElasticsearchConnectionDetails' if type == 'ELASTICSEARCH' return 'OCI::GoldenGate::Models::CreateAzureSynapseConnectionDetails' if type == 'AZURE_SYNAPSE_ANALYTICS' return 'OCI::GoldenGate::Models::CreateRedisConnectionDetails' if type == 'REDIS' return 'OCI::GoldenGate::Models::CreateMysqlConnectionDetails' if type == 'MYSQL' return 'OCI::GoldenGate::Models::CreateGenericConnectionDetails' if type == 'GENERIC' return 'OCI::GoldenGate::Models::CreateGoogleCloudStorageConnectionDetails' if type == 'GOOGLE_CLOUD_STORAGE' return 'OCI::GoldenGate::Models::CreateKafkaConnectionDetails' if type == 'KAFKA' return 'OCI::GoldenGate::Models::CreateOracleConnectionDetails' if type == 'ORACLE' return 'OCI::GoldenGate::Models::CreateGoldenGateConnectionDetails' if type == 'GOLDENGATE' return 'OCI::GoldenGate::Models::CreateAmazonRedshiftConnectionDetails' if type == 'AMAZON_REDSHIFT' return 'OCI::GoldenGate::Models::CreateOracleNosqlConnectionDetails' if type == 'ORACLE_NOSQL' # TODO: Log a warning when the subtype is not found. 'OCI::GoldenGate::Models::CreateConnectionDetails' end |
.swagger_types ⇒ Object
Attribute type mapping.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 131 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' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 295 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 && == other. && == other. && 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 end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 335 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
315 316 317 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 315 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
324 325 326 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 324 def hash [connection_type, display_name, description, compartment_id, , , vault_id, key_id, nsg_ids, subnet_id, routing_method].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
368 369 370 371 372 373 374 375 376 377 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 368 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
362 363 364 |
# File 'lib/oci/golden_gate/models/create_connection_details.rb', line 362 def to_s to_hash.to_s end |