/*
* Copyright 2016 IBM Corp.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
(function () {
var JavaWrapper = require(EclairJS_Globals.NAMESPACE + '/JavaWrapper');
var Logger = require(EclairJS_Globals.NAMESPACE + '/Logger');
var Utils = require(EclairJS_Globals.NAMESPACE + '/Utils');
var logger = Logger.getLogger("SparkStatusTracker_js");
/**
* Low-level status reporting APIs for monitoring job and stage progress.
*
* These APIs intentionally provide very weak consistency semantics; consumers of these APIs should
* be prepared to handle empty / missing information. For example, a job's stage ids may be known
* but the status API may not have any information about the details of those stages, so
* `getStageInfo` could potentially return `None` for a valid stage id.
*
* To limit memory usage, these APIs only provide information on recent jobs / stages. These APIs
* will provide information for the last `spark.ui.retainedStages` stages and
* `spark.ui.retainedJobs` jobs.
*
* NOTE: this class's constructor should be considered private and may be subject to change.
* @classdesc
* @constructor
* @memberof module:eclairjs
*/
var SparkStatusTracker = function (jvmObject) {
JavaWrapper.call(this, jvmObject);
};
SparkStatusTracker.prototype = Object.create(JavaWrapper.prototype);
SparkStatusTracker.prototype.constructor = SparkStatusTracker;
/**
* Return a list of all known jobs in a particular job group. If `jobGroup` is `null`, then
* returns all known jobs that are not associated with a job group.
*
* The returned list may contain running, failed, and completed jobs, and may vary across
* invocations of this method. This method does not guarantee the order of the elements in
* its result.
* @param {string}
* @returns {number[]}
*/
SparkStatusTracker.prototype.getJobIdsForGroup = function (jobGroup) {
return this.getJavaObject().getJobIdsForGroup(jobGroup);
};
/**
* Returns an array containing the ids of all active stages.
*
* This method does not guarantee the order of the elements in its result.
* @returns {number[]}
*/
SparkStatusTracker.prototype.getActiveStageIds = function () {
return this.getJavaObject().getActiveStageIds();
};
/**
* Returns an array containing the ids of all active jobs.
*
* This method does not guarantee the order of the elements in its result.
* @returns {number[]}
*/
SparkStatusTracker.prototype.getActiveJobIds = function () {
return this.getJavaObject().getActiveJobIds();
};
/**
* Returns job information, or `None` if the job info could not be found or was garbage collected.
* @param {number}
* @returns {module:eclairjs.SparkJobInfo}
*/
SparkStatusTracker.prototype.getJobInfo = function (jobId) {
var javaObject = this.getJavaObject().getJobInfo(jobId);
return Utils.javaToJs(javaObject);
};
/**
* Returns stage information, or `None` if the stage info could not be found or was
* garbage collected.
* @param {number}
* @returns {module:eclairjs.SparkStageInfo}
*/
SparkStatusTracker.prototype.getStageInfo = function (stageId) {
var javaObject = this.getJavaObject().getStageInfo(stageId);
return Utils.javaToJs(javaObject);
};
module.exports = SparkStatusTracker;
})();