Package com.oracle.bmc.disasterrecovery.model

Class RunObjectStoreScriptUserDefinedStep

java.lang.Object

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

com.oracle.bmc.disasterrecovery.model.DrPlanUserDefinedStep

com.oracle.bmc.disasterrecovery.model.RunObjectStoreScriptUserDefinedStep

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

Run Object Store Script step details.
Note: Objects should always be created or deserialized using the RunObjectStoreScriptUserDefinedStep.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 RunObjectStoreScriptUserDefinedStep.Builder, which maintain a set of all explicitly set fields called RunObjectStoreScriptUserDefinedStep.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	Description
static class	RunObjectStoreScriptUserDefinedStep.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	Description
RunObjectStoreScriptUserDefinedStep(String runOnInstanceId, String runOnInstanceRegion, ObjectStorageScriptLocation objectStorageScriptLocation, String scriptCommand, String runAsUser)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static RunObjectStoreScriptUserDefinedStep.Builder	builder()	Create a new builder.
boolean	equals(Object o)
ObjectStorageScriptLocation	getObjectStorageScriptLocation()
String	getRunAsUser()	The user ID on the instance that will be used to execute the script specified in ‘scriptCommand’.
String	getRunOnInstanceId()	The OCID of the instance on which this script or command should be executed.
String	getRunOnInstanceRegion()	The region of the instance where this script or command should be executed.
String	getScriptCommand()	The entire path and arguments for the script that is stored in object store, or inside a compressed archive in object store.
int	hashCode()
RunObjectStoreScriptUserDefinedStep.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

RunObjectStoreScriptUserDefinedStep

@Deprecated
public RunObjectStoreScriptUserDefinedStep(String runOnInstanceId,
                                           String runOnInstanceRegion,
                                           ObjectStorageScriptLocation objectStorageScriptLocation,
                                           String scriptCommand,
                                           String runAsUser)

Deprecated.

Method Detail

builder

public static RunObjectStoreScriptUserDefinedStep.Builder builder()

Create a new builder.

toBuilder

public RunObjectStoreScriptUserDefinedStep.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 of the instance where this script or command should be executed.

Example: us-ashburn-1

Returns:

the value

getObjectStorageScriptLocation

public ObjectStorageScriptLocation getObjectStorageScriptLocation()

getScriptCommand

public String getScriptCommand()

The entire path and arguments for the script that is stored in object store, or inside a compressed archive in object store.

Example: /usr/bin/python3.7 scripts/start_server.py –port 8080 –env “production” –max-connections 200 –log-level “INFO”

Returns:

the value

getRunAsUser

public String getRunAsUser()

The user ID on the instance that will be used to execute the script specified in ‘scriptCommand’.

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