Overview Package Class Deprecated Help

fm
AlarmHistoryDatabase

public class AlarmHistoryDatabase

Properties
administrativeState

type=int
default=1
Displayed(tab/group)=Administrative State
enums=
    1: up - Up
    2: down - Down
currentPartitionId Indicates which partition new alarm history object are associated with.

type=int
access=read-only
default=1
currentPartitionSize Indicates the number of alarm history objects in the current partition.

type=int
access=read-only
default=0
lastLogTime Indicates the last time an alarm history object was created.

type=Date
access=read-only
default=0
logOnChange

type=boolean
default=false
Displayed(tab/group)=Log On Change
logOnDeletion

type=boolean
default=true
Displayed(tab/group)=Log On Deletion
maxDailySize Indicates the maximum number of alarms logged in a single partition. Alarm history objects are kept in 31 partitions. Every 24 hours at midnight UTC or when the number of alarm history objects in a partition reaches the maxDailySize (whichever comes first), the oldest partition is deleted and a new partition is created for new alarm history objects.

type=long
default=300000
units=records
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

configure

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.
config : config(fm.AlarmHistoryDatabase) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
fm.AlarmHistoryDatabase.configureException

getLog

Input Parameters:
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:
logInfo : summary(fm.AlarmHistoryDatabase) -

getLogRecords

Input Parameters:
filter : FilterHolder -
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:
logInfo : List (generic.CommonManagedEntityInformation) -

purge

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.
type : log.LogPurgeType -
recordFilter : FilterHolder -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false