# 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: 20181201

from .format_entry import FormatEntry
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 UDFFormatEntry(FormatEntry):
    """
    The User Defined Function masking format lets you define your own logic to
    mask column data. The return value of the user-defined function is used to
    replace the original values. The user-defined function has a fixed signature
    and is a PL/SQL function that can be invoked in a SELECT statement. To learn
    more, check User Defined Function in the Data Safe documentation.
    """

    def __init__(self, **kwargs):
        """
        Initializes a new UDFFormatEntry object with values from keyword arguments. The default value of the :py:attr:`~oci.data_safe.models.UDFFormatEntry.type` attribute
        of this class is ``USER_DEFINED_FUNCTION`` and it should not be changed.
        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 UDFFormatEntry.
            Allowed values for this property are: "DELETE_ROWS", "DETERMINISTIC_SUBSTITUTION", "DETERMINISTIC_ENCRYPTION", "DETERMINISTIC_ENCRYPTION_DATE", "FIXED_NUMBER", "FIXED_STRING", "LIBRARY_MASKING_FORMAT", "NULL_VALUE", "PATTERN", "POST_PROCESSING_FUNCTION", "PRESERVE_ORIGINAL_DATA", "RANDOM_DATE", "RANDOM_DECIMAL_NUMBER", "RANDOM_DIGITS", "RANDOM_LIST", "RANDOM_NUMBER", "RANDOM_STRING", "RANDOM_SUBSTITUTION", "REGULAR_EXPRESSION", "SHUFFLE", "SQL_EXPRESSION", "SUBSTRING", "TRUNCATE_TABLE", "USER_DEFINED_FUNCTION"
        :type type: str

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

        :param user_defined_function:
            The value to assign to the user_defined_function property of this UDFFormatEntry.
        :type user_defined_function: str

        """
        self.swagger_types = {
            'type': 'str',
            'description': 'str',
            'user_defined_function': 'str'
        }

        self.attribute_map = {
            'type': 'type',
            'description': 'description',
            'user_defined_function': 'userDefinedFunction'
        }

        self._type = None
        self._description = None
        self._user_defined_function = None
        self._type = 'USER_DEFINED_FUNCTION'

    @property
    def user_defined_function(self):
        """
        **[Required]** Gets the user_defined_function of this UDFFormatEntry.
        The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format.
        It can be a standalone or packaged function, so PACKAGE_NAME is optional.


        :return: The user_defined_function of this UDFFormatEntry.
        :rtype: str
        """
        return self._user_defined_function

    @user_defined_function.setter
    def user_defined_function(self, user_defined_function):
        """
        Sets the user_defined_function of this UDFFormatEntry.
        The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format.
        It can be a standalone or packaged function, so PACKAGE_NAME is optional.


        :param user_defined_function: The user_defined_function of this UDFFormatEntry.
        :type: str
        """
        self._user_defined_function = user_defined_function

    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