/** * The Report model module. * @module Ntnx/Report * @version 4.1.1-beta-1 * @class Report * @extends ExternalizableAbstractModel * * @param { string } name Report instance name * * @param { string } configExtId UUID for the report configuration for which report needs to be generated. * * @param { Date } startTime UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection start point. Eg:- 2023-10-23 11:34:45 * * @param { Date } endTime UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection end point. Eg:- 2023-10-23 11:34:45 */ export default class Report extends ExternalizableAbstractModel { /** * Constructs a new Report. * @alias module:Ntnx/Report * @extends module:Ntnx/ExternalizableAbstractModel * * @param { string } name Report instance name * * @param { string } configExtId UUID for the report configuration for which report needs to be generated. * * @param { Date } startTime UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection start point. Eg:- 2023-10-23 11:34:45 * * @param { Date } endTime UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection end point. Eg:- 2023-10-23 11:34:45 */ constructor(name: string, configExtId: string, startTime: Date, endTime: Date); name: string; configExtId: string; startTime: Date; endTime: Date; /** * Returns Report instance name * @return {string} */ getName(): string; /** * Sets Report instance name * @param {string} name Report instance name */ setName(name: string): void; /** * Returns Description of the report. This will be part of generated report. * @return {string} */ getDescription(): string; /** * Sets Description of the report. This will be part of generated report. * @param {string} description Description of the report. This will be part of generated report. */ setDescription(description: string): void; description: string; /** * Returns UUID for the report configuration for which report needs to be generated. * @return {string} */ getConfigExtId(): string; /** * Sets UUID for the report configuration for which report needs to be generated. * @param {string} configExtId UUID for the report configuration for which report needs to be generated. */ setConfigExtId(configExtId: string): void; /** * Returns Generated report saved or not * @return {boolean} */ getIsPersistent(): boolean; /** * Sets Generated report saved or not * @param {boolean} isPersistent Generated report saved or not */ setIsPersistent(isPersistent: boolean): void; isPersistent: boolean; /** * Returns List specifying the formats in which report is to be created. This overrides the supportedFormats defined in the report configuration. * @return {ReportFormat[]} */ getOverrideSupportedFormats(): ReportFormat[]; /** * Sets List specifying the formats in which report is to be created. This overrides the supportedFormats defined in the report configuration. * @param {ReportFormat[]} overrideSupportedFormats List specifying the formats in which report is to be created. This overrides the supportedFormats defined in the report configuration. */ setOverrideSupportedFormats(overrideSupportedFormats: ReportFormat[]): void; overrideSupportedFormats: ReportFormat[]; /** * Returns UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection start point. Eg:- 2023-10-23 11:34:45 * @return {Date} */ getStartTime(): Date; /** * Sets UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection start point. Eg:- 2023-10-23 11:34:45 * @param {Date} startTime UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection start point. Eg:- 2023-10-23 11:34:45 */ setStartTime(startTime: Date): void; /** * Returns UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection end point. Eg:- 2023-10-23 11:34:45 * @return {Date} */ getEndTime(): Date; /** * Sets UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection end point. Eg:- 2023-10-23 11:34:45 * @param {Date} endTime UTC date and time in \"%Y-%m-%d %H:%M:%S\" format for data collection end point. Eg:- 2023-10-23 11:34:45 */ setEndTime(endTime: Date): void; /** * Returns List specifying the formats in which the report is to be sent. * @return {ReportFormat[]} */ getRecipientFormats(): ReportFormat[]; /** * Sets List specifying the formats in which the report is to be sent. * @param {ReportFormat[]} recipientFormats List specifying the formats in which the report is to be sent. */ setRecipientFormats(recipientFormats: ReportFormat[]): void; recipientFormats: ReportFormat[]; /** * Returns Recipients in addition to the ones specified on the report configuration. * @return {Recipient[]} */ getRecipients(): Recipient[]; /** * Sets Recipients in addition to the ones specified on the report configuration. * @param {Recipient[]} recipients Recipients in addition to the ones specified on the report configuration. */ setRecipients(recipients: Recipient[]): void; recipients: Recipient[]; /** * Returns Time in ISO 8601 format when the report instance was created. * @return {Date} */ getCreationTime(): Date; /** * Sets Time in ISO 8601 format when the report instance was created. * @param {Date} creationTime Time in ISO 8601 format when the report instance was created. */ setCreationTime(creationTime: Date): void; creationTime: Date; /** * Returns Timezone in which report is to be generated. This is the list supported by pytz.all_timezones. For more info, check http://pytz.sourceforge.net * @return {string} */ getTimezone(): string; /** * Sets Timezone in which report is to be generated. This is the list supported by pytz.all_timezones. For more info, check http://pytz.sourceforge.net * @param {string} timezone Timezone in which report is to be generated. This is the list supported by pytz.all_timezones. For more info, check http://pytz.sourceforge.net */ setTimezone(timezone: string): void; timezone: string; /** * @return {EntitySelection} */ getEntitySelection(): EntitySelection; /** * @param {EntitySelection} entitySelection */ setEntitySelection(entitySelection: EntitySelection): void; entitySelection: EntitySelection; /** * Returns Owner UUID for the report instance.\" * @return {string} */ getOwnerExtId(): string; /** * Sets Owner UUID for the report instance.\" * @param {string} ownerExtId Owner UUID for the report instance.\" */ setOwnerExtId(ownerExtId: string): void; ownerExtId: string; /** * Returns List of formats in which report generation was successful. * @return {ReportFormat[]} */ getAvailableFormats(): ReportFormat[]; /** * Sets List of formats in which report generation was successful. * @param {ReportFormat[]} availableFormats List of formats in which report generation was successful. */ setAvailableFormats(availableFormats: ReportFormat[]): void; availableFormats: ReportFormat[]; #private; } import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel"; import EntitySelection from "./EntitySelection";