# coding: utf-8


"""
IGNORE:
    Nutanix Data Protection APIs

    Business Continuity with full spectrum of Disaster Recovery and Backup solution. Spanning across Single PC, Cross AZ, MultiSite. Configuration of Recovery points, Protection policies, Recovery Plans. Execution and monitoring of back up and recovery orchestrations on OnPrem as well as Cloud.  # noqa: E501

    OpenAPI spec version: 4.3.1
    
    Generated by: https://github.com/swagger-api/swagger-codegen.git
IGNORE
"""
import pprint
import json
import ast
import re  # noqa: F401

import six
from pathlib import Path
from ntnx_dataprotection_py_client.models.common.v1.response.ApiLink import ApiLink  # noqa: F401,E501
from ntnx_dataprotection_py_client.models.common.v1.response.ExternalizableAbstractModel import ExternalizableAbstractModel  # noqa: F401,E501
from ntnx_dataprotection_py_client.models.dataprotection.v4.config.FailoverDirection import FailoverDirection  # noqa: F401,E501
from ntnx_dataprotection_py_client.models.dataprotection.v4.config.PhaseSummary import PhaseSummary  # noqa: F401,E501
from ntnx_dataprotection_py_client.models.dataprotection.v4.config.RecoveryPlanActionType import RecoveryPlanActionType  # noqa: F401,E501
from ntnx_dataprotection_py_client.models.dataprotection.v4.config.RecoveryPlanJobExecutionStatus import RecoveryPlanJobExecutionStatus  # noqa: F401,E501
from ntnx_dataprotection_py_client.models.dataprotection.v4.config.Summary import Summary  # noqa: F401,E501

class RecoveryPlanJob(ExternalizableAbstractModel):

    """A recovery plan job specification describing the recovery plan to be executed, failover directions and type of failover.

    :param name: (:attr:`name`) Name of the Recovery Plan Job.
    :type name: 
     max=256 chars
    
    :param recovery_plan_ext_id: (:attr:`recovery_plan_ext_id`) The external identifier of the recovery plan.
    :type recovery_plan_ext_id: 
    
    
    :param failover_directions: (:attr:`failover_directions`) List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
    :type failover_directions: 
    
    
    :param action_type: (:attr:`action_type`) 
    :type action_type: 
    
    
    :param recovery_reference_time: (:attr:`recovery_reference_time`) Point in time from which to restore the entities during an `UNPLANNED_FAILOVER` operation. Only ISO-8601 formatted timestamps are supported. For example, `2023-01-02T03:04:05Z`.<br> When specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the specified timestamp. If not specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the start of the Recovery plan job.
    :type recovery_reference_time: 
    
    
    :param is_live_migrate_v_ms: (:attr:`is_live_migrate_v_ms`) Indicates whether to perform a live migration of virtual machines (VMs) during a `PLANNED_FAILOVER` operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state.
    :type is_live_migrate_v_ms: 
    
    
    :param start_time: (:attr:`start_time`) Recovery plan job start time in ISO-8601 format.
    :type start_time: 
    
    
    :param end_time: (:attr:`end_time`) Recovery plan job completion time in ISO-8601 format.
    :type end_time: 
    
    
    :param status: (:attr:`status`) 
    :type status: 
    
    
    :param percentage_complete: (:attr:`percentage_complete`) Percentage complete for the recovery plan job.
    :type percentage_complete: 
    
     min=0, max=100
    :param validation_status: (:attr:`validation_status`) 
    :type validation_status: 
    
    
    :param execution_phases: (:attr:`execution_phases`) Summary of all the phases involved in the recovery plan job execution:<br> - Pre-processing: Actions carried out prior to the recovery of entities, such as creating a network or synchronizing recovery points as part of a `PLANNED_FAILOVER` operation.<br> - Entity recovery: Steps performed for the recovery of the entities for the recovery plan job.<br> - Post-processing: Actions taken after the recovery of entities, such as creating a Consistency group or auditing the recovery plan job information.
    :type execution_phases: 
    
    
    :param is_initiated_by_witness: (:attr:`is_initiated_by_witness`) Indicates whether the recovery plan job was initiated by the witness or not.
    :type is_initiated_by_witness: 
    
    
    :param owner_ext_id: (:attr:`owner_ext_id`) External identifier of the owner of the recovery plan job.
    :type owner_ext_id: 
    
    
    :param is_instant_restore: (:attr:`is_instant_restore`) Indicates whether to enable Instant Restore. This feature allows a workload, such as a virtual machine (VM), to be quickly restored and powered on directly from an external backup repository on a Nutanix AOS cluster, without waiting for a full data transfer.
    :type is_instant_restore: 
    
    

    """
    """
    IGNORE:
    Attributes:
      swagger_types (dict): The key is attribute name
                            and the value is attribute type.
      attribute_map (dict): The key is attribute name
                            and the value is json key in definition.
    IGNORE
    """  # noqa: E501
    swagger_types = {
        'name': 'str',
        'recovery_plan_ext_id': 'str',
        'failover_directions': 'list[dataprotection.v4.config.FailoverDirection]',
        'action_type': 'dataprotection.v4.config.RecoveryPlanActionType',
        'recovery_reference_time': 'datetime',
        'is_live_migrate_v_ms': 'bool',
        'start_time': 'datetime',
        'end_time': 'datetime',
        'status': 'dataprotection.v4.config.RecoveryPlanJobExecutionStatus',
        'percentage_complete': 'int',
        'validation_status': 'dataprotection.v4.config.Summary',
        'execution_phases': 'list[dataprotection.v4.config.PhaseSummary]',
        'is_initiated_by_witness': 'bool',
        'owner_ext_id': 'str',
        'is_instant_restore': 'bool',
        'ext_id': 'str',
        'links': 'list[common.v1.response.ApiLink]',
        'tenant_id': 'str',
        '_reserved': 'dict(str, object)',
        '_object_type': 'str',
        '_unknown_fields': 'dict(str, object)',
    }

    attribute_map = {
        'name': 'name',
        'recovery_plan_ext_id': 'recoveryPlanExtId',
        'failover_directions': 'failoverDirections',
        'action_type': 'actionType',
        'recovery_reference_time': 'recoveryReferenceTime',
        'is_live_migrate_v_ms': 'isLiveMigrateVMs',
        'start_time': 'startTime',
        'end_time': 'endTime',
        'status': 'status',
        'percentage_complete': 'percentageComplete',
        'validation_status': 'validationStatus',
        'execution_phases': 'executionPhases',
        'is_initiated_by_witness': 'isInitiatedByWitness',
        'owner_ext_id': 'ownerExtId',
        'is_instant_restore': 'isInstantRestore',
        'ext_id': 'extId',
        'links': 'links',
        'tenant_id': 'tenantId',
        '_reserved': '$reserved',
        '_object_type': '$objectType',
        '_unknown_fields': '$unknownFields',
    }



    def __init__(self, name=None, recovery_plan_ext_id=None, failover_directions=None, action_type=None, recovery_reference_time=None, is_live_migrate_v_ms=None, start_time=None, end_time=None, status=None, percentage_complete=None, validation_status=None, execution_phases=None, is_initiated_by_witness=None, owner_ext_id=None, is_instant_restore=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs):  # noqa: E501
        ExternalizableAbstractModel.__init__(self, ext_id, links, tenant_id, *args, **kwargs)
        self.__name = None
        self.__recovery_plan_ext_id = None
        self.__failover_directions = None
        self.__action_type = None
        self.__recovery_reference_time = None
        self.__is_live_migrate_v_ms = None
        self.__start_time = None
        self.__end_time = None
        self.__status = None
        self.__percentage_complete = None
        self.__validation_status = None
        self.__execution_phases = None
        self.__is_initiated_by_witness = None
        self.__owner_ext_id = None
        self.__is_instant_restore = None
        self.discriminator = None
        if name is not None:
            self.__name = name
        if recovery_plan_ext_id is not None:
            self.__recovery_plan_ext_id = recovery_plan_ext_id
        if failover_directions is not None:
            self.__failover_directions = failover_directions
        if action_type is not None:
            self.__action_type = action_type
        if recovery_reference_time is not None:
            self.__recovery_reference_time = recovery_reference_time
        if is_live_migrate_v_ms is not None:
            self.__is_live_migrate_v_ms = is_live_migrate_v_ms
        if start_time is not None:
            self.__start_time = start_time
        if end_time is not None:
            self.__end_time = end_time
        if status is not None:
            self.__status = status
        if percentage_complete is not None:
            self.__percentage_complete = percentage_complete
        if validation_status is not None:
            self.__validation_status = validation_status
        if execution_phases is not None:
            self.__execution_phases = execution_phases
        if is_initiated_by_witness is not None:
            self.__is_initiated_by_witness = is_initiated_by_witness
        if owner_ext_id is not None:
            self.__owner_ext_id = owner_ext_id
        if is_instant_restore is not None:
            self.__is_instant_restore = is_instant_restore

    def _initialize_object_type(self):
        return 'dataprotection.v4.config.RecoveryPlanJob'

    def _initialize_object_version(self):
        return 'v4.r3'


    @property
    def name(self):
        """
        Name of the Recovery Plan Job.

        :type:
                :class:`~str`
        """  # noqa: E501
        return self.__name

    @name.setter
    def name(self, name):
        if name is not None and len(name) > 256:
            raise ValueError("Invalid value for `name`, length must be less than or equal to `256`")  # noqa: E501

        self.__name = name

    @property
    def recovery_plan_ext_id(self):
        """
        The external identifier of the recovery plan.

        :type:
                :class:`~str`
        """  # noqa: E501
        return self.__recovery_plan_ext_id

    @recovery_plan_ext_id.setter
    def recovery_plan_ext_id(self, recovery_plan_ext_id):
        if recovery_plan_ext_id is not None and not re.search('^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$', recovery_plan_ext_id):  # noqa: E501
            raise ValueError(r"Invalid value for `recovery_plan_ext_id`, must be a follow pattern or equal to `/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/`")  # noqa: E501

        self.__recovery_plan_ext_id = recovery_plan_ext_id

    @property
    def failover_directions(self):
        """
        List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.

        :type:
             list[ :class:`~ntnx_dataprotection_py_client.models.dataprotection.v4.config.FailoverDirection` ]
        """  # noqa: E501
        return self.__failover_directions

    @failover_directions.setter
    def failover_directions(self, failover_directions):

        self.__failover_directions = failover_directions

    @property
    def action_type(self):
        """
        

        :type:
            :class:`~ntnx_dataprotection_py_client.models.dataprotection.v4.config.RecoveryPlanActionType`
        """  # noqa: E501
        return self.__action_type

    @action_type.setter
    def action_type(self, action_type):

        self.__action_type = action_type

    @property
    def recovery_reference_time(self):
        """
        Point in time from which to restore the entities during an `UNPLANNED_FAILOVER` operation. Only ISO-8601 formatted timestamps are supported. For example, `2023-01-02T03:04:05Z`.<br> When specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the specified timestamp. If not specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the start of the Recovery plan job.

        :type:
                :class:`~datetime`
        """  # noqa: E501
        return self.__recovery_reference_time

    @recovery_reference_time.setter
    def recovery_reference_time(self, recovery_reference_time):

        self.__recovery_reference_time = recovery_reference_time

    @property
    def is_live_migrate_v_ms(self):
        """
        Indicates whether to perform a live migration of virtual machines (VMs) during a `PLANNED_FAILOVER` operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state.

        :type:
                :class:`~bool`
        """  # noqa: E501
        return self.__is_live_migrate_v_ms

    @is_live_migrate_v_ms.setter
    def is_live_migrate_v_ms(self, is_live_migrate_v_ms):

        self.__is_live_migrate_v_ms = is_live_migrate_v_ms

    @property
    def start_time(self):
        """
        Recovery plan job start time in ISO-8601 format.

        :type:
                :class:`~datetime`
        """  # noqa: E501
        return self.__start_time

    @start_time.setter
    def start_time(self, start_time):

        self.__start_time = start_time

    @property
    def end_time(self):
        """
        Recovery plan job completion time in ISO-8601 format.

        :type:
                :class:`~datetime`
        """  # noqa: E501
        return self.__end_time

    @end_time.setter
    def end_time(self, end_time):

        self.__end_time = end_time

    @property
    def status(self):
        """
        

        :type:
            :class:`~ntnx_dataprotection_py_client.models.dataprotection.v4.config.RecoveryPlanJobExecutionStatus`
        """  # noqa: E501
        return self.__status

    @status.setter
    def status(self, status):

        self.__status = status

    @property
    def percentage_complete(self):
        """
        Percentage complete for the recovery plan job.

        :type:
                :class:`~int`
        """  # noqa: E501
        return self.__percentage_complete

    @percentage_complete.setter
    def percentage_complete(self, percentage_complete):
        if percentage_complete is not None and percentage_complete > 100:  # noqa: E501
            raise ValueError("Invalid value for `percentage_complete`, must be a value less than or equal to `100`")  # noqa: E501
        if percentage_complete is not None and percentage_complete < 0:  # noqa: E501
            raise ValueError("Invalid value for `percentage_complete`, must be a value greater than or equal to `0`")  # noqa: E501

        self.__percentage_complete = percentage_complete

    @property
    def validation_status(self):
        """
        

        :type:
            :class:`~ntnx_dataprotection_py_client.models.dataprotection.v4.config.Summary`
        """  # noqa: E501
        return self.__validation_status

    @validation_status.setter
    def validation_status(self, validation_status):

        self.__validation_status = validation_status

    @property
    def execution_phases(self):
        """
        Summary of all the phases involved in the recovery plan job execution:<br> - Pre-processing: Actions carried out prior to the recovery of entities, such as creating a network or synchronizing recovery points as part of a `PLANNED_FAILOVER` operation.<br> - Entity recovery: Steps performed for the recovery of the entities for the recovery plan job.<br> - Post-processing: Actions taken after the recovery of entities, such as creating a Consistency group or auditing the recovery plan job information.

        :type:
             list[ :class:`~ntnx_dataprotection_py_client.models.dataprotection.v4.config.PhaseSummary` ]
        """  # noqa: E501
        return self.__execution_phases

    @execution_phases.setter
    def execution_phases(self, execution_phases):

        self.__execution_phases = execution_phases

    @property
    def is_initiated_by_witness(self):
        """
        Indicates whether the recovery plan job was initiated by the witness or not.

        :type:
                :class:`~bool`
        """  # noqa: E501
        return self.__is_initiated_by_witness

    @is_initiated_by_witness.setter
    def is_initiated_by_witness(self, is_initiated_by_witness):

        self.__is_initiated_by_witness = is_initiated_by_witness

    @property
    def owner_ext_id(self):
        """
        External identifier of the owner of the recovery plan job.

        :type:
                :class:`~str`
        """  # noqa: E501
        return self.__owner_ext_id

    @owner_ext_id.setter
    def owner_ext_id(self, owner_ext_id):
        if owner_ext_id is not None and not re.search('^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$', owner_ext_id):  # noqa: E501
            raise ValueError(r"Invalid value for `owner_ext_id`, must be a follow pattern or equal to `/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/`")  # noqa: E501

        self.__owner_ext_id = owner_ext_id

    @property
    def is_instant_restore(self):
        """
        Indicates whether to enable Instant Restore. This feature allows a workload, such as a virtual machine (VM), to be quickly restored and powered on directly from an external backup repository on a Nutanix AOS cluster, without waiting for a full data transfer.

        :type:
                :class:`~bool`
        """  # noqa: E501
        return self.__is_instant_restore

    @is_instant_restore.setter
    def is_instant_restore(self, is_instant_restore):

        self.__is_instant_restore = is_instant_restore

    def _to_dict(self, sanitize):
        """Returns the model properties as a dict. Omits None properties based on the provided "sanitize" parameter.

        :param sanitize: A flag to omit None properties if set to True
        :type sanitize: bool
        """

        result = {}
        for attr, attr_type in six.iteritems(self.swagger_types):

            value = getattr(self, attr)
            if isinstance(value, list):
                result[attr] = list(map(
                    lambda x: x._to_dict(sanitize) if hasattr(x, "_to_dict") else x,
                    value
                ))
            elif hasattr(value, "_to_dict"):
                result[attr] = value._to_dict(sanitize)
            elif isinstance(value, Path):
                result[attr] = str(value)
            elif isinstance(value, dict):
                result[attr] = dict(map(
                    lambda item: (item[0], item[1]._to_dict(sanitize)) if hasattr(item[1], "_to_dict")
                    else (
                        (item[0], str(item[1])) if item[0] == 'path' and '$objectType' in value and value['$objectType'] == 'pathlib.Path'
                        else item
                    ),
                    six.iteritems(value)
                ))
            else:
                if sanitize:
                    if value is not None:
                        result[attr] = value
                else:
                    result[attr] = value
        if issubclass(RecoveryPlanJob, dict):
            for key, value in six.iteritems(self):
                result[key] = value

        # handle unknown fields
        result['_unknown_fields'] = {}
        unknown = self.get_unknown_fields()
        if sanitize:
            unknown = self._sanitize_for_serialization(unknown)

        return {**result, **unknown}


    def to_dict(self):
        """Returns the model properties as a dictionary"""
        return self._to_dict(False)

    def to_str(self):
        """Returns the string representation of the model"""
        return pprint.pformat(self._to_dict(True))

    def __repr__(self):
        """For `print` and `pprint`"""
        return self.to_str()

    def __eq__(self, other):
        """Returns true if both objects are equal"""
        if not isinstance(other, RecoveryPlanJob):
            return False

        return self.__dict__ == other.__dict__

    def __ne__(self, other):
        """Returns true if both objects are not equal"""
        return not self == other

