Hadoop_Counter_API.md

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

Counter

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

/* No public constructor. */

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

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

/**
 * Get the name of the counter.
 *
 * @returns {number}
 */
Counter.prototype.getValue = function () { /* ... */ };

/**
 * Increment this counter by the given value
 *
 * @param {number} value - The amount to increment by
 *
 * @returns {Counter} this
 */
Counter.prototype.increment = function (value) { /* ... */ };

/**
 * Set this counter by the given value.
 *
 * @param {number} value - The value to set
 *
 * @returns {Counter} this
 */
Counter.prototype.setValue = function (value) { /* ... */ };