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


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 CreateBootVolumeBackupDetails(object):
    """
    CreateBootVolumeBackupDetails model.
    """

    #: A constant which can be used with the type property of a CreateBootVolumeBackupDetails.
    #: This constant has a value of "FULL"
    TYPE_FULL = "FULL"

    #: A constant which can be used with the type property of a CreateBootVolumeBackupDetails.
    #: This constant has a value of "INCREMENTAL"
    TYPE_INCREMENTAL = "INCREMENTAL"

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

        :param boot_volume_id:
            The value to assign to the boot_volume_id property of this CreateBootVolumeBackupDetails.
        :type boot_volume_id: str

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

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

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

        :param type:
            The value to assign to the type property of this CreateBootVolumeBackupDetails.
            Allowed values for this property are: "FULL", "INCREMENTAL"
        :type type: str

        :param kms_key_id:
            The value to assign to the kms_key_id property of this CreateBootVolumeBackupDetails.
        :type kms_key_id: str

        :param retention_period:
            The value to assign to the retention_period property of this CreateBootVolumeBackupDetails.
        :type retention_period: oci.core.models.RetentionDuration

        :param is_prevent_deletion_enabled:
            The value to assign to the is_prevent_deletion_enabled property of this CreateBootVolumeBackupDetails.
        :type is_prevent_deletion_enabled: bool

        :param is_retention_lock_enabled:
            The value to assign to the is_retention_lock_enabled property of this CreateBootVolumeBackupDetails.
        :type is_retention_lock_enabled: bool

        :param is_indefinite_retention_enabled:
            The value to assign to the is_indefinite_retention_enabled property of this CreateBootVolumeBackupDetails.
        :type is_indefinite_retention_enabled: bool

        """
        self.swagger_types = {
            'boot_volume_id': 'str',
            'defined_tags': 'dict(str, dict(str, object))',
            'display_name': 'str',
            'freeform_tags': 'dict(str, str)',
            'type': 'str',
            'kms_key_id': 'str',
            'retention_period': 'RetentionDuration',
            'is_prevent_deletion_enabled': 'bool',
            'is_retention_lock_enabled': 'bool',
            'is_indefinite_retention_enabled': 'bool'
        }
        self.attribute_map = {
            'boot_volume_id': 'bootVolumeId',
            'defined_tags': 'definedTags',
            'display_name': 'displayName',
            'freeform_tags': 'freeformTags',
            'type': 'type',
            'kms_key_id': 'kmsKeyId',
            'retention_period': 'retentionPeriod',
            'is_prevent_deletion_enabled': 'isPreventDeletionEnabled',
            'is_retention_lock_enabled': 'isRetentionLockEnabled',
            'is_indefinite_retention_enabled': 'isIndefiniteRetentionEnabled'
        }
        self._boot_volume_id = None
        self._defined_tags = None
        self._display_name = None
        self._freeform_tags = None
        self._type = None
        self._kms_key_id = None
        self._retention_period = None
        self._is_prevent_deletion_enabled = None
        self._is_retention_lock_enabled = None
        self._is_indefinite_retention_enabled = None

    @property
    def boot_volume_id(self):
        """
        **[Required]** Gets the boot_volume_id of this CreateBootVolumeBackupDetails.
        The OCID of the boot volume that needs to be backed up.


        :return: The boot_volume_id of this CreateBootVolumeBackupDetails.
        :rtype: str
        """
        return self._boot_volume_id

    @boot_volume_id.setter
    def boot_volume_id(self, boot_volume_id):
        """
        Sets the boot_volume_id of this CreateBootVolumeBackupDetails.
        The OCID of the boot volume that needs to be backed up.


        :param boot_volume_id: The boot_volume_id of this CreateBootVolumeBackupDetails.
        :type: str
        """
        self._boot_volume_id = boot_volume_id

    @property
    def defined_tags(self):
        """
        Gets the defined_tags of this CreateBootVolumeBackupDetails.
        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 CreateBootVolumeBackupDetails.
        :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 CreateBootVolumeBackupDetails.
        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 CreateBootVolumeBackupDetails.
        :type: dict(str, dict(str, object))
        """
        self._defined_tags = defined_tags

    @property
    def display_name(self):
        """
        Gets the display_name of this CreateBootVolumeBackupDetails.
        A user-friendly name. Does not have to be unique, and it's changeable.
        Avoid entering confidential information.


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

    @display_name.setter
    def display_name(self, display_name):
        """
        Sets the display_name of this CreateBootVolumeBackupDetails.
        A user-friendly name. Does not have to be unique, and it's changeable.
        Avoid entering confidential information.


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

    @property
    def freeform_tags(self):
        """
        Gets the freeform_tags of this CreateBootVolumeBackupDetails.
        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 CreateBootVolumeBackupDetails.
        :rtype: dict(str, str)
        """
        return self._freeform_tags

    @freeform_tags.setter
    def freeform_tags(self, freeform_tags):
        """
        Sets the freeform_tags of this CreateBootVolumeBackupDetails.
        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 CreateBootVolumeBackupDetails.
        :type: dict(str, str)
        """
        self._freeform_tags = freeform_tags

    @property
    def type(self):
        """
        Gets the type of this CreateBootVolumeBackupDetails.
        The type of backup to create. If omitted, defaults to incremental.

        Allowed values for this property are: "FULL", "INCREMENTAL"


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

    @type.setter
    def type(self, type):
        """
        Sets the type of this CreateBootVolumeBackupDetails.
        The type of backup to create. If omitted, defaults to incremental.


        :param type: The type of this CreateBootVolumeBackupDetails.
        :type: str
        """
        allowed_values = ["FULL", "INCREMENTAL"]
        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 kms_key_id(self):
        """
        Gets the kms_key_id of this CreateBootVolumeBackupDetails.
        The OCID of the Vault service key which is the master encryption key for the volume backup.
        For more information about the Vault service and encryption keys, see
        `Overview of Vault service`__ and
        `Using Keys`__.

        __ https://docs.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm
        __ https://docs.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm


        :return: The kms_key_id of this CreateBootVolumeBackupDetails.
        :rtype: str
        """
        return self._kms_key_id

    @kms_key_id.setter
    def kms_key_id(self, kms_key_id):
        """
        Sets the kms_key_id of this CreateBootVolumeBackupDetails.
        The OCID of the Vault service key which is the master encryption key for the volume backup.
        For more information about the Vault service and encryption keys, see
        `Overview of Vault service`__ and
        `Using Keys`__.

        __ https://docs.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm
        __ https://docs.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm


        :param kms_key_id: The kms_key_id of this CreateBootVolumeBackupDetails.
        :type: str
        """
        self._kms_key_id = kms_key_id

    @property
    def retention_period(self):
        """
        Gets the retention_period of this CreateBootVolumeBackupDetails.

        :return: The retention_period of this CreateBootVolumeBackupDetails.
        :rtype: oci.core.models.RetentionDuration
        """
        return self._retention_period

    @retention_period.setter
    def retention_period(self, retention_period):
        """
        Sets the retention_period of this CreateBootVolumeBackupDetails.

        :param retention_period: The retention_period of this CreateBootVolumeBackupDetails.
        :type: oci.core.models.RetentionDuration
        """
        self._retention_period = retention_period

    @property
    def is_prevent_deletion_enabled(self):
        """
        Gets the is_prevent_deletion_enabled of this CreateBootVolumeBackupDetails.
        Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.


        :return: The is_prevent_deletion_enabled of this CreateBootVolumeBackupDetails.
        :rtype: bool
        """
        return self._is_prevent_deletion_enabled

    @is_prevent_deletion_enabled.setter
    def is_prevent_deletion_enabled(self, is_prevent_deletion_enabled):
        """
        Sets the is_prevent_deletion_enabled of this CreateBootVolumeBackupDetails.
        Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.


        :param is_prevent_deletion_enabled: The is_prevent_deletion_enabled of this CreateBootVolumeBackupDetails.
        :type: bool
        """
        self._is_prevent_deletion_enabled = is_prevent_deletion_enabled

    @property
    def is_retention_lock_enabled(self):
        """
        Gets the is_retention_lock_enabled of this CreateBootVolumeBackupDetails.
        feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.


        :return: The is_retention_lock_enabled of this CreateBootVolumeBackupDetails.
        :rtype: bool
        """
        return self._is_retention_lock_enabled

    @is_retention_lock_enabled.setter
    def is_retention_lock_enabled(self, is_retention_lock_enabled):
        """
        Sets the is_retention_lock_enabled of this CreateBootVolumeBackupDetails.
        feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.


        :param is_retention_lock_enabled: The is_retention_lock_enabled of this CreateBootVolumeBackupDetails.
        :type: bool
        """
        self._is_retention_lock_enabled = is_retention_lock_enabled

    @property
    def is_indefinite_retention_enabled(self):
        """
        Gets the is_indefinite_retention_enabled of this CreateBootVolumeBackupDetails.
        feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.


        :return: The is_indefinite_retention_enabled of this CreateBootVolumeBackupDetails.
        :rtype: bool
        """
        return self._is_indefinite_retention_enabled

    @is_indefinite_retention_enabled.setter
    def is_indefinite_retention_enabled(self, is_indefinite_retention_enabled):
        """
        Sets the is_indefinite_retention_enabled of this CreateBootVolumeBackupDetails.
        feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups.


        :param is_indefinite_retention_enabled: The is_indefinite_retention_enabled of this CreateBootVolumeBackupDetails.
        :type: bool
        """
        self._is_indefinite_retention_enabled = is_indefinite_retention_enabled

    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
