@nutanix-scratch/opsmgmt-js-client 4.0.1

package/dist/lib/models/opsmgmt/v4/config/ReportConfig.d.ts

@@ -0,0 +1,264 @@
+/**
+ * The ReportConfig model module.
+ * @module Ntnx/ReportConfig
+ * @version 4.0.1
+ * @class ReportConfig
+ * @extends ExternalizableAbstractModel
+ *
+ * @param { string } name Name of the report configuration.
+ *
+ * @param { Section[] } sections List of sections in the report.
+ */
+export default class ReportConfig extends ExternalizableAbstractModel {
+    /**
+     * Constructs a new <code>ReportConfig</code>.
+     * @alias module:Ntnx/ReportConfig
+     * @extends module:Ntnx/ExternalizableAbstractModel
+     *
+     * @param { string } name Name of the report configuration.
+     *
+     * @param { Section[] } sections List of sections in the report.
+    */
+    constructor(name: string, sections: Section[]);
+    name: string;
+    sections: Section[];
+    /**
+     * Returns Name of the report configuration.
+     * @return {string}
+     */
+    getName(): string;
+    /**
+     * Sets Name of the report configuration.
+     * @param {string} name Name of the report configuration.
+     */
+    setName(name: string): void;
+    /**
+     * Returns Description of the report configuration.
+     * @return {string}
+     */
+    getDescription(): string;
+    /**
+     * Sets Description of the report configuration.
+     * @param {string} description Description of the report configuration.
+     */
+    setDescription(description: string): void;
+    description: string;
+    /**
+     * @return {ReportSchedule}
+     */
+    getSchedule(): ReportSchedule;
+    /**
+     * @param {ReportSchedule} schedule
+     */
+    setSchedule(schedule: ReportSchedule): void;
+    schedule: ReportSchedule;
+    /**
+     * @return {RetentionConfig}
+     */
+    getRetentionConfig(): RetentionConfig;
+    /**
+     * @param {RetentionConfig} retentionConfig
+     */
+    setRetentionConfig(retentionConfig: RetentionConfig): void;
+    retentionConfig: RetentionConfig;
+    /**
+     * Returns List of sections in the report.
+     * @return {Section[]}
+     */
+    getSections(): Section[];
+    /**
+     * Sets List of sections in the report.
+     * @param {Section[]} sections List of sections in the report.
+     */
+    setSections(sections: Section[]): void;
+    /**
+     * Returns List specifying the formats in which the report will be created.
+     * @return {ReportFormat[]}
+     */
+    getSupportedFormats(): ReportFormat[];
+    /**
+     * Sets List specifying the formats in which the report will be created.
+     * @param {ReportFormat[]} supportedFormats List specifying the formats in which the report will be created.
+     */
+    setSupportedFormats(supportedFormats: ReportFormat[]): void;
+    supportedFormats: ReportFormat[];
+    /**
+     * Returns The timezone in which the report will be generated. This is the list supported by pytz.all_timezones. For more info, check http://pytz.sourceforge.net
+     * @return {string}
+     */
+    getTimezone(): string;
+    /**
+     * Sets The timezone in which the report will be generated. This is the list supported by pytz.all_timezones. For more info, check http://pytz.sourceforge.net
+     * @param {string} timezone The timezone in which the report will 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 {NotificationPolicy}
+     */
+    getNotificationPolicy(): NotificationPolicy;
+    /**
+     * @param {NotificationPolicy} notificationPolicy
+     */
+    setNotificationPolicy(notificationPolicy: NotificationPolicy): void;
+    notificationPolicy: any;
+    /**
+     * Returns Flag specifying if the report configuration is pre-defined.
+     * @return {boolean}
+     */
+    getIsSystemDefined(): boolean;
+    /**
+     * Sets Flag specifying if the report configuration is pre-defined.
+     * @param {boolean} isSystemDefined Flag specifying if the report configuration is pre-defined.
+     */
+    setIsSystemDefined(isSystemDefined: boolean): void;
+    isSystemDefined: boolean;
+    /**
+     * Returns Flag specifying if the report configuration is private.
+     * @return {boolean}
+     */
+    getIsPrivate(): boolean;
+    /**
+     * Sets Flag specifying if the report configuration is private.
+     * @param {boolean} isPrivate Flag specifying if the report configuration is private.
+     */
+    setIsPrivate(isPrivate: boolean): void;
+    isPrivate: boolean;
+    /**
+     * Returns Flag specifying if the report configuration is imported.
+     * @return {boolean}
+     */
+    getIsImported(): boolean;
+    /**
+     * Sets Flag specifying if the report configuration is imported.
+     * @param {boolean} isImported Flag specifying if the report configuration is imported.
+     */
+    setIsImported(isImported: boolean): void;
+    isImported: boolean;
+    /**
+     * Returns Time in ISO 8601 format when the report configuration was created.
+     * @return {Date}
+     */
+    getCreationTime(): Date;
+    /**
+     * Sets Time in ISO 8601 format when the report configuration was created.
+     * @param {Date} creationTime Time in ISO 8601 format when the report configuration was created.
+     */
+    setCreationTime(creationTime: Date): void;
+    creationTime: Date;
+    /**
+     * Returns Offset for start time for data collection during report generation.
+     * @return {Number}
+     */
+    getStartTimeOffsetSecs(): number;
+    /**
+     * Sets Offset for start time for data collection during report generation.
+     * @param {Number} startTimeOffsetSecs Offset for start time for data collection during report generation.
+     */
+    setStartTimeOffsetSecs(startTimeOffsetSecs: number): void;
+    startTimeOffsetSecs: number;
+    /**
+     * Returns Offset for end time for data collection during report generation.
+     * @return {Number}
+     */
+    getEndTimeOffsetSecs(): number;
+    /**
+     * Sets Offset for end time for data collection during report generation.
+     * @param {Number} endTimeOffsetSecs Offset for end time for data collection during report generation.
+     */
+    setEndTimeOffsetSecs(endTimeOffsetSecs: number): void;
+    endTimeOffsetSecs: number;
+    /**
+     * @return {ReportCustomization}
+     */
+    getReportCustomization(): ReportCustomization;
+    /**
+     * @param {ReportCustomization} reportCustomization
+     */
+    setReportCustomization(reportCustomization: ReportCustomization): void;
+    reportCustomization: any;
+    /**
+     * @return {EntityType}
+     */
+    getDefaultSectionEntityType(): EntityType;
+    /**
+     * @param {EntityType} defaultSectionEntityType
+     */
+    setDefaultSectionEntityType(defaultSectionEntityType: EntityType): void;
+    defaultSectionEntityType: string;
+    toJson(forMutation: any): {
+        $reserved: any;
+        $objectType: string;
+        $unknownFields: any;
+        tenantId?: string;
+        links?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            rel?: string;
+            href?: string;
+        }[];
+        extId?: string;
+        defaultSectionEntityType?: string;
+        reportCustomization?: any;
+        endTimeOffsetSecs?: number;
+        startTimeOffsetSecs?: number;
+        creationTime?: any;
+        isImported?: boolean;
+        isPrivate?: boolean;
+        isSystemDefined?: boolean;
+        notificationPolicy?: any;
+        timezone?: string;
+        supportedFormats?: ReportFormat[];
+        sections?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            timeFilter?: string;
+            repeatCriteria?: {
+                $reserved: any;
+                $objectType: string;
+                $unknownFields: any;
+                repetitionRule?: string;
+                entityType?: string;
+            };
+            rows?: {
+                $reserved: any;
+                $objectType: string;
+                $unknownFields: any;
+                widgets?: {
+                    $reserved: any;
+                    $objectType: string;
+                    $unknownFields: any;
+                    widgetInfo?: any;
+                }[];
+            }[];
+            description?: string;
+            name?: string;
+        }[];
+        retentionConfig?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            retentionCount?: number;
+            retentionPeriodSeconds?: number;
+        };
+        schedule?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            endTime?: any;
+            startTime?: any;
+            frequency?: number;
+            scheduleInterval?: string;
+        };
+        description?: string;
+        name?: string;
+    };
+    #private;
+}
+import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel";
+import Section from "./Section";
+import ReportSchedule from "./ReportSchedule";
+import RetentionConfig from "./RetentionConfig";
+import EntityType from "./EntityType";