Class: OCI::GoldenGate::Models::UpdateConnectionDetails
- Inherits:
-
Object
- Object
- OCI::GoldenGate::Models::UpdateConnectionDetails
- 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
Direct Known Subclasses
UpdateAmazonKinesisConnectionDetails, UpdateAmazonRedshiftConnectionDetails, UpdateAmazonS3ConnectionDetails, UpdateAzureDataLakeStorageConnectionDetails, UpdateAzureSynapseConnectionDetails, UpdateElasticsearchConnectionDetails, UpdateGenericConnectionDetails, UpdateGoldenGateConnectionDetails, UpdateGoogleBigQueryConnectionDetails, UpdateGoogleCloudStorageConnectionDetails, UpdateHdfsConnectionDetails, UpdateJavaMessageServiceConnectionDetails, UpdateKafkaConnectionDetails, UpdateKafkaSchemaRegistryConnectionDetails, UpdateMicrosoftSqlserverConnectionDetails, UpdateMongoDbConnectionDetails, UpdateMysqlConnectionDetails, UpdateOciObjectStorageConnectionDetails, UpdateOracleConnectionDetails, UpdateOracleNosqlConnectionDetails, UpdatePostgresqlConnectionDetails, UpdateRedisConnectionDetails, UpdateSnowflakeConnectionDetails
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
Instance Attribute Summary collapse
-
#connection_type ⇒ String
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
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.
-
#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 = {}) ⇒ UpdateConnectionDetails
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 = {}) ⇒ UpdateConnectionDetails
Initializes the object
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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 170 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. = 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'] end |
Instance Attribute Details
#connection_type ⇒ String
The connection type.
42 43 44 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 42 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\"}}
67 68 69 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 67 def @defined_tags end |
#description ⇒ String
Metadata about this specific object.
52 53 54 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 52 def description @description end |
#display_name ⇒ String
An object's Display Name.
47 48 49 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 47 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\"}
60 61 62 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 60 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.
80 81 82 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 80 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.
85 86 87 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 85 def nsg_ids @nsg_ids 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.
74 75 76 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 74 def vault_id @vault_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 88 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' # 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.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 124 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::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::UpdatePostgresqlConnectionDetails' if type == 'POSTGRESQL' return 'OCI::GoldenGate::Models::UpdateMicrosoftSqlserverConnectionDetails' if type == 'MICROSOFT_SQLSERVER' 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::UpdateSnowflakeConnectionDetails' if type == 'SNOWFLAKE' return 'OCI::GoldenGate::Models::UpdateHdfsConnectionDetails' if type == 'HDFS' return 'OCI::GoldenGate::Models::UpdateMysqlConnectionDetails' if type == 'MYSQL' return 'OCI::GoldenGate::Models::UpdateKafkaConnectionDetails' if type == 'KAFKA' 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.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 104 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>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 236 def ==(other) return true if equal?(other) self.class == other.class && connection_type == other.connection_type && display_name == other.display_name && description == other.description && == other. && == other. && vault_id == other.vault_id && key_id == other.key_id && nsg_ids == other.nsg_ids end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 273 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
253 254 255 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 253 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
262 263 264 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 262 def hash [connection_type, display_name, description, , , vault_id, key_id, nsg_ids].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
306 307 308 309 310 311 312 313 314 315 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 306 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
300 301 302 |
# File 'lib/oci/golden_gate/models/update_connection_details.rb', line 300 def to_s to_hash.to_s end |