system.mes.meter.unscheduleMeterRecordPruning

Description

Cancels all scheduled meter record pruning by clearing the toBePruned flag on all meter records. Use this method to reverse a scheduleMeterRecordPruning() call before the next nightly maintenance window runs.

Permissions

This method requires the METERING (Admin) permission.

Syntax

system.mes.meter.unscheduleMeterRecordPruning()

Parameters

This method takes no parameters.

Returns

This method does not return a value.

Code Examples

# Cancel all scheduled pruning
system.mes.meter.unscheduleMeterRecordPruning()
print "All scheduled meter record pruning has been cancelled."