# coding: utf-8
# Copyright (c) 2016, 2026, 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: 20201005


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 CreateDatabaseToolsSqlReportDetails(object):
    """
    Details for the new Database Tools SQL report.
    """

    #: A constant which can be used with the type property of a CreateDatabaseToolsSqlReportDetails.
    #: This constant has a value of "ORACLE_DATABASE"
    TYPE_ORACLE_DATABASE = "ORACLE_DATABASE"

    def __init__(self, **kwargs):
        """
        Initializes a new CreateDatabaseToolsSqlReportDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
        to a service operations then you should favor using a subclass over the base class:

        * :class:`~oci.database_tools.models.CreateDatabaseToolsSqlReportOracleDatabaseDetails`

        The following keyword arguments are supported (corresponding to the getters/setters of this class):

        :param type:
            The value to assign to the type property of this CreateDatabaseToolsSqlReportDetails.
            Allowed values for this property are: "ORACLE_DATABASE"
        :type type: str

        :param compartment_id:
            The value to assign to the compartment_id property of this CreateDatabaseToolsSqlReportDetails.
        :type compartment_id: str

        :param display_name:
            The value to assign to the display_name property of this CreateDatabaseToolsSqlReportDetails.
        :type display_name: str

        :param source:
            The value to assign to the source property of this CreateDatabaseToolsSqlReportDetails.
        :type source: str

        :param description:
            The value to assign to the description property of this CreateDatabaseToolsSqlReportDetails.
        :type description: str

        :param purpose:
            The value to assign to the purpose property of this CreateDatabaseToolsSqlReportDetails.
        :type purpose: str

        :param instructions:
            The value to assign to the instructions property of this CreateDatabaseToolsSqlReportDetails.
        :type instructions: str

        :param variables:
            The value to assign to the variables property of this CreateDatabaseToolsSqlReportDetails.
        :type variables: list[oci.database_tools.models.DatabaseToolsSqlReportVariable]

        :param columns:
            The value to assign to the columns property of this CreateDatabaseToolsSqlReportDetails.
        :type columns: list[oci.database_tools.models.DatabaseToolsSqlReportColumn]

        :param defined_tags:
            The value to assign to the defined_tags property of this CreateDatabaseToolsSqlReportDetails.
        :type defined_tags: dict(str, dict(str, object))

        :param freeform_tags:
            The value to assign to the freeform_tags property of this CreateDatabaseToolsSqlReportDetails.
        :type freeform_tags: dict(str, str)

        :param locks:
            The value to assign to the locks property of this CreateDatabaseToolsSqlReportDetails.
        :type locks: list[oci.database_tools.models.ResourceLock]

        """
        self.swagger_types = {
            'type': 'str',
            'compartment_id': 'str',
            'display_name': 'str',
            'source': 'str',
            'description': 'str',
            'purpose': 'str',
            'instructions': 'str',
            'variables': 'list[DatabaseToolsSqlReportVariable]',
            'columns': 'list[DatabaseToolsSqlReportColumn]',
            'defined_tags': 'dict(str, dict(str, object))',
            'freeform_tags': 'dict(str, str)',
            'locks': 'list[ResourceLock]'
        }
        self.attribute_map = {
            'type': 'type',
            'compartment_id': 'compartmentId',
            'display_name': 'displayName',
            'source': 'source',
            'description': 'description',
            'purpose': 'purpose',
            'instructions': 'instructions',
            'variables': 'variables',
            'columns': 'columns',
            'defined_tags': 'definedTags',
            'freeform_tags': 'freeformTags',
            'locks': 'locks'
        }
        self._type = None
        self._compartment_id = None
        self._display_name = None
        self._source = None
        self._description = None
        self._purpose = None
        self._instructions = None
        self._variables = None
        self._columns = None
        self._defined_tags = None
        self._freeform_tags = None
        self._locks = None

    @staticmethod
    def 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.
        """
        type = object_dictionary['type']

        if type == 'ORACLE_DATABASE':
            return 'CreateDatabaseToolsSqlReportOracleDatabaseDetails'
        else:
            return 'CreateDatabaseToolsSqlReportDetails'

    @property
    def type(self):
        """
        **[Required]** Gets the type of this CreateDatabaseToolsSqlReportDetails.
        The Database Tools SQL report type.

        Allowed values for this property are: "ORACLE_DATABASE"


        :return: The type of this CreateDatabaseToolsSqlReportDetails.
        :rtype: str
        """
        return self._type

    @type.setter
    def type(self, type):
        """
        Sets the type of this CreateDatabaseToolsSqlReportDetails.
        The Database Tools SQL report type.


        :param type: The type of this CreateDatabaseToolsSqlReportDetails.
        :type: str
        """
        allowed_values = ["ORACLE_DATABASE"]
        if not value_allowed_none_or_none_sentinel(type, allowed_values):
            raise ValueError(
                f"Invalid value for `type`, must be None or one of {allowed_values}"
            )
        self._type = type

    @property
    def compartment_id(self):
        """
        **[Required]** Gets the compartment_id of this CreateDatabaseToolsSqlReportDetails.
        The `OCID`__ of the compartment containing the Database Tools SQL report.

        __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm


        :return: The compartment_id of this CreateDatabaseToolsSqlReportDetails.
        :rtype: str
        """
        return self._compartment_id

    @compartment_id.setter
    def compartment_id(self, compartment_id):
        """
        Sets the compartment_id of this CreateDatabaseToolsSqlReportDetails.
        The `OCID`__ of the compartment containing the Database Tools SQL report.

        __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm


        :param compartment_id: The compartment_id of this CreateDatabaseToolsSqlReportDetails.
        :type: str
        """
        self._compartment_id = compartment_id

    @property
    def display_name(self):
        """
        **[Required]** Gets the display_name of this CreateDatabaseToolsSqlReportDetails.
        A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.


        :return: The display_name of this CreateDatabaseToolsSqlReportDetails.
        :rtype: str
        """
        return self._display_name

    @display_name.setter
    def display_name(self, display_name):
        """
        Sets the display_name of this CreateDatabaseToolsSqlReportDetails.
        A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.


        :param display_name: The display_name of this CreateDatabaseToolsSqlReportDetails.
        :type: str
        """
        self._display_name = display_name

    @property
    def source(self):
        """
        **[Required]** Gets the source of this CreateDatabaseToolsSqlReportDetails.
        SQL query executed to generate the report.


        :return: The source of this CreateDatabaseToolsSqlReportDetails.
        :rtype: str
        """
        return self._source

    @source.setter
    def source(self, source):
        """
        Sets the source of this CreateDatabaseToolsSqlReportDetails.
        SQL query executed to generate the report.


        :param source: The source of this CreateDatabaseToolsSqlReportDetails.
        :type: str
        """
        self._source = source

    @property
    def description(self):
        """
        Gets the description of this CreateDatabaseToolsSqlReportDetails.
        A description of the SQL report.


        :return: The description of this CreateDatabaseToolsSqlReportDetails.
        :rtype: str
        """
        return self._description

    @description.setter
    def description(self, description):
        """
        Sets the description of this CreateDatabaseToolsSqlReportDetails.
        A description of the SQL report.


        :param description: The description of this CreateDatabaseToolsSqlReportDetails.
        :type: str
        """
        self._description = description

    @property
    def purpose(self):
        """
        Gets the purpose of this CreateDatabaseToolsSqlReportDetails.
        Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.


        :return: The purpose of this CreateDatabaseToolsSqlReportDetails.
        :rtype: str
        """
        return self._purpose

    @purpose.setter
    def purpose(self, purpose):
        """
        Sets the purpose of this CreateDatabaseToolsSqlReportDetails.
        Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.


        :param purpose: The purpose of this CreateDatabaseToolsSqlReportDetails.
        :type: str
        """
        self._purpose = purpose

    @property
    def instructions(self):
        """
        Gets the instructions of this CreateDatabaseToolsSqlReportDetails.
        Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.


        :return: The instructions of this CreateDatabaseToolsSqlReportDetails.
        :rtype: str
        """
        return self._instructions

    @instructions.setter
    def instructions(self, instructions):
        """
        Sets the instructions of this CreateDatabaseToolsSqlReportDetails.
        Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.


        :param instructions: The instructions of this CreateDatabaseToolsSqlReportDetails.
        :type: str
        """
        self._instructions = instructions

    @property
    def variables(self):
        """
        Gets the variables of this CreateDatabaseToolsSqlReportDetails.
        Variables referenced in the Database Tools SQL Report source.


        :return: The variables of this CreateDatabaseToolsSqlReportDetails.
        :rtype: list[oci.database_tools.models.DatabaseToolsSqlReportVariable]
        """
        return self._variables

    @variables.setter
    def variables(self, variables):
        """
        Sets the variables of this CreateDatabaseToolsSqlReportDetails.
        Variables referenced in the Database Tools SQL Report source.


        :param variables: The variables of this CreateDatabaseToolsSqlReportDetails.
        :type: list[oci.database_tools.models.DatabaseToolsSqlReportVariable]
        """
        self._variables = variables

    @property
    def columns(self):
        """
        Gets the columns of this CreateDatabaseToolsSqlReportDetails.
        Descriptive information on columns referenced in the Database Tools SQL Report source.


        :return: The columns of this CreateDatabaseToolsSqlReportDetails.
        :rtype: list[oci.database_tools.models.DatabaseToolsSqlReportColumn]
        """
        return self._columns

    @columns.setter
    def columns(self, columns):
        """
        Sets the columns of this CreateDatabaseToolsSqlReportDetails.
        Descriptive information on columns referenced in the Database Tools SQL Report source.


        :param columns: The columns of this CreateDatabaseToolsSqlReportDetails.
        :type: list[oci.database_tools.models.DatabaseToolsSqlReportColumn]
        """
        self._columns = columns

    @property
    def defined_tags(self):
        """
        Gets the defined_tags of this CreateDatabaseToolsSqlReportDetails.
        Defined tags for this resource. Each key is predefined and scoped to a namespace.
        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`


        :return: The defined_tags of this CreateDatabaseToolsSqlReportDetails.
        :rtype: dict(str, dict(str, object))
        """
        return self._defined_tags

    @defined_tags.setter
    def defined_tags(self, defined_tags):
        """
        Sets the defined_tags of this CreateDatabaseToolsSqlReportDetails.
        Defined tags for this resource. Each key is predefined and scoped to a namespace.
        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`


        :param defined_tags: The defined_tags of this CreateDatabaseToolsSqlReportDetails.
        :type: dict(str, dict(str, object))
        """
        self._defined_tags = defined_tags

    @property
    def freeform_tags(self):
        """
        Gets the freeform_tags of this CreateDatabaseToolsSqlReportDetails.
        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
        Example: `{\"bar-key\": \"value\"}`


        :return: The freeform_tags of this CreateDatabaseToolsSqlReportDetails.
        :rtype: dict(str, str)
        """
        return self._freeform_tags

    @freeform_tags.setter
    def freeform_tags(self, freeform_tags):
        """
        Sets the freeform_tags of this CreateDatabaseToolsSqlReportDetails.
        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
        Example: `{\"bar-key\": \"value\"}`


        :param freeform_tags: The freeform_tags of this CreateDatabaseToolsSqlReportDetails.
        :type: dict(str, str)
        """
        self._freeform_tags = freeform_tags

    @property
    def locks(self):
        """
        Gets the locks of this CreateDatabaseToolsSqlReportDetails.
        Locks associated with this resource.


        :return: The locks of this CreateDatabaseToolsSqlReportDetails.
        :rtype: list[oci.database_tools.models.ResourceLock]
        """
        return self._locks

    @locks.setter
    def locks(self, locks):
        """
        Sets the locks of this CreateDatabaseToolsSqlReportDetails.
        Locks associated with this resource.


        :param locks: The locks of this CreateDatabaseToolsSqlReportDetails.
        :type: list[oci.database_tools.models.ResourceLock]
        """
        self._locks = locks

    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
