Hadoop_CounterGroup_API.md

The purpose of the Counter object is to provide programmatic access to the Hadoop CounterGroup object. Below is a list of exposed object properties.

CounterGroup

For example usage of all available APIs, please see the unit tests.

/* No public constructor. */

/**
 * Find counter by name or create one with the given name.
 *
 * @param {string} name - The name of the counter to find or create
 *
 * @returns {Counter}
 */
CounterGroup.prototype.findCounter = function (name) { /* ... */ };

/**
 * Get the display name of the group.
 *
 * @returns {string}
 */
CounterGroup.prototype.getDisplayName = function () { /* ... */ };

/**
 * Get the name of the group.
 *
 * @returns {string}
 */
CounterGroup.prototype.getName = function () { /* ... */ };

/**
 * Increments multiple counters by their amounts in another CounterGroup instance.
 *
 * @param {CounterGroup} other - The other group of counters
 *
 * @returns {CounterGroup} this
 */
CounterGroup.prototype.incrAllCounters = function (other) { /* ... */ };

/**
 * Returns the number of counters in this group.
 *
 * @returns {number}
 */
CounterGroup.prototype.size = function () { /* ... */ };