com.oracle.bmc.disasterrecovery.model

Class RunLocalScriptUserDefinedStep

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.disasterrecovery.model.DrPlanUserDefinedStep

com.oracle.bmc.disasterrecovery.model.RunLocalScriptUserDefinedStep

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220125")
public final class RunLocalScriptUserDefinedStep
extends DrPlanUserDefinedStep

Run Local Script step details.
Note: Objects should always be created or deserialized using the RunLocalScriptUserDefinedStep.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the RunLocalScriptUserDefinedStep.Builder, which maintain a set of all explicitly set fields called RunLocalScriptUserDefinedStep.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunLocalScriptUserDefinedStep.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.disasterrecovery.model.DrPlanUserDefinedStep

DrPlanUserDefinedStep.StepType

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
RunLocalScriptUserDefinedStep(String runOnInstanceId, String runOnInstanceRegion, String scriptCommand, String runAsUser) Deprecated.

Method Summary

Modifier and Type	Method and Description
static RunLocalScriptUserDefinedStep.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getRunAsUser() The userid on the instance to be used for executing the script or command.
String	getRunOnInstanceId() The OCID of the instance on which this script or command should be executed.
String	getRunOnInstanceRegion() The region in which the instance is present.
String	getScriptCommand() The script name and arguments.
int	hashCode()
RunLocalScriptUserDefinedStep.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RunLocalScriptUserDefinedStep

@Deprecated
public RunLocalScriptUserDefinedStep(String runOnInstanceId,
                                                 String runOnInstanceRegion,
                                                 String scriptCommand,
                                                 String runAsUser)

Deprecated.

Method Detail

builder

public static RunLocalScriptUserDefinedStep.Builder builder()

Create a new builder.

toBuilder

public RunLocalScriptUserDefinedStep.Builder toBuilder()

getRunOnInstanceId

public String getRunOnInstanceId()

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

Returns:

the value

getRunOnInstanceRegion

public String getRunOnInstanceRegion()

The region in which the instance is present.

Example: us-ashburn-1

Returns:

the value

getScriptCommand

public String getScriptCommand()

The script name and arguments.

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

Returns:

the value

getRunAsUser

public String getRunAsUser()

The userid on the instance to be used for executing the script or command.

Example: opc

Returns:

the value

toString

public String toString()

Overrides:

toString in class DrPlanUserDefinedStep

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class DrPlanUserDefinedStep

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class DrPlanUserDefinedStep

hashCode

public int hashCode()

Overrides:

hashCode in class DrPlanUserDefinedStep