# coding: utf-8
# Copyright (c) 2016, 2024, 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: 20220125

from .dr_plan_user_defined_step import DrPlanUserDefinedStep
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 RunLocalScriptUserDefinedStep(DrPlanUserDefinedStep):
    """
    Run Local Script step details.
    """

    def __init__(self, **kwargs):
        """
        Initializes a new RunLocalScriptUserDefinedStep object with values from keyword arguments. The default value of the :py:attr:`~oci.disaster_recovery.models.RunLocalScriptUserDefinedStep.step_type` attribute
        of this class is ``RUN_LOCAL_SCRIPT`` and it should not be changed.
        The following keyword arguments are supported (corresponding to the getters/setters of this class):

        :param step_type:
            The value to assign to the step_type property of this RunLocalScriptUserDefinedStep.
            Allowed values for this property are: "RUN_OBJECTSTORE_SCRIPT_PRECHECK", "RUN_LOCAL_SCRIPT_PRECHECK", "INVOKE_FUNCTION_PRECHECK", "RUN_OBJECTSTORE_SCRIPT", "RUN_LOCAL_SCRIPT", "INVOKE_FUNCTION"
        :type step_type: str

        :param run_on_instance_id:
            The value to assign to the run_on_instance_id property of this RunLocalScriptUserDefinedStep.
        :type run_on_instance_id: str

        :param run_on_instance_region:
            The value to assign to the run_on_instance_region property of this RunLocalScriptUserDefinedStep.
        :type run_on_instance_region: str

        :param script_command:
            The value to assign to the script_command property of this RunLocalScriptUserDefinedStep.
        :type script_command: str

        :param run_as_user:
            The value to assign to the run_as_user property of this RunLocalScriptUserDefinedStep.
        :type run_as_user: str

        """
        self.swagger_types = {
            'step_type': 'str',
            'run_on_instance_id': 'str',
            'run_on_instance_region': 'str',
            'script_command': 'str',
            'run_as_user': 'str'
        }

        self.attribute_map = {
            'step_type': 'stepType',
            'run_on_instance_id': 'runOnInstanceId',
            'run_on_instance_region': 'runOnInstanceRegion',
            'script_command': 'scriptCommand',
            'run_as_user': 'runAsUser'
        }

        self._step_type = None
        self._run_on_instance_id = None
        self._run_on_instance_region = None
        self._script_command = None
        self._run_as_user = None
        self._step_type = 'RUN_LOCAL_SCRIPT'

    @property
    def run_on_instance_id(self):
        """
        **[Required]** Gets the run_on_instance_id of this RunLocalScriptUserDefinedStep.
        The OCID of the instance on which this script or command should be executed.

        **For moving instances:** *runOnInstanceId* must be the OCID of the instance in the region where the
        instance is currently present.

        **For non-moving instances:** *runOnInstanceId* must be the OCID of the non-moving instance.

        Example: `ocid1.instance.oc1..uniqueID`


        :return: The run_on_instance_id of this RunLocalScriptUserDefinedStep.
        :rtype: str
        """
        return self._run_on_instance_id

    @run_on_instance_id.setter
    def run_on_instance_id(self, run_on_instance_id):
        """
        Sets the run_on_instance_id of this RunLocalScriptUserDefinedStep.
        The OCID of the instance on which this script or command should be executed.

        **For moving instances:** *runOnInstanceId* must be the OCID of the instance in the region where the
        instance is currently present.

        **For non-moving instances:** *runOnInstanceId* must be the OCID of the non-moving instance.

        Example: `ocid1.instance.oc1..uniqueID`


        :param run_on_instance_id: The run_on_instance_id of this RunLocalScriptUserDefinedStep.
        :type: str
        """
        self._run_on_instance_id = run_on_instance_id

    @property
    def run_on_instance_region(self):
        """
        **[Required]** Gets the run_on_instance_region of this RunLocalScriptUserDefinedStep.
        The region in which the instance is present.

        Example: `us-ashburn-1`


        :return: The run_on_instance_region of this RunLocalScriptUserDefinedStep.
        :rtype: str
        """
        return self._run_on_instance_region

    @run_on_instance_region.setter
    def run_on_instance_region(self, run_on_instance_region):
        """
        Sets the run_on_instance_region of this RunLocalScriptUserDefinedStep.
        The region in which the instance is present.

        Example: `us-ashburn-1`


        :param run_on_instance_region: The run_on_instance_region of this RunLocalScriptUserDefinedStep.
        :type: str
        """
        self._run_on_instance_region = run_on_instance_region

    @property
    def script_command(self):
        """
        **[Required]** Gets the script_command of this RunLocalScriptUserDefinedStep.
        The script name and arguments.

        Example: `/usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3`


        :return: The script_command of this RunLocalScriptUserDefinedStep.
        :rtype: str
        """
        return self._script_command

    @script_command.setter
    def script_command(self, script_command):
        """
        Sets the script_command of this RunLocalScriptUserDefinedStep.
        The script name and arguments.

        Example: `/usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3`


        :param script_command: The script_command of this RunLocalScriptUserDefinedStep.
        :type: str
        """
        self._script_command = script_command

    @property
    def run_as_user(self):
        """
        Gets the run_as_user of this RunLocalScriptUserDefinedStep.
        The userid on the instance to be used for executing the script or command.

        Example: `opc`


        :return: The run_as_user of this RunLocalScriptUserDefinedStep.
        :rtype: str
        """
        return self._run_as_user

    @run_as_user.setter
    def run_as_user(self, run_as_user):
        """
        Sets the run_as_user of this RunLocalScriptUserDefinedStep.
        The userid on the instance to be used for executing the script or command.

        Example: `opc`


        :param run_as_user: The run_as_user of this RunLocalScriptUserDefinedStep.
        :type: str
        """
        self._run_as_user = run_as_user

    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