UpdateMicrosoftSqlserverConnectionDetails¶

class oci.golden_gate.models.UpdateMicrosoftSqlserverConnectionDetails(**kwargs)¶

Bases: oci.golden_gate.models.update_connection_details.UpdateConnectionDetails

The information to update a Microsoft SQL Server Connection.

Attributes

`CONNECTION_TYPE_AMAZON_KINESIS`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_REDSHIFT`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_S3`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS`	str(object=’’) -> str
`CONNECTION_TYPE_DB2`	str(object=’’) -> str
`CONNECTION_TYPE_ELASTICSEARCH`	str(object=’’) -> str
`CONNECTION_TYPE_GENERIC`	str(object=’’) -> str
`CONNECTION_TYPE_GOLDENGATE`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_BIGQUERY`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_HDFS`	str(object=’’) -> str
`CONNECTION_TYPE_JAVA_MESSAGE_SERVICE`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY`	str(object=’’) -> str
`CONNECTION_TYPE_MICROSOFT_SQLSERVER`	str(object=’’) -> str
`CONNECTION_TYPE_MONGODB`	str(object=’’) -> str
`CONNECTION_TYPE_MYSQL`	str(object=’’) -> str
`CONNECTION_TYPE_OCI_OBJECT_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE_NOSQL`	str(object=’’) -> str
`CONNECTION_TYPE_POSTGRESQL`	str(object=’’) -> str
`CONNECTION_TYPE_REDIS`	str(object=’’) -> str
`CONNECTION_TYPE_SNOWFLAKE`	str(object=’’) -> str
`ROUTING_METHOD_DEDICATED_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_SERVICE_ENDPOINT`	str(object=’’) -> str
`additional_attributes`	Gets the additional_attributes of this UpdateMicrosoftSqlserverConnectionDetails.
`connection_type`	Gets the connection_type of this UpdateConnectionDetails.
`database_name`	Gets the database_name of this UpdateMicrosoftSqlserverConnectionDetails.
`defined_tags`	Gets the defined_tags of this UpdateConnectionDetails.
`description`	Gets the description of this UpdateConnectionDetails.
`display_name`	Gets the display_name of this UpdateConnectionDetails.
`does_use_secret_ids`	Gets the does_use_secret_ids of this UpdateConnectionDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateConnectionDetails.
`host`	Gets the host of this UpdateMicrosoftSqlserverConnectionDetails.
`key_id`	Gets the key_id of this UpdateConnectionDetails.
`nsg_ids`	Gets the nsg_ids of this UpdateConnectionDetails.
`password`	Gets the password of this UpdateMicrosoftSqlserverConnectionDetails.
`password_secret_id`	Gets the password_secret_id of this UpdateMicrosoftSqlserverConnectionDetails.
`port`	Gets the port of this UpdateMicrosoftSqlserverConnectionDetails.
`private_ip`	Gets the private_ip of this UpdateMicrosoftSqlserverConnectionDetails.
`routing_method`	Gets the routing_method of this UpdateConnectionDetails.
`security_protocol`	Gets the security_protocol of this UpdateMicrosoftSqlserverConnectionDetails.
`should_validate_server_certificate`	Gets the should_validate_server_certificate of this UpdateMicrosoftSqlserverConnectionDetails.
`ssl_ca`	Gets the ssl_ca of this UpdateMicrosoftSqlserverConnectionDetails.
`subnet_id`	Gets the subnet_id of this UpdateConnectionDetails.
`username`	Gets the username of this UpdateMicrosoftSqlserverConnectionDetails.
`vault_id`	Gets the vault_id of this UpdateConnectionDetails.

Methods

`__init__`(**kwargs)	Initializes a new UpdateMicrosoftSqlserverConnectionDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'¶

CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'¶

CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'¶

CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'¶

CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'¶

CONNECTION_TYPE_DB2 = 'DB2'¶

CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'¶

CONNECTION_TYPE_GENERIC = 'GENERIC'¶

CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'¶

CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'¶

CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'¶

CONNECTION_TYPE_HDFS = 'HDFS'¶

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'¶

CONNECTION_TYPE_KAFKA = 'KAFKA'¶

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'¶

CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'¶

CONNECTION_TYPE_MONGODB = 'MONGODB'¶

CONNECTION_TYPE_MYSQL = 'MYSQL'¶

CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'¶

CONNECTION_TYPE_ORACLE = 'ORACLE'¶

CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'¶

CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'¶

CONNECTION_TYPE_REDIS = 'REDIS'¶

CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'¶

ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'¶

ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'¶

ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'¶

__init__(**kwargs)¶

Initializes a new UpdateMicrosoftSqlserverConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is MICROSOFT_SQLSERVER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

connection_type (str) – The value to assign to the connection_type property of this UpdateMicrosoftSqlserverConnectionDetails. Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”
display_name (str) – The value to assign to the display_name property of this UpdateMicrosoftSqlserverConnectionDetails.
description (str) – The value to assign to the description property of this UpdateMicrosoftSqlserverConnectionDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateMicrosoftSqlserverConnectionDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateMicrosoftSqlserverConnectionDetails.
vault_id (str) – The value to assign to the vault_id property of this UpdateMicrosoftSqlserverConnectionDetails.
key_id (str) – The value to assign to the key_id property of this UpdateMicrosoftSqlserverConnectionDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this UpdateMicrosoftSqlserverConnectionDetails.
subnet_id (str) – The value to assign to the subnet_id property of this UpdateMicrosoftSqlserverConnectionDetails.
routing_method (str) – The value to assign to the routing_method property of this UpdateMicrosoftSqlserverConnectionDetails. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”
does_use_secret_ids (bool) – The value to assign to the does_use_secret_ids property of this UpdateMicrosoftSqlserverConnectionDetails.
database_name (str) – The value to assign to the database_name property of this UpdateMicrosoftSqlserverConnectionDetails.
host (str) – The value to assign to the host property of this UpdateMicrosoftSqlserverConnectionDetails.
port (int) – The value to assign to the port property of this UpdateMicrosoftSqlserverConnectionDetails.
username (str) – The value to assign to the username property of this UpdateMicrosoftSqlserverConnectionDetails.
password (str) – The value to assign to the password property of this UpdateMicrosoftSqlserverConnectionDetails.
password_secret_id (str) – The value to assign to the password_secret_id property of this UpdateMicrosoftSqlserverConnectionDetails.
additional_attributes (list[oci.golden_gate.models.NameValuePair]) – The value to assign to the additional_attributes property of this UpdateMicrosoftSqlserverConnectionDetails.
security_protocol (str) – The value to assign to the security_protocol property of this UpdateMicrosoftSqlserverConnectionDetails.
ssl_ca (str) – The value to assign to the ssl_ca property of this UpdateMicrosoftSqlserverConnectionDetails.
should_validate_server_certificate (bool) – The value to assign to the should_validate_server_certificate property of this UpdateMicrosoftSqlserverConnectionDetails.
private_ip (str) – The value to assign to the private_ip property of this UpdateMicrosoftSqlserverConnectionDetails.

additional_attributes¶

Gets the additional_attributes of this UpdateMicrosoftSqlserverConnectionDetails. An array of name-value pair attribute entries. Used as additional parameters in connection string.

Returns:	The additional_attributes of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	list[oci.golden_gate.models.NameValuePair]

connection_type¶

Gets the connection_type of this UpdateConnectionDetails. The connection type.

Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”

Returns:	The connection_type of this UpdateConnectionDetails.
Return type:	str

database_name¶

Gets the database_name of this UpdateMicrosoftSqlserverConnectionDetails. The name of the database.

Returns:	The database_name of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this UpdateConnectionDetails. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this UpdateConnectionDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this UpdateConnectionDetails. Metadata about this specific object.

Returns:	The description of this UpdateConnectionDetails.
Return type:	str

display_name¶

Gets the display_name of this UpdateConnectionDetails. An object’s Display Name.

Returns:	The display_name of this UpdateConnectionDetails.
Return type:	str

does_use_secret_ids¶

Gets the does_use_secret_ids of this UpdateConnectionDetails. Indicates that sensitive attributes are provided via Secrets.

Returns:	The does_use_secret_ids of this UpdateConnectionDetails.
Return type:	bool

freeform_tags¶

Gets the freeform_tags of this UpdateConnectionDetails. 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:	The freeform_tags of this UpdateConnectionDetails.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

host¶

Gets the host of this UpdateMicrosoftSqlserverConnectionDetails. The name or address of a host.

Returns:	The host of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	str

key_id¶

Gets the key_id of this UpdateConnectionDetails. 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:	The key_id of this UpdateConnectionDetails.
Return type:	str

nsg_ids¶

Gets the nsg_ids of this UpdateConnectionDetails. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns:	The nsg_ids of this UpdateConnectionDetails.
Return type:	list[str]

password¶

Gets the password of this UpdateMicrosoftSqlserverConnectionDetails. The password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.

Returns:	The password of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	str

password_secret_id¶

Gets the password_secret_id of this UpdateMicrosoftSqlserverConnectionDetails. The OCID of the Secret that stores the password Oracle GoldenGate uses to connect the associated Microsoft SQL Server. Note: When provided, ‘password’ field must not be provided.

Returns:	The password_secret_id of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	str

port¶

Gets the port of this UpdateMicrosoftSqlserverConnectionDetails. The port of an endpoint usually specified for a connection.

Returns:	The port of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	int

private_ip¶

Gets the private_ip of this UpdateMicrosoftSqlserverConnectionDetails. Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

The private IP address of the connection’s endpoint in the customer’s VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Returns:	The private_ip of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	str

routing_method¶

Gets the routing_method of this UpdateConnectionDetails. 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.

Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”

Returns:	The routing_method of this UpdateConnectionDetails.
Return type:	str

security_protocol¶

Gets the security_protocol of this UpdateMicrosoftSqlserverConnectionDetails. Security Type for Microsoft SQL Server.

Returns:	The security_protocol of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	str

should_validate_server_certificate¶

Gets the should_validate_server_certificate of this UpdateMicrosoftSqlserverConnectionDetails. If set to true, the driver validates the certificate that is sent by the database server.

Returns:	The should_validate_server_certificate of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	bool

ssl_ca¶

Gets the ssl_ca of this UpdateMicrosoftSqlserverConnectionDetails. Database Certificate - The base64 encoded content of a .pem or .crt file. containing the server public key (for 1-way SSL).

Returns:	The ssl_ca of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	str

subnet_id¶

Gets the subnet_id of this UpdateConnectionDetails. The OCID of the target subnet of the dedicated connection.

Returns:	The subnet_id of this UpdateConnectionDetails.
Return type:	str

username¶

Gets the username of this UpdateMicrosoftSqlserverConnectionDetails. The username Oracle GoldenGate uses to connect to the Microsoft SQL Server. This username must already exist and be available by the Microsoft SQL Server to be connected to.

Returns:	The username of this UpdateMicrosoftSqlserverConnectionDetails.
Return type:	str

vault_id¶

Gets the vault_id of this UpdateConnectionDetails. 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:	The vault_id of this UpdateConnectionDetails.
Return type:	str