HEX
Server: Apache
System: Linux scp1.abinfocom.com 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64
User: confeduphaar (1010)
PHP: 8.1.33
Disabled: exec,passthru,shell_exec,system
Upload Files
File: //lib/mysqlsh/lib/python3.8/site-packages/oci/log_analytics/models/purge_storage_data_details.py
# 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: 20200601


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 PurgeStorageDataDetails(object):
    """
    This is the input used to purge data
    """

    #: A constant which can be used with the data_type property of a PurgeStorageDataDetails.
    #: This constant has a value of "LOG"
    DATA_TYPE_LOG = "LOG"

    #: A constant which can be used with the data_type property of a PurgeStorageDataDetails.
    #: This constant has a value of "LOOKUP"
    DATA_TYPE_LOOKUP = "LOOKUP"

    def __init__(self, **kwargs):
        """
        Initializes a new PurgeStorageDataDetails object with values from keyword arguments.
        The following keyword arguments are supported (corresponding to the getters/setters of this class):

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

        :param compartment_id_in_subtree:
            The value to assign to the compartment_id_in_subtree property of this PurgeStorageDataDetails.
        :type compartment_id_in_subtree: bool

        :param time_data_ended:
            The value to assign to the time_data_ended property of this PurgeStorageDataDetails.
        :type time_data_ended: datetime

        :param purge_query_string:
            The value to assign to the purge_query_string property of this PurgeStorageDataDetails.
        :type purge_query_string: str

        :param data_type:
            The value to assign to the data_type property of this PurgeStorageDataDetails.
            Allowed values for this property are: "LOG", "LOOKUP"
        :type data_type: str

        """
        self.swagger_types = {
            'compartment_id': 'str',
            'compartment_id_in_subtree': 'bool',
            'time_data_ended': 'datetime',
            'purge_query_string': 'str',
            'data_type': 'str'
        }
        self.attribute_map = {
            'compartment_id': 'compartmentId',
            'compartment_id_in_subtree': 'compartmentIdInSubtree',
            'time_data_ended': 'timeDataEnded',
            'purge_query_string': 'purgeQueryString',
            'data_type': 'dataType'
        }
        self._compartment_id = None
        self._compartment_id_in_subtree = None
        self._time_data_ended = None
        self._purge_query_string = None
        self._data_type = None

    @property
    def compartment_id(self):
        """
        **[Required]** Gets the compartment_id of this PurgeStorageDataDetails.
        This is the compartment OCID under which the data will be purged and required permission will be checked


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

    @compartment_id.setter
    def compartment_id(self, compartment_id):
        """
        Sets the compartment_id of this PurgeStorageDataDetails.
        This is the compartment OCID under which the data will be purged and required permission will be checked


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

    @property
    def compartment_id_in_subtree(self):
        """
        Gets the compartment_id_in_subtree of this PurgeStorageDataDetails.
        If true, purge child compartments data


        :return: The compartment_id_in_subtree of this PurgeStorageDataDetails.
        :rtype: bool
        """
        return self._compartment_id_in_subtree

    @compartment_id_in_subtree.setter
    def compartment_id_in_subtree(self, compartment_id_in_subtree):
        """
        Sets the compartment_id_in_subtree of this PurgeStorageDataDetails.
        If true, purge child compartments data


        :param compartment_id_in_subtree: The compartment_id_in_subtree of this PurgeStorageDataDetails.
        :type: bool
        """
        self._compartment_id_in_subtree = compartment_id_in_subtree

    @property
    def time_data_ended(self):
        """
        **[Required]** Gets the time_data_ended of this PurgeStorageDataDetails.
        This is the end of the purge time interval


        :return: The time_data_ended of this PurgeStorageDataDetails.
        :rtype: datetime
        """
        return self._time_data_ended

    @time_data_ended.setter
    def time_data_ended(self, time_data_ended):
        """
        Sets the time_data_ended of this PurgeStorageDataDetails.
        This is the end of the purge time interval


        :param time_data_ended: The time_data_ended of this PurgeStorageDataDetails.
        :type: datetime
        """
        self._time_data_ended = time_data_ended

    @property
    def purge_query_string(self):
        """
        Gets the purge_query_string of this PurgeStorageDataDetails.
        This is the solr query used to filter data, '*' means all


        :return: The purge_query_string of this PurgeStorageDataDetails.
        :rtype: str
        """
        return self._purge_query_string

    @purge_query_string.setter
    def purge_query_string(self, purge_query_string):
        """
        Sets the purge_query_string of this PurgeStorageDataDetails.
        This is the solr query used to filter data, '*' means all


        :param purge_query_string: The purge_query_string of this PurgeStorageDataDetails.
        :type: str
        """
        self._purge_query_string = purge_query_string

    @property
    def data_type(self):
        """
        Gets the data_type of this PurgeStorageDataDetails.
        This is the type of the log data to be purged

        Allowed values for this property are: "LOG", "LOOKUP"


        :return: The data_type of this PurgeStorageDataDetails.
        :rtype: str
        """
        return self._data_type

    @data_type.setter
    def data_type(self, data_type):
        """
        Sets the data_type of this PurgeStorageDataDetails.
        This is the type of the log data to be purged


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

    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