# coding: utf-8
# Copyright (c) 2016, 2025, 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 ShuffleFormatEntry(FormatEntry):
    """
    The Shuffle masking format randomly shuffles values within a column. It
    can also be used to shuffle column data within discrete units, or groups,
    where there is a relationship among the members of each group. To learn more,
    check Shuffle in the Data Safe documentation. The Shuffle masking format
    randomly shuffles values within a column. It can also be used to shuffle
    column data within discrete units, or groups, where there is a relationship
    among the members of each group. To learn more, check Shuffle in the
    Data Safe documentation.
    """

    def __init__(self, **kwargs):
        """
        Initializes a new ShuffleFormatEntry object with values from keyword arguments. The default value of the :py:attr:`~oci.data_safe.models.ShuffleFormatEntry.type` attribute
        of this class is ``SHUFFLE`` 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 ShuffleFormatEntry.
            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 ShuffleFormatEntry.
        :type description: str

        :param grouping_columns:
            The value to assign to the grouping_columns property of this ShuffleFormatEntry.
        :type grouping_columns: list[str]

        """
        self.swagger_types = {
            'type': 'str',
            'description': 'str',
            'grouping_columns': 'list[str]'
        }
        self.attribute_map = {
            'type': 'type',
            'description': 'description',
            'grouping_columns': 'groupingColumns'
        }
        self._type = None
        self._description = None
        self._grouping_columns = None
        self._type = 'SHUFFLE'

    @property
    def grouping_columns(self):
        """
        Gets the grouping_columns of this ShuffleFormatEntry.
        One or more reference columns to be used to group column values so that
        they can be shuffled within their own group. The grouping columns and
        the column to be masked must belong to the same table.


        :return: The grouping_columns of this ShuffleFormatEntry.
        :rtype: list[str]
        """
        return self._grouping_columns

    @grouping_columns.setter
    def grouping_columns(self, grouping_columns):
        """
        Sets the grouping_columns of this ShuffleFormatEntry.
        One or more reference columns to be used to group column values so that
        they can be shuffled within their own group. The grouping columns and
        the column to be masked must belong to the same table.


        :param grouping_columns: The grouping_columns of this ShuffleFormatEntry.
        :type: list[str]
        """
        self._grouping_columns = grouping_columns

    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