oci 2.126.4__py3-none-any.whl → 2.128.0__py3-none-any.whl

oci/golden_gate/models/db2_connection.py

@@ -0,0 +1,431 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407
+
+from .connection import Connection
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class Db2Connection(Connection):
+    """
+    Represents the metadata of a DB2 Connection.
+    """
+
+    #: A constant which can be used with the technology_type property of a Db2Connection.
+    #: This constant has a value of "DB2_ZOS"
+    TECHNOLOGY_TYPE_DB2_ZOS = "DB2_ZOS"
+
+    #: A constant which can be used with the security_protocol property of a Db2Connection.
+    #: This constant has a value of "PLAIN"
+    SECURITY_PROTOCOL_PLAIN = "PLAIN"
+
+    #: A constant which can be used with the security_protocol property of a Db2Connection.
+    #: This constant has a value of "TLS"
+    SECURITY_PROTOCOL_TLS = "TLS"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Db2Connection object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.Db2Connection.connection_type` attribute
+        of this class is ``DB2`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param connection_type:
+            The value to assign to the connection_type property of this Db2Connection.
+            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", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type connection_type: str
+
+        :param id:
+            The value to assign to the id property of this Db2Connection.
+        :type id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this Db2Connection.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this Db2Connection.
+        :type description: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this Db2Connection.
+        :type compartment_id: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this Db2Connection.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this Db2Connection.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this Db2Connection.
+        :type system_tags: dict(str, dict(str, object))
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this Db2Connection.
+            Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type lifecycle_state: str
+
+        :param lifecycle_details:
+            The value to assign to the lifecycle_details property of this Db2Connection.
+        :type lifecycle_details: str
+
+        :param time_created:
+            The value to assign to the time_created property of this Db2Connection.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this Db2Connection.
+        :type time_updated: datetime
+
+        :param locks:
+            The value to assign to the locks property of this Db2Connection.
+        :type locks: list[oci.golden_gate.models.ResourceLock]
+
+        :param vault_id:
+            The value to assign to the vault_id property of this Db2Connection.
+        :type vault_id: str
+
+        :param key_id:
+            The value to assign to the key_id property of this Db2Connection.
+        :type key_id: str
+
+        :param ingress_ips:
+            The value to assign to the ingress_ips property of this Db2Connection.
+        :type ingress_ips: list[oci.golden_gate.models.IngressIpDetails]
+
+        :param nsg_ids:
+            The value to assign to the nsg_ids property of this Db2Connection.
+        :type nsg_ids: list[str]
+
+        :param subnet_id:
+            The value to assign to the subnet_id property of this Db2Connection.
+        :type subnet_id: str
+
+        :param routing_method:
+            The value to assign to the routing_method property of this Db2Connection.
+            Allowed values for this property are: "SHARED_SERVICE_ENDPOINT", "SHARED_DEPLOYMENT_ENDPOINT", "DEDICATED_ENDPOINT", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type routing_method: str
+
+        :param technology_type:
+            The value to assign to the technology_type property of this Db2Connection.
+            Allowed values for this property are: "DB2_ZOS", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type technology_type: str
+
+        :param username:
+            The value to assign to the username property of this Db2Connection.
+        :type username: str
+
+        :param host:
+            The value to assign to the host property of this Db2Connection.
+        :type host: str
+
+        :param port:
+            The value to assign to the port property of this Db2Connection.
+        :type port: int
+
+        :param database_name:
+            The value to assign to the database_name property of this Db2Connection.
+        :type database_name: str
+
+        :param additional_attributes:
+            The value to assign to the additional_attributes property of this Db2Connection.
+        :type additional_attributes: list[oci.golden_gate.models.NameValuePair]
+
+        :param security_protocol:
+            The value to assign to the security_protocol property of this Db2Connection.
+            Allowed values for this property are: "PLAIN", "TLS", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type security_protocol: str
+
+        """
+        self.swagger_types = {
+            'connection_type': 'str',
+            'id': 'str',
+            'display_name': 'str',
+            'description': 'str',
+            'compartment_id': 'str',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))',
+            'system_tags': 'dict(str, dict(str, object))',
+            'lifecycle_state': 'str',
+            'lifecycle_details': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'locks': 'list[ResourceLock]',
+            'vault_id': 'str',
+            'key_id': 'str',
+            'ingress_ips': 'list[IngressIpDetails]',
+            'nsg_ids': 'list[str]',
+            'subnet_id': 'str',
+            'routing_method': 'str',
+            'technology_type': 'str',
+            'username': 'str',
+            'host': 'str',
+            'port': 'int',
+            'database_name': 'str',
+            'additional_attributes': 'list[NameValuePair]',
+            'security_protocol': 'str'
+        }
+
+        self.attribute_map = {
+            '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',
+            'locks': 'locks',
+            'vault_id': 'vaultId',
+            'key_id': 'keyId',
+            'ingress_ips': 'ingressIps',
+            'nsg_ids': 'nsgIds',
+            'subnet_id': 'subnetId',
+            'routing_method': 'routingMethod',
+            'technology_type': 'technologyType',
+            'username': 'username',
+            'host': 'host',
+            'port': 'port',
+            'database_name': 'databaseName',
+            'additional_attributes': 'additionalAttributes',
+            'security_protocol': 'securityProtocol'
+        }
+
+        self._connection_type = None
+        self._id = None
+        self._display_name = None
+        self._description = None
+        self._compartment_id = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._system_tags = None
+        self._lifecycle_state = None
+        self._lifecycle_details = None
+        self._time_created = None
+        self._time_updated = None
+        self._locks = None
+        self._vault_id = None
+        self._key_id = None
+        self._ingress_ips = None
+        self._nsg_ids = None
+        self._subnet_id = None
+        self._routing_method = None
+        self._technology_type = None
+        self._username = None
+        self._host = None
+        self._port = None
+        self._database_name = None
+        self._additional_attributes = None
+        self._security_protocol = None
+        self._connection_type = 'DB2'
+
+    @property
+    def technology_type(self):
+        """
+        **[Required]** Gets the technology_type of this Db2Connection.
+        The DB2 technology type.
+
+        Allowed values for this property are: "DB2_ZOS", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The technology_type of this Db2Connection.
+        :rtype: str
+        """
+        return self._technology_type
+
+    @technology_type.setter
+    def technology_type(self, technology_type):
+        """
+        Sets the technology_type of this Db2Connection.
+        The DB2 technology type.
+
+
+        :param technology_type: The technology_type of this Db2Connection.
+        :type: str
+        """
+        allowed_values = ["DB2_ZOS"]
+        if not value_allowed_none_or_none_sentinel(technology_type, allowed_values):
+            technology_type = 'UNKNOWN_ENUM_VALUE'
+        self._technology_type = technology_type
+
+    @property
+    def username(self):
+        """
+        **[Required]** Gets the username of this Db2Connection.
+        The username Oracle GoldenGate uses to connect to the DB2 database.
+        This username must already exist and be available by the DB2 to be connected to.
+
+
+        :return: The username of this Db2Connection.
+        :rtype: str
+        """
+        return self._username
+
+    @username.setter
+    def username(self, username):
+        """
+        Sets the username of this Db2Connection.
+        The username Oracle GoldenGate uses to connect to the DB2 database.
+        This username must already exist and be available by the DB2 to be connected to.
+
+
+        :param username: The username of this Db2Connection.
+        :type: str
+        """
+        self._username = username
+
+    @property
+    def host(self):
+        """
+        **[Required]** Gets the host of this Db2Connection.
+        The name or address of a host.
+
+
+        :return: The host of this Db2Connection.
+        :rtype: str
+        """
+        return self._host
+
+    @host.setter
+    def host(self, host):
+        """
+        Sets the host of this Db2Connection.
+        The name or address of a host.
+
+
+        :param host: The host of this Db2Connection.
+        :type: str
+        """
+        self._host = host
+
+    @property
+    def port(self):
+        """
+        **[Required]** Gets the port of this Db2Connection.
+        The port of an endpoint usually specified for a connection.
+
+
+        :return: The port of this Db2Connection.
+        :rtype: int
+        """
+        return self._port
+
+    @port.setter
+    def port(self, port):
+        """
+        Sets the port of this Db2Connection.
+        The port of an endpoint usually specified for a connection.
+
+
+        :param port: The port of this Db2Connection.
+        :type: int
+        """
+        self._port = port
+
+    @property
+    def database_name(self):
+        """
+        **[Required]** Gets the database_name of this Db2Connection.
+        The name of the database.
+
+
+        :return: The database_name of this Db2Connection.
+        :rtype: str
+        """
+        return self._database_name
+
+    @database_name.setter
+    def database_name(self, database_name):
+        """
+        Sets the database_name of this Db2Connection.
+        The name of the database.
+
+
+        :param database_name: The database_name of this Db2Connection.
+        :type: str
+        """
+        self._database_name = database_name
+
+    @property
+    def additional_attributes(self):
+        """
+        Gets the additional_attributes of this Db2Connection.
+        An array of name-value pair attribute entries.
+        Used as additional parameters in connection string.
+
+
+        :return: The additional_attributes of this Db2Connection.
+        :rtype: list[oci.golden_gate.models.NameValuePair]
+        """
+        return self._additional_attributes
+
+    @additional_attributes.setter
+    def additional_attributes(self, additional_attributes):
+        """
+        Sets the additional_attributes of this Db2Connection.
+        An array of name-value pair attribute entries.
+        Used as additional parameters in connection string.
+
+
+        :param additional_attributes: The additional_attributes of this Db2Connection.
+        :type: list[oci.golden_gate.models.NameValuePair]
+        """
+        self._additional_attributes = additional_attributes
+
+    @property
+    def security_protocol(self):
+        """
+        **[Required]** Gets the security_protocol of this Db2Connection.
+        Security Protocol for the DB2 database.
+
+        Allowed values for this property are: "PLAIN", "TLS", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The security_protocol of this Db2Connection.
+        :rtype: str
+        """
+        return self._security_protocol
+
+    @security_protocol.setter
+    def security_protocol(self, security_protocol):
+        """
+        Sets the security_protocol of this Db2Connection.
+        Security Protocol for the DB2 database.
+
+
+        :param security_protocol: The security_protocol of this Db2Connection.
+        :type: str
+        """
+        allowed_values = ["PLAIN", "TLS"]
+        if not value_allowed_none_or_none_sentinel(security_protocol, allowed_values):
+            security_protocol = 'UNKNOWN_ENUM_VALUE'
+        self._security_protocol = security_protocol
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other