| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| administrativeState |
The administrative status of the scheduled task.
type=schedule.AdministrativeStatus default=disabled Displayed(tab/group)=Administrative State |
| dateLastRun |
The date of the last run.
type=Date access=read-only Displayed(tab/group)=Date Last Run |
| description |
The description of the scheduled task.
type=string default= minimum=0 maximum=254 Displayed(tab/group)=Scheduled Task Description |
| displayedName |
The name of the scheduled task.
type=string default= minimum=1 maximum=32 Displayed(tab/group)=Scheduled Task Name |
| executionStatus |
The execution status of the scheduled task.
type=schedule.ExecutionStatus access=read-only default=none Displayed(tab/group)=Execution Status |
| id |
type=long access=read-create default=0 minimum=1 Displayed(tab/group)=ID |
| nmUser |
The detailed full name of a NFM-P user who created the scheduled task.
type=string access=read-only default= minimum=0 maximum=255 |
| nmUserName |
The login name of a NFM-P user who created the scheduled task.
type=string access=read-only default= minimum=0 maximum=40 Displayed(tab/group)=Assigned User |
| numberDelayed |
The number of delaying for a scheduled task.
type=long access=read-only default=0 Displayed(tab/group)=Number of Delayed Runs |
| numberFailure |
The number of failure for a scheduled task.
type=long access=read-only default=0 Displayed(tab/group)=Number of Failed Runs |
| numberSkipped |
The number of skipping for a scheduled task.
type=long access=read-only default=0 Displayed(tab/group)=Number of Skipped Runs |
| resultPointer |
Pointer to the instance of the result from the scheduled task.
type=Pointer access=read-only |
| schedulePointer |
Pointer to the instance of the schedule.
type=Pointer access=read-create Mandatory on create Displayed(tab/group)=Schedule |
| scheduledObjectPointer |
Pointer to the instance of the scheduled task.
type=Pointer access=read-create Mandatory on create Displayed(tab/group)=Task |
| spanObjectPointer |
A pointer to the spanEnabled task object.
type=string access=read-only default= minimum=0 maximum=252 |
| status |
The status of the scheduled task.
type=schedule.Status access=read-only default=notRunning Displayed(tab/group)=Status |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false