update_run_local_script_user_defined_step_details.go

// Copyright (c) 2016, 2018, 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.
// Code generated. DO NOT EDIT.

// Full Stack Disaster Recovery API
//
// Use the Full Stack Disaster Recovery (DR) API to manage disaster recovery for business applications.
// Full Stack DR is an OCI disaster recovery orchestration and management service that provides comprehensive disaster
// recovery capabilities for all layers of an application stack, including infrastructure, middleware, database,
// and application.
//

package disasterrecovery

import (
	"encoding/json"
	"fmt"
	"github.com/oracle/oci-go-sdk/v65/common"
	"strings"
)

// UpdateRunLocalScriptUserDefinedStepDetails The details for updating a Run Local Script step.
type UpdateRunLocalScriptUserDefinedStepDetails struct {

	// 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`
	RunOnInstanceId *string `mandatory:"true" json:"runOnInstanceId"`

	// The script name and arguments.
	// Example: `/usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3`
	ScriptCommand *string `mandatory:"true" json:"scriptCommand"`

	// The userid on the instance to be used for executing the script or command.
	// Example: `opc`
	RunAsUser *string `mandatory:"false" json:"runAsUser"`
}

func (m UpdateRunLocalScriptUserDefinedStepDetails) String() string {
	return common.PointerString(m)
}

// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m UpdateRunLocalScriptUserDefinedStepDetails) ValidateEnumValue() (bool, error) {
	errMessage := []string{}

	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// MarshalJSON marshals to json representation
func (m UpdateRunLocalScriptUserDefinedStepDetails) MarshalJSON() (buff []byte, e error) {
	type MarshalTypeUpdateRunLocalScriptUserDefinedStepDetails UpdateRunLocalScriptUserDefinedStepDetails
	s := struct {
		DiscriminatorParam string `json:"stepType"`
		MarshalTypeUpdateRunLocalScriptUserDefinedStepDetails
	}{
		"RUN_LOCAL_SCRIPT",
		(MarshalTypeUpdateRunLocalScriptUserDefinedStepDetails)(m),
	}

	return json.Marshal(&s)
}