@factset/sdk-portfolioreportingbatcher/dist/model/JobOverridesCombinationsRoot.js

Portfolio Reporting Batcher client library for JavaScript

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
var _JobOverridesCombinationsRootDateRange = _interopRequireDefault(require("./JobOverridesCombinationsRootDateRange"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
/**
 * Portfolio Reporting Batcher
 * The Portfolio Reporting Batcher (PRB) API allows clients to systematically leverage functionalities of the PRB application.
 *
 * The version of the OpenAPI document: 1.0.0
 * Contact: api@factset.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 *
 */

/**
 * The JobOverridesCombinationsRoot model module.
 * @module model/JobOverridesCombinationsRoot
 */
class JobOverridesCombinationsRoot {
  /**
   * Constructs a new <code>JobOverridesCombinationsRoot</code>.
   * This creates a matrix of the given details. When the job is run, it will only run for the accounts, dates and/or tasks within the objects given. Dates can be specified either by giving individual dates in the &#x60;dates&#x60; parameter, or by using the &#x60;dateRange&#x60; parameter for where these are supported. The job will fail if both are provided. (Settings will only be used temporarily and no changes will be made to the default PRB job.) Certain parameters are only valid for certain job types. Please see below for more details.
   * @alias module:model/JobOverridesCombinationsRoot
   */
  constructor() {
    JobOverridesCombinationsRoot.initialize(this);
  }

  /**
   * Initializes the fields of this object.
   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
   * Only for internal use.
   */
  static initialize(obj) {}

  /**
   * Constructs a <code>JobOverridesCombinationsRoot</code> from a plain JavaScript object, optionally creating a new instance.
   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
   * @param {Object} data The plain JavaScript object bearing properties of interest.
   * @param {module:model/JobOverridesCombinationsRoot} obj Optional instance to populate.
   * @return {module:model/JobOverridesCombinationsRoot} The populated <code>JobOverridesCombinationsRoot</code> instance.
   */
  static constructFromObject(data, obj) {
    if (data) {
      obj = obj || new JobOverridesCombinationsRoot();
      if (data.hasOwnProperty('accounts')) {
        obj['accounts'] = _ApiClient.default.convertToType(data['accounts'], ['String']);
      }
      if (data.hasOwnProperty('dates')) {
        obj['dates'] = _ApiClient.default.convertToType(data['dates'], ['Date']);
      }
      if (data.hasOwnProperty('dateRange')) {
        obj['dateRange'] = _JobOverridesCombinationsRootDateRange.default.constructFromObject(data['dateRange']);
      }
      if (data.hasOwnProperty('tasks')) {
        obj['tasks'] = _ApiClient.default.convertToType(data['tasks'], ['String']);
      }
      if (data.hasOwnProperty('allTasks')) {
        obj['allTasks'] = _ApiClient.default.convertToType(data['allTasks'], 'Boolean');
      }
    }
    return obj;
  }
}

/**
 * An array of accounts, used for jobs types ADF, PUB, and Vault
 * @member {Array.<String>} accounts
 */
JobOverridesCombinationsRoot.prototype['accounts'] = undefined;

/**
 * An array of dates, used for jobs types ADF, PUB, and Vault. Please see OA Page 20650 for more details
 * @member {Array.<Date>} dates
 */
JobOverridesCombinationsRoot.prototype['dates'] = undefined;

/**
 * @member {module:model/JobOverridesCombinationsRootDateRange} dateRange
 */
JobOverridesCombinationsRoot.prototype['dateRange'] = undefined;

/**
 * Used only for jobs where type is ADF, PA, PUB, or vault
 * @member {Array.<String>} tasks
 */
JobOverridesCombinationsRoot.prototype['tasks'] = undefined;

/**
 * boolean flag to indicate if all tasks for given ADF, PA, PUB, or vault job should be run, e.g. if account is newly created and not yet added to any tasks
 * @member {Boolean} allTasks
 */
JobOverridesCombinationsRoot.prototype['allTasks'] = undefined;
var _default = exports.default = JobOverridesCombinationsRoot;