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


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 CreateSecurityAssessmentDetails(object):
    """
    The details used to save a security assessment.
    """

    #: A constant which can be used with the target_type property of a CreateSecurityAssessmentDetails.
    #: This constant has a value of "TARGET_DATABASE"
    TARGET_TYPE_TARGET_DATABASE = "TARGET_DATABASE"

    #: A constant which can be used with the target_type property of a CreateSecurityAssessmentDetails.
    #: This constant has a value of "TARGET_DATABASE_GROUP"
    TARGET_TYPE_TARGET_DATABASE_GROUP = "TARGET_DATABASE_GROUP"

    #: A constant which can be used with the type property of a CreateSecurityAssessmentDetails.
    #: This constant has a value of "LATEST"
    TYPE_LATEST = "LATEST"

    #: A constant which can be used with the type property of a CreateSecurityAssessmentDetails.
    #: This constant has a value of "SAVED"
    TYPE_SAVED = "SAVED"

    #: A constant which can be used with the type property of a CreateSecurityAssessmentDetails.
    #: This constant has a value of "SAVE_SCHEDULE"
    TYPE_SAVE_SCHEDULE = "SAVE_SCHEDULE"

    #: A constant which can be used with the type property of a CreateSecurityAssessmentDetails.
    #: This constant has a value of "COMPARTMENT"
    TYPE_COMPARTMENT = "COMPARTMENT"

    #: A constant which can be used with the type property of a CreateSecurityAssessmentDetails.
    #: This constant has a value of "TEMPLATE"
    TYPE_TEMPLATE = "TEMPLATE"

    #: A constant which can be used with the type property of a CreateSecurityAssessmentDetails.
    #: This constant has a value of "TEMPLATE_BASELINE"
    TYPE_TEMPLATE_BASELINE = "TEMPLATE_BASELINE"

    def __init__(self, **kwargs):
        """
        Initializes a new CreateSecurityAssessmentDetails 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 CreateSecurityAssessmentDetails.
        :type compartment_id: str

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

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

        :param target_id:
            The value to assign to the target_id property of this CreateSecurityAssessmentDetails.
        :type target_id: str

        :param target_type:
            The value to assign to the target_type property of this CreateSecurityAssessmentDetails.
            Allowed values for this property are: "TARGET_DATABASE", "TARGET_DATABASE_GROUP"
        :type target_type: str

        :param type:
            The value to assign to the type property of this CreateSecurityAssessmentDetails.
            Allowed values for this property are: "LATEST", "SAVED", "SAVE_SCHEDULE", "COMPARTMENT", "TEMPLATE", "TEMPLATE_BASELINE"
        :type type: str

        :param template_assessment_id:
            The value to assign to the template_assessment_id property of this CreateSecurityAssessmentDetails.
        :type template_assessment_id: str

        :param base_security_assessment_id:
            The value to assign to the base_security_assessment_id property of this CreateSecurityAssessmentDetails.
        :type base_security_assessment_id: str

        :param is_assessment_scheduled:
            The value to assign to the is_assessment_scheduled property of this CreateSecurityAssessmentDetails.
        :type is_assessment_scheduled: bool

        :param schedule:
            The value to assign to the schedule property of this CreateSecurityAssessmentDetails.
        :type schedule: str

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

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

        """
        self.swagger_types = {
            'compartment_id': 'str',
            'display_name': 'str',
            'description': 'str',
            'target_id': 'str',
            'target_type': 'str',
            'type': 'str',
            'template_assessment_id': 'str',
            'base_security_assessment_id': 'str',
            'is_assessment_scheduled': 'bool',
            'schedule': 'str',
            'freeform_tags': 'dict(str, str)',
            'defined_tags': 'dict(str, dict(str, object))'
        }
        self.attribute_map = {
            'compartment_id': 'compartmentId',
            'display_name': 'displayName',
            'description': 'description',
            'target_id': 'targetId',
            'target_type': 'targetType',
            'type': 'type',
            'template_assessment_id': 'templateAssessmentId',
            'base_security_assessment_id': 'baseSecurityAssessmentId',
            'is_assessment_scheduled': 'isAssessmentScheduled',
            'schedule': 'schedule',
            'freeform_tags': 'freeformTags',
            'defined_tags': 'definedTags'
        }
        self._compartment_id = None
        self._display_name = None
        self._description = None
        self._target_id = None
        self._target_type = None
        self._type = None
        self._template_assessment_id = None
        self._base_security_assessment_id = None
        self._is_assessment_scheduled = None
        self._schedule = None
        self._freeform_tags = None
        self._defined_tags = None

    @property
    def compartment_id(self):
        """
        **[Required]** Gets the compartment_id of this CreateSecurityAssessmentDetails.
        The OCID of the compartment that contains the security assessment.


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

    @compartment_id.setter
    def compartment_id(self, compartment_id):
        """
        Sets the compartment_id of this CreateSecurityAssessmentDetails.
        The OCID of the compartment that contains the security assessment.


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

    @property
    def display_name(self):
        """
        Gets the display_name of this CreateSecurityAssessmentDetails.
        The display name of the security assessment.


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

    @display_name.setter
    def display_name(self, display_name):
        """
        Sets the display_name of this CreateSecurityAssessmentDetails.
        The display name of the security assessment.


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

    @property
    def description(self):
        """
        Gets the description of this CreateSecurityAssessmentDetails.
        Description of the security assessment.


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

    @description.setter
    def description(self, description):
        """
        Sets the description of this CreateSecurityAssessmentDetails.
        Description of the security assessment.


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

    @property
    def target_id(self):
        """
        Gets the target_id of this CreateSecurityAssessmentDetails.
        The OCID of the target database or target database group on which security assessment is to be run.


        :return: The target_id of this CreateSecurityAssessmentDetails.
        :rtype: str
        """
        return self._target_id

    @target_id.setter
    def target_id(self, target_id):
        """
        Sets the target_id of this CreateSecurityAssessmentDetails.
        The OCID of the target database or target database group on which security assessment is to be run.


        :param target_id: The target_id of this CreateSecurityAssessmentDetails.
        :type: str
        """
        self._target_id = target_id

    @property
    def target_type(self):
        """
        Gets the target_type of this CreateSecurityAssessmentDetails.
        The type of security assessment resource whether it is individual or group resource. For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value.

        Allowed values for this property are: "TARGET_DATABASE", "TARGET_DATABASE_GROUP"


        :return: The target_type of this CreateSecurityAssessmentDetails.
        :rtype: str
        """
        return self._target_type

    @target_type.setter
    def target_type(self, target_type):
        """
        Sets the target_type of this CreateSecurityAssessmentDetails.
        The type of security assessment resource whether it is individual or group resource. For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value.


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

    @property
    def type(self):
        """
        Gets the type of this CreateSecurityAssessmentDetails.
        The type of the security assessment

        Allowed values for this property are: "LATEST", "SAVED", "SAVE_SCHEDULE", "COMPARTMENT", "TEMPLATE", "TEMPLATE_BASELINE"


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

    @type.setter
    def type(self, type):
        """
        Sets the type of this CreateSecurityAssessmentDetails.
        The type of the security assessment


        :param type: The type of this CreateSecurityAssessmentDetails.
        :type: str
        """
        allowed_values = ["LATEST", "SAVED", "SAVE_SCHEDULE", "COMPARTMENT", "TEMPLATE", "TEMPLATE_BASELINE"]
        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 template_assessment_id(self):
        """
        Gets the template_assessment_id of this CreateSecurityAssessmentDetails.
        The OCID of the template assessment. It will be required while creating the template baseline assessment.


        :return: The template_assessment_id of this CreateSecurityAssessmentDetails.
        :rtype: str
        """
        return self._template_assessment_id

    @template_assessment_id.setter
    def template_assessment_id(self, template_assessment_id):
        """
        Sets the template_assessment_id of this CreateSecurityAssessmentDetails.
        The OCID of the template assessment. It will be required while creating the template baseline assessment.


        :param template_assessment_id: The template_assessment_id of this CreateSecurityAssessmentDetails.
        :type: str
        """
        self._template_assessment_id = template_assessment_id

    @property
    def base_security_assessment_id(self):
        """
        Gets the base_security_assessment_id of this CreateSecurityAssessmentDetails.
        The OCID of the security assessment. The assessment should be of type SAVED.
        It will be required while creating the template baseline assessment for individual targets to fetch the detailed information from an existing security assessment.


        :return: The base_security_assessment_id of this CreateSecurityAssessmentDetails.
        :rtype: str
        """
        return self._base_security_assessment_id

    @base_security_assessment_id.setter
    def base_security_assessment_id(self, base_security_assessment_id):
        """
        Sets the base_security_assessment_id of this CreateSecurityAssessmentDetails.
        The OCID of the security assessment. The assessment should be of type SAVED.
        It will be required while creating the template baseline assessment for individual targets to fetch the detailed information from an existing security assessment.


        :param base_security_assessment_id: The base_security_assessment_id of this CreateSecurityAssessmentDetails.
        :type: str
        """
        self._base_security_assessment_id = base_security_assessment_id

    @property
    def is_assessment_scheduled(self):
        """
        Gets the is_assessment_scheduled of this CreateSecurityAssessmentDetails.
        Indicates whether the assessment is scheduled to run.


        :return: The is_assessment_scheduled of this CreateSecurityAssessmentDetails.
        :rtype: bool
        """
        return self._is_assessment_scheduled

    @is_assessment_scheduled.setter
    def is_assessment_scheduled(self, is_assessment_scheduled):
        """
        Sets the is_assessment_scheduled of this CreateSecurityAssessmentDetails.
        Indicates whether the assessment is scheduled to run.


        :param is_assessment_scheduled: The is_assessment_scheduled of this CreateSecurityAssessmentDetails.
        :type: bool
        """
        self._is_assessment_scheduled = is_assessment_scheduled

    @property
    def schedule(self):
        """
        Gets the schedule of this CreateSecurityAssessmentDetails.
        To schedule the assessment for running periodically, specify the schedule in this attribute.
        Create or schedule one assessment per compartment. If not defined, the assessment runs immediately.
        Format -
        <version-string>;<version-specific-schedule>

        Allowed version strings - \"v1\"
        v1's version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month>
        Each of the above fields potentially introduce constraints. A workrequest is created only
        when clock time satisfies all the constraints. Constraints introduced:
        1. seconds = <ss> (So, the allowed range for <ss> is [0, 59])
        2. minutes = <mm> (So, the allowed range for <mm> is [0, 59])
        3. hours = <hh> (So, the allowed range for <hh> is [0, 23])
        <day-of-week> can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday))
        4. No constraint introduced when it is '*'. When not, day of week must equal the given value
        <day-of-month> can be either '*' (without quotes or a number between 1 and 28)
        5. No constraint introduced when it is '*'. When not, day of month must equal the given value


        :return: The schedule of this CreateSecurityAssessmentDetails.
        :rtype: str
        """
        return self._schedule

    @schedule.setter
    def schedule(self, schedule):
        """
        Sets the schedule of this CreateSecurityAssessmentDetails.
        To schedule the assessment for running periodically, specify the schedule in this attribute.
        Create or schedule one assessment per compartment. If not defined, the assessment runs immediately.
        Format -
        <version-string>;<version-specific-schedule>

        Allowed version strings - \"v1\"
        v1's version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month>
        Each of the above fields potentially introduce constraints. A workrequest is created only
        when clock time satisfies all the constraints. Constraints introduced:
        1. seconds = <ss> (So, the allowed range for <ss> is [0, 59])
        2. minutes = <mm> (So, the allowed range for <mm> is [0, 59])
        3. hours = <hh> (So, the allowed range for <hh> is [0, 23])
        <day-of-week> can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday))
        4. No constraint introduced when it is '*'. When not, day of week must equal the given value
        <day-of-month> can be either '*' (without quotes or a number between 1 and 28)
        5. No constraint introduced when it is '*'. When not, day of month must equal the given value


        :param schedule: The schedule of this CreateSecurityAssessmentDetails.
        :type: str
        """
        self._schedule = schedule

    @property
    def freeform_tags(self):
        """
        Gets the freeform_tags of this CreateSecurityAssessmentDetails.
        Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__

        Example: `{\"Department\": \"Finance\"}`

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


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

    @freeform_tags.setter
    def freeform_tags(self, freeform_tags):
        """
        Sets the freeform_tags of this CreateSecurityAssessmentDetails.
        Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__

        Example: `{\"Department\": \"Finance\"}`

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


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

    @property
    def defined_tags(self):
        """
        Gets the defined_tags of this CreateSecurityAssessmentDetails.
        Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__
        Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

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


        :return: The defined_tags of this CreateSecurityAssessmentDetails.
        :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 CreateSecurityAssessmentDetails.
        Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__
        Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

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


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

    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
