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


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 Byol(object):
    """
    An `Oracle Cloud VMware Solution`__ Bring-Your-Own-License (BYOL),
    is a permit (entitlement) customer purchased from Broadcom and registered in OCI to install VMware software.

    __ https://docs.oracle.com/iaas/Content/VMware/Concepts/ocvsoverview.htm
    """

    #: A constant which can be used with the lifecycle_state property of a Byol.
    #: This constant has a value of "CREATING"
    LIFECYCLE_STATE_CREATING = "CREATING"

    #: A constant which can be used with the lifecycle_state property of a Byol.
    #: This constant has a value of "ACTIVE"
    LIFECYCLE_STATE_ACTIVE = "ACTIVE"

    #: A constant which can be used with the lifecycle_state property of a Byol.
    #: This constant has a value of "INACTIVE"
    LIFECYCLE_STATE_INACTIVE = "INACTIVE"

    #: A constant which can be used with the lifecycle_state property of a Byol.
    #: This constant has a value of "UPDATING"
    LIFECYCLE_STATE_UPDATING = "UPDATING"

    #: A constant which can be used with the lifecycle_state property of a Byol.
    #: This constant has a value of "DELETING"
    LIFECYCLE_STATE_DELETING = "DELETING"

    #: A constant which can be used with the lifecycle_state property of a Byol.
    #: This constant has a value of "DELETED"
    LIFECYCLE_STATE_DELETED = "DELETED"

    #: A constant which can be used with the lifecycle_state property of a Byol.
    #: This constant has a value of "FAILED"
    LIFECYCLE_STATE_FAILED = "FAILED"

    #: A constant which can be used with the software_type property of a Byol.
    #: This constant has a value of "VCF"
    SOFTWARE_TYPE_VCF = "VCF"

    #: A constant which can be used with the software_type property of a Byol.
    #: This constant has a value of "VSAN"
    SOFTWARE_TYPE_VSAN = "VSAN"

    #: A constant which can be used with the software_type property of a Byol.
    #: This constant has a value of "VDEFEND"
    SOFTWARE_TYPE_VDEFEND = "VDEFEND"

    #: A constant which can be used with the software_type property of a Byol.
    #: This constant has a value of "AVI_LOAD_BALANCER"
    SOFTWARE_TYPE_AVI_LOAD_BALANCER = "AVI_LOAD_BALANCER"

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

        :param id:
            The value to assign to the id property of this Byol.
        :type id: str

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

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

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

        :param lifecycle_state:
            The value to assign to the lifecycle_state property of this Byol.
            Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type lifecycle_state: str

        :param software_type:
            The value to assign to the software_type property of this Byol.
            Allowed values for this property are: "VCF", "VSAN", "VDEFEND", "AVI_LOAD_BALANCER", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type software_type: str

        :param total_units:
            The value to assign to the total_units property of this Byol.
        :type total_units: int

        :param available_units:
            The value to assign to the available_units property of this Byol.
        :type available_units: int

        :param time_term_start:
            The value to assign to the time_term_start property of this Byol.
        :type time_term_start: datetime

        :param time_term_end:
            The value to assign to the time_term_end property of this Byol.
        :type time_term_end: datetime

        :param entitlement_key:
            The value to assign to the entitlement_key property of this Byol.
        :type entitlement_key: str

        :param time_created:
            The value to assign to the time_created property of this Byol.
        :type time_created: datetime

        :param time_updated:
            The value to assign to the time_updated property of this Byol.
        :type time_updated: datetime

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

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

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

        """
        self.swagger_types = {
            'id': 'str',
            'compartment_id': 'str',
            'display_name': 'str',
            'description': 'str',
            'lifecycle_state': 'str',
            'software_type': 'str',
            'total_units': 'int',
            'available_units': 'int',
            'time_term_start': 'datetime',
            'time_term_end': 'datetime',
            'entitlement_key': 'str',
            'time_created': 'datetime',
            'time_updated': 'datetime',
            'freeform_tags': 'dict(str, str)',
            'defined_tags': 'dict(str, dict(str, object))',
            'system_tags': 'dict(str, dict(str, object))'
        }
        self.attribute_map = {
            'id': 'id',
            'compartment_id': 'compartmentId',
            'display_name': 'displayName',
            'description': 'description',
            'lifecycle_state': 'lifecycleState',
            'software_type': 'softwareType',
            'total_units': 'totalUnits',
            'available_units': 'availableUnits',
            'time_term_start': 'timeTermStart',
            'time_term_end': 'timeTermEnd',
            'entitlement_key': 'entitlementKey',
            'time_created': 'timeCreated',
            'time_updated': 'timeUpdated',
            'freeform_tags': 'freeformTags',
            'defined_tags': 'definedTags',
            'system_tags': 'systemTags'
        }
        self._id = None
        self._compartment_id = None
        self._display_name = None
        self._description = None
        self._lifecycle_state = None
        self._software_type = None
        self._total_units = None
        self._available_units = None
        self._time_term_start = None
        self._time_term_end = None
        self._entitlement_key = None
        self._time_created = None
        self._time_updated = None
        self._freeform_tags = None
        self._defined_tags = None
        self._system_tags = None

    @property
    def id(self):
        """
        **[Required]** Gets the id of this Byol.
        The `OCID`__ of the BYOL.

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


        :return: The id of this Byol.
        :rtype: str
        """
        return self._id

    @id.setter
    def id(self, id):
        """
        Sets the id of this Byol.
        The `OCID`__ of the BYOL.

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


        :param id: The id of this Byol.
        :type: str
        """
        self._id = id

    @property
    def compartment_id(self):
        """
        **[Required]** Gets the compartment_id of this Byol.
        The `OCID`__ of the compartment that
        contains the BYOL.

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


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

    @compartment_id.setter
    def compartment_id(self, compartment_id):
        """
        Sets the compartment_id of this Byol.
        The `OCID`__ of the compartment that
        contains the BYOL.

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


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

    @property
    def display_name(self):
        """
        **[Required]** Gets the display_name of this Byol.
        A descriptive name for the BYOL.


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

    @display_name.setter
    def display_name(self, display_name):
        """
        Sets the display_name of this Byol.
        A descriptive name for the BYOL.


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

    @property
    def description(self):
        """
        Gets the description of this Byol.
        A description of the BYOL.


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

    @description.setter
    def description(self, description):
        """
        Sets the description of this Byol.
        A description of the BYOL.


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

    @property
    def lifecycle_state(self):
        """
        **[Required]** Gets the lifecycle_state of this Byol.
        The current state of the BYOL.

        Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.


        :return: The lifecycle_state of this Byol.
        :rtype: str
        """
        return self._lifecycle_state

    @lifecycle_state.setter
    def lifecycle_state(self, lifecycle_state):
        """
        Sets the lifecycle_state of this Byol.
        The current state of the BYOL.


        :param lifecycle_state: The lifecycle_state of this Byol.
        :type: str
        """
        allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"]
        if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
            lifecycle_state = 'UNKNOWN_ENUM_VALUE'
        self._lifecycle_state = lifecycle_state

    @property
    def software_type(self):
        """
        **[Required]** Gets the software_type of this Byol.
        The type of VMware software the BYOL applies to.
        Supported values:
        - VCF (VMware Cloud Foundation)
        - VSAN (VMware vSAN)
        - VDEFEND (VMware vDefend Firewall)
        - AVI_LOAD_BALANCER (VMware Avi Load Balancer)

        Allowed values for this property are: "VCF", "VSAN", "VDEFEND", "AVI_LOAD_BALANCER", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.


        :return: The software_type of this Byol.
        :rtype: str
        """
        return self._software_type

    @software_type.setter
    def software_type(self, software_type):
        """
        Sets the software_type of this Byol.
        The type of VMware software the BYOL applies to.
        Supported values:
        - VCF (VMware Cloud Foundation)
        - VSAN (VMware vSAN)
        - VDEFEND (VMware vDefend Firewall)
        - AVI_LOAD_BALANCER (VMware Avi Load Balancer)


        :param software_type: The software_type of this Byol.
        :type: str
        """
        allowed_values = ["VCF", "VSAN", "VDEFEND", "AVI_LOAD_BALANCER"]
        if not value_allowed_none_or_none_sentinel(software_type, allowed_values):
            software_type = 'UNKNOWN_ENUM_VALUE'
        self._software_type = software_type

    @property
    def total_units(self):
        """
        **[Required]** Gets the total_units of this Byol.
        Total quantity of licensed units for the specified `softwareType`:

        - VCF, VDEFEND: number of OCPUs
        - VSAN: storage capacity in TiB (tebibytes)
        - AVI_LOAD_BALANCER: number of instances


        :return: The total_units of this Byol.
        :rtype: int
        """
        return self._total_units

    @total_units.setter
    def total_units(self, total_units):
        """
        Sets the total_units of this Byol.
        Total quantity of licensed units for the specified `softwareType`:

        - VCF, VDEFEND: number of OCPUs
        - VSAN: storage capacity in TiB (tebibytes)
        - AVI_LOAD_BALANCER: number of instances


        :param total_units: The total_units of this Byol.
        :type: int
        """
        self._total_units = total_units

    @property
    def available_units(self):
        """
        **[Required]** Gets the available_units of this Byol.
        The quantity of licensed units that not yet allocated to specific region.


        :return: The available_units of this Byol.
        :rtype: int
        """
        return self._available_units

    @available_units.setter
    def available_units(self, available_units):
        """
        Sets the available_units of this Byol.
        The quantity of licensed units that not yet allocated to specific region.


        :param available_units: The available_units of this Byol.
        :type: int
        """
        self._available_units = available_units

    @property
    def time_term_start(self):
        """
        **[Required]** Gets the time_term_start of this Byol.
        The date and time when the BYOL becomes active. VMware software functionality cannot begin before this time.
        In the format defined by`RFC3339`__.
        Example: `2016-08-25T21:10:29.600Z`

        __ https://tools.ietf.org/html/rfc3339


        :return: The time_term_start of this Byol.
        :rtype: datetime
        """
        return self._time_term_start

    @time_term_start.setter
    def time_term_start(self, time_term_start):
        """
        Sets the time_term_start of this Byol.
        The date and time when the BYOL becomes active. VMware software functionality cannot begin before this time.
        In the format defined by`RFC3339`__.
        Example: `2016-08-25T21:10:29.600Z`

        __ https://tools.ietf.org/html/rfc3339


        :param time_term_start: The time_term_start of this Byol.
        :type: datetime
        """
        self._time_term_start = time_term_start

    @property
    def time_term_end(self):
        """
        **[Required]** Gets the time_term_end of this Byol.
        The date and time when the BYOL expires and becomes inactive.
        In the format defined by`RFC3339`__.

        __ https://tools.ietf.org/html/rfc3339


        :return: The time_term_end of this Byol.
        :rtype: datetime
        """
        return self._time_term_end

    @time_term_end.setter
    def time_term_end(self, time_term_end):
        """
        Sets the time_term_end of this Byol.
        The date and time when the BYOL expires and becomes inactive.
        In the format defined by`RFC3339`__.

        __ https://tools.ietf.org/html/rfc3339


        :param time_term_end: The time_term_end of this Byol.
        :type: datetime
        """
        self._time_term_end = time_term_end

    @property
    def entitlement_key(self):
        """
        **[Required]** Gets the entitlement_key of this Byol.
        The Broadcom-supplied identifier of a BYOL license.


        :return: The entitlement_key of this Byol.
        :rtype: str
        """
        return self._entitlement_key

    @entitlement_key.setter
    def entitlement_key(self, entitlement_key):
        """
        Sets the entitlement_key of this Byol.
        The Broadcom-supplied identifier of a BYOL license.


        :param entitlement_key: The entitlement_key of this Byol.
        :type: str
        """
        self._entitlement_key = entitlement_key

    @property
    def time_created(self):
        """
        **[Required]** Gets the time_created of this Byol.
        The date and time the BYOL was created, in the format defined by
        `RFC3339`__.
        Example: `2016-08-25T21:10:29.600Z`

        __ https://tools.ietf.org/html/rfc3339


        :return: The time_created of this Byol.
        :rtype: datetime
        """
        return self._time_created

    @time_created.setter
    def time_created(self, time_created):
        """
        Sets the time_created of this Byol.
        The date and time the BYOL was created, in the format defined by
        `RFC3339`__.
        Example: `2016-08-25T21:10:29.600Z`

        __ https://tools.ietf.org/html/rfc3339


        :param time_created: The time_created of this Byol.
        :type: datetime
        """
        self._time_created = time_created

    @property
    def time_updated(self):
        """
        **[Required]** Gets the time_updated of this Byol.
        The date and time the BYOL was updated, in the format defined by
        `RFC3339`__.

        __ https://tools.ietf.org/html/rfc3339


        :return: The time_updated of this Byol.
        :rtype: datetime
        """
        return self._time_updated

    @time_updated.setter
    def time_updated(self, time_updated):
        """
        Sets the time_updated of this Byol.
        The date and time the BYOL was updated, in the format defined by
        `RFC3339`__.

        __ https://tools.ietf.org/html/rfc3339


        :param time_updated: The time_updated of this Byol.
        :type: datetime
        """
        self._time_updated = time_updated

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

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

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

    @property
    def system_tags(self):
        """
        **[Required]** Gets the system_tags of this Byol.
        Usage of system tag keys. These predefined keys are scoped to namespaces.
        Example: `{orcl-cloud: {free-tier-retain: true}}`


        :return: The system_tags of this Byol.
        :rtype: dict(str, dict(str, object))
        """
        return self._system_tags

    @system_tags.setter
    def system_tags(self, system_tags):
        """
        Sets the system_tags of this Byol.
        Usage of system tag keys. These predefined keys are scoped to namespaces.
        Example: `{orcl-cloud: {free-tier-retain: true}}`


        :param system_tags: The system_tags of this Byol.
        :type: dict(str, dict(str, object))
        """
        self._system_tags = system_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