Scripting Object - VcWorkflowStepHandler

Scripting-object corresponding to
WorkflowStepHandler
Attribute of
VcWorkflowStepHandlerInfo

Scripting Object Description

Handler for a step in the workflow

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, executeStep, finalizeStep, undoStep

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

executeStep

Execute the step in the workflow Execution of this call requires the same privileges as the operation, specified by {@link Context#wsdlMethodName}, of which this is a step. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcContext


Return Value

Type Description
VcWorkflowStepHandlerResult

undoStep

On abort/failure of a workflow, this method would be invoked. Execution of this call requires the same privileges as the operation, specified by {@link Context#wsdlMethodName}, of which this is a step. Note on exception handling behavior when processing result of executeStep() for non-mandatory steps: case 1: Exception is returned in com.vmware.vim.binding.vim.modularity.WorkflowStepHandler.Result.fault attribute -- honor it and start rollback and hence an explicit call to undoStep(). case 2: Exceptions encountered in the remote method call - those returned by Future.get() -- Ignore and continue to next step. -- if the step succeeds at step handler's end, then undoing it is the handler's responsibility. It shouldn't rely on explicit undoStep() call, since it won't be called if all the following steps succeed. -- undoStep() might still be called if another step handler failed later on in the workflow; even after the non-mandatory step handler has already done undo in executeStep(). case 3: All other java.lang.Exception not falling under case 1 or 2, result in rollback and hence an explicit undoStep() call. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcContext

arg1VcLocalizedMethodFault


Return Value

Type Description
None

finalizeStep

Invoked for a step that has relative location of 'Around' after another step. It is called for both success and failure cases. Execution of this call requires the same privileges as the operation, specified by {@link Context#wsdlMethodName}, of which this is a step. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcContext

arg1VcLocalizedMethodFault


Return Value

Type Description
None