Overview Package Class Deprecated Help

analytics
AnalyticsManager

This is the container for all Analytics rules.

public class AnalyticsManager

Properties
analyticReportRetention

type=long
default=30
minimum=1
maximum=720
units=days
analytics.AnalyticsRule-Set type=Children-Set
enableAnalyticReportPurge Flag to enable analytic report purge

type=boolean
default=false
lastReportPurgeCutoffTime Shows the last Report Purge Cutoff Time.

type=Date
access=read-only
default=0
lastReportPurgeTime Shows the last Report Purge Time.

type=Date
access=read-only
default=0
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

isAnalyticalBaseEnabled

Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
isAnalyticalBaseEnabled : boolean -

isPremiumPkgEnabled

Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
isPremiumPkgEnabled : boolean -

purgeAnalyticReports

This method is supposed to purge Analytic Reports based on the value configured for analyticReportRetention attribute.
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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
analytics.AnalyticsManager.purgeAnalyticReportsException