InvokeFunctionUserDefinedCustomPrecheckStep¶

class oci.disaster_recovery.models.InvokeFunctionUserDefinedCustomPrecheckStep(**kwargs)¶

Bases: oci.disaster_recovery.models.dr_plan_user_defined_step.DrPlanUserDefinedStep

Invoke Oracle function User Defined custom precheck step details.

Attributes

`STEP_TYPE_INVOKE_FUNCTION`	str(object=’’) -> str
`STEP_TYPE_INVOKE_FUNCTION_PRECHECK`	str(object=’’) -> str
`STEP_TYPE_INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK`	str(object=’’) -> str
`STEP_TYPE_RUN_LOCAL_SCRIPT`	str(object=’’) -> str
`STEP_TYPE_RUN_LOCAL_SCRIPT_PRECHECK`	str(object=’’) -> str
`STEP_TYPE_RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK`	str(object=’’) -> str
`STEP_TYPE_RUN_OBJECTSTORE_SCRIPT`	str(object=’’) -> str
`STEP_TYPE_RUN_OBJECTSTORE_SCRIPT_PRECHECK`	str(object=’’) -> str
`STEP_TYPE_RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK`	str(object=’’) -> str
`function_id`	[Required] Gets the function_id of this InvokeFunctionUserDefinedCustomPrecheckStep.
`function_region`	[Required] Gets the function_region of this InvokeFunctionUserDefinedCustomPrecheckStep.
`request_body`	Gets the request_body of this InvokeFunctionUserDefinedCustomPrecheckStep.
`step_type`	[Required] Gets the step_type of this DrPlanUserDefinedStep.

Methods

`__init__`(**kwargs)	Initializes a new InvokeFunctionUserDefinedCustomPrecheckStep object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

STEP_TYPE_INVOKE_FUNCTION = 'INVOKE_FUNCTION'¶

STEP_TYPE_INVOKE_FUNCTION_PRECHECK = 'INVOKE_FUNCTION_PRECHECK'¶

STEP_TYPE_INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK = 'INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK'¶

STEP_TYPE_RUN_LOCAL_SCRIPT = 'RUN_LOCAL_SCRIPT'¶

STEP_TYPE_RUN_LOCAL_SCRIPT_PRECHECK = 'RUN_LOCAL_SCRIPT_PRECHECK'¶

STEP_TYPE_RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK = 'RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK'¶

STEP_TYPE_RUN_OBJECTSTORE_SCRIPT = 'RUN_OBJECTSTORE_SCRIPT'¶

STEP_TYPE_RUN_OBJECTSTORE_SCRIPT_PRECHECK = 'RUN_OBJECTSTORE_SCRIPT_PRECHECK'¶

STEP_TYPE_RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK = 'RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK'¶

__init__(**kwargs)¶

Initializes a new InvokeFunctionUserDefinedCustomPrecheckStep object with values from keyword arguments. The default value of the step_type attribute of this class is INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

step_type (str) – The value to assign to the step_type property of this InvokeFunctionUserDefinedCustomPrecheckStep. 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”, “RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK”, “RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK”, “INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK”
function_id (str) – The value to assign to the function_id property of this InvokeFunctionUserDefinedCustomPrecheckStep.
function_region (str) – The value to assign to the function_region property of this InvokeFunctionUserDefinedCustomPrecheckStep.
request_body (str) – The value to assign to the request_body property of this InvokeFunctionUserDefinedCustomPrecheckStep.

function_id¶

[Required] Gets the function_id of this InvokeFunctionUserDefinedCustomPrecheckStep. The OCID of function to be invoked.

Example: ocid1.fnfunc.oc1..uniqueID

Returns:	The function_id of this InvokeFunctionUserDefinedCustomPrecheckStep.
Return type:	str

function_region¶

[Required] Gets the function_region of this InvokeFunctionUserDefinedCustomPrecheckStep. The region in which the function is deployed.

Example: us-ashburn-1

Returns:	The function_region of this InvokeFunctionUserDefinedCustomPrecheckStep.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

request_body¶

Gets the request_body of this InvokeFunctionUserDefinedCustomPrecheckStep. The request body for the function.

Example: { “FnParam1”, “FnParam2” }

Returns:	The request_body of this InvokeFunctionUserDefinedCustomPrecheckStep.
Return type:	str

step_type¶

[Required] Gets the step_type of this DrPlanUserDefinedStep. The type of the user-defined step.

RUN_OBJECTSTORE_SCRIPT_PRECHECK - A built-in step which performs a precheck on a script stored

in OCI object storage. This step cannot be added, deleted, or customized by the user.

RUN_LOCAL_SCRIPT_PRECHECK - A built-in step which performs a precheck on a script which resides

locally on a compute instance. This step cannot be added, deleted, or customized by the user.

INVOKE_FUNCTION_PRECHECK - A built-in step which performs a precheck on an OCI function. This

step cannot be added, deleted, or customized by the user. See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.

RUN_OBJECTSTORE_SCRIPT - A step which runs a script stored in OCI object storage.

RUN_LOCAL_SCRIPT - A step which runs a script that resides locally on a compute instance.

INVOKE_FUNCTION - A step which invokes an OCI function.

See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.

RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK - A user-defined step which performs a precheck by executing a user-provided script stored

in OCI object storage.

RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK - A user-defined step which performs a precheck by executing a user-provided script which resides

locally on a compute instance.

INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK - A user-defined step which performs a precheck by executing a user-provided OCI function.

See https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm.

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”, “RUN_OBJECTSTORE_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK”, “RUN_LOCAL_SCRIPT_USER_DEFINED_CUSTOM_PRECHECK”, “INVOKE_FUNCTION_USER_DEFINED_CUSTOM_PRECHECK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The step_type of this DrPlanUserDefinedStep.
Return type:	str