nge
NGEScheduledTask



public class NGEScheduledTask

Properties
averageCleanupTime Average time of the rekey cleanup (seconds)

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Average Rekey Cleanup Time (Rekey Times/Cleanup Times)

averageTime Average time of the rekey (seconds)

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Average Rekey Time (Rekey Times/Rekey Times)

longestCleanupTime Longest rekey cleanup time (seconds)

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Longest Rekey Cleanup Time (Rekey Times/Cleanup Times)

longestTime Longest rekey time (seconds)

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Longest Rekey Time (Rekey Times/Rekey Times)

nextCleanupTime Next Rekey Cleanup Time.

type=Date
access=read-only
Displayed(tab/group)=Next Cleanup Run

nextStartDate Next Start Date.

type=Date
access=read-only
Displayed(tab/group)=Next Run

nge.NGEScheduledTaskResult-Set type=Children-Set
nge.RekeyProgress-Set type=Children-Set
numberCleanupFailure The number failed for the cleanup task.

type=long
access=read-only
default=0
Displayed(tab/group)=Failed Cleanup Runs

numberCleanupSkipped The number skipped for the cleanup task.

type=long
access=read-only
default=0
Displayed(tab/group)=Skipped Cleanup Runs

shortestCleanupTime Shortest rekey cleanup time (seconds)

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Shortest Rekey Cleanup Time (Rekey Times/Cleanup Times)

shortestTime Shortest rekey time (seconds)

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Shortest Rekey Time (Rekey Times/Rekey Times)

totalWaitTime Total ReKey time (seconds) which is the waitTime * number of nodes to rekey.

type=double
access=read-only
default=0
units=seconds
Displayed(tab/group)=Total Inter-Nodal Rekey Wait Time

waitTime Extra wait time when Rekeying (seconds)

type=double
default=0
minimum=0
maximum=30
units=seconds
Displayed(tab/group)=Inter-Nodal Rekey Wait Time

 
Overridden Properties
id The scheduled task ID.

default=1
maximum=1000

 
Properties inherited from schedule.ScheduledTask
administrativeState, dateLastRun, description, displayedName, executionStatus, id, nmUser, nmUserName, numberDelayed, numberFailure, numberSkipped, resultPointer, schedulePointer, scheduledObjectPointer, spanObjectPointer, status
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

getRekeyProgress

DEPRECATED - 18.12 - use 'getRekeyProgressInfo' instead
Retrieve the rekey progress.
Input Parameters:
ngeScheduledTaskFullName : string - The list of NGEScheduledTask full names.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
rekeyResult : nge.RekeyResultStruct -
Exceptions:
nge.NGEScheduledTask.getRekeyProgressException

getRekeyProgressInfo

Retrieve the rekey progress info.
Input Parameters:
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.
ngeScheduledTaskFullName : string - The NGEScheduledTask full names.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
rekeyProcessFdn : string -

resetRekeyTimes

Input Parameters:
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

startManualRekey

This method start the rekey process immediately
Input Parameters:
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.
aInForceRekey : boolean - Specifiy if this is a manual force rekey or not
aInProgressiveRekey : boolean - Specifiy if this is a manual progressive rekey or not
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

startRekey

DEPRECATED - 18.6 - use 'startManualRekey' instead
This method start the rekey scheduled process immediately
Input Parameters:
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.
aInManualForceRekey : boolean - Specifiy if this is a manual force rekey or not
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Methods inherited from schedule.ScheduledTask
shutDown, start, stop, turnUp