Scripting Object - VcScheduledTask

Scripting-object corresponding to
ScheduledTask
Attribute of
VcEventFilterSpec, VcScheduledTaskEventArgument, VcScheduledTaskInfo, VcScheduledTaskManager, VcTaskFilterSpec, VcTaskReasonSchedule
Returned by
createObjectScheduledTask, createScheduledTask, retrieveEntityScheduledTask, retrieveObjectScheduledTask

Scripting Object Description

The scheduled task object.

Attributes

Name Type Description
availableFieldVcCustomFieldDef []

@since VI API 2.5
idString

@since Unknown
infoVcScheduledTaskInfo

@since VI API 2.5
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
valueVcCustomFieldValue []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, reconfigureScheduledTask, removeScheduledTask, runScheduledTask, setCustomValue

_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

runScheduledTask

Runs the scheduled task immediately. The schedule for future runs remains in effect. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

removeScheduledTask

Removes the scheduled task. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

reconfigureScheduledTask

Reconfigures the scheduled task properties. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcScheduledTaskSpec


Return Value

Type Description
None

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None