@nutanix-scratch/monitoring-js-client 4.0.1-beta.1 → 4.0.1

package/dist/es/models/monitoring/v4/serviceability/LogCollectionSpec.d.ts

@@ -0,0 +1,178 @@
+/**
+ * The LogCollectionSpec model module.
+ * @module Ntnx/LogCollectionSpec
+ * @version 4.0.1
+ * @class LogCollectionSpec
+ *
+ * @param { Date } startTime The time marking the start of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The start time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+ *
+ * @param { Date } endTime The time marking the end of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The end time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+ *
+ * @param { ArchiveOpts } archiveOpts
+ */
+export default class LogCollectionSpec {
+    /**
+     * Constructs a <code>LogCollectionSpec</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:Ntnx/LogCollectionSpec} obj Optional instance to populate.
+     * @param callFromChild {Boolean} Flag to recognise calling instance
+     * @return {module:Ntnx/LogCollectionSpec} The populated <code>LogCollectionSpec</code> instance.
+     */
+    static constructFromObject(data: any, obj?: any, callFromChild?: boolean): any;
+    /**
+    * Converts a given snake_case string to camelCase.
+    * @param {string} snakeStr - The input string in snake_case format.
+    * @returns {string} - The converted string in camelCase format.
+    */
+    static snakeToCamel(snakeStr: string): string;
+    /**
+     * Constructs a new <code>LogCollectionSpec</code>.
+     * Input parameters for collecting logs.
+     * @alias module:Ntnx/LogCollectionSpec
+     *
+     * @param { Date } startTime The time marking the start of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The start time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+     *
+     * @param { Date } endTime The time marking the end of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The end time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+     *
+     * @param { ArchiveOpts } archiveOpts
+    */
+    constructor(startTime: Date, endTime: Date, archiveOpts: ArchiveOpts);
+    startTime: Date;
+    endTime: Date;
+    archiveOpts: ArchiveOpts;
+    $objectType: string;
+    /** @type {object<string, any>} */
+    $reserved: object;
+    /** @type {object<string, any>} */
+    $unknownFields: object;
+    /**
+     * Returns The time marking the start of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The start time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+     * @return {Date}
+     */
+    getStartTime(): Date;
+    /**
+     * Sets The time marking the start of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The start time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+     * @param {Date} startTime The time marking the start of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The start time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+     */
+    setStartTime(startTime: Date): void;
+    /**
+     * Returns The time marking the end of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The end time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+     * @return {Date}
+     */
+    getEndTime(): Date;
+    /**
+     * Sets The time marking the end of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The end time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+     * @param {Date} endTime The time marking the end of a log collection window. It should be in the following format:  YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+HH:MM or YYYY-MM-DDTHH:MM:SS-HH:MM. The end time of log collection should be within the past three months. For example: - 1985-04-12T23:20:50.52Z represents 20 minutes and 50.52 seconds after the 23rd hour of   April 12th, 1985 in UTC. - 1996-12-19T16:39:57-08:00 represents 39 minutes and 57 seconds after the 16th hour   of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).   Note that this is equivalent to 1996-12-20T00:39:57Z in UTC.
+     */
+    setEndTime(endTime: Date): void;
+    /**
+     * Returns Collect items associated with the tag IDs. The tag ID can be fetched from the GET tags operation. If no tags are specified, all items will be collected by default, which will take a longer time. It is recommended that at least one tag is selected.
+     * @return {string[]}
+     */
+    getIncludeTags(): string[];
+    /**
+     * Sets Collect items associated with the tag IDs. The tag ID can be fetched from the GET tags operation. If no tags are specified, all items will be collected by default, which will take a longer time. It is recommended that at least one tag is selected.
+     * @param {string[]} includeTags Collect items associated with the tag IDs. The tag ID can be fetched from the GET tags operation. If no tags are specified, all items will be collected by default, which will take a longer time. It is recommended that at least one tag is selected.
+     */
+    setIncludeTags(includeTags: string[]): void;
+    includeTags: string[];
+    /**
+     * Returns Indicates whether to mask sensitive data in the collected logs or not.
+     * @return {boolean}
+     */
+    getShouldAnonymize(): boolean;
+    /**
+     * Sets Indicates whether to mask sensitive data in the collected logs or not.
+     * @param {boolean} shouldAnonymize Indicates whether to mask sensitive data in the collected logs or not.
+     */
+    setShouldAnonymize(shouldAnonymize: boolean): void;
+    shouldAnonymize: boolean;
+    /**
+     * Returns List of node IP addresses from where the logs will be collected.
+     * @return {IPv4Address[]}
+     */
+    getNodeIpList(): IPv4Address[];
+    /**
+     * Sets List of node IP addresses from where the logs will be collected.
+     * @param {IPv4Address[]} nodeIpList List of node IP addresses from where the logs will be collected.
+     */
+    setNodeIpList(nodeIpList: IPv4Address[]): void;
+    nodeIpList: IPv4Address[];
+    /**
+     * Returns Indicates whether to collect logs from a node where services are down or not. This feature is not supported on PC.
+     * @return {boolean}
+     */
+    getShouldCollectFromDisabledNode(): boolean;
+    /**
+     * Sets Indicates whether to collect logs from a node where services are down or not. This feature is not supported on PC.
+     * @param {boolean} shouldCollectFromDisabledNode Indicates whether to collect logs from a node where services are down or not. This feature is not supported on PC.
+     */
+    setShouldCollectFromDisabledNode(shouldCollectFromDisabledNode: boolean): void;
+    shouldCollectFromDisabledNode: boolean;
+    /**
+     * Returns Exclude items associated with the tag IDs. The tag ID can be fetched from the GET tags operation.
+     * @return {string[]}
+     */
+    getExcludeTags(): string[];
+    /**
+     * Sets Exclude items associated with the tag IDs. The tag ID can be fetched from the GET tags operation.
+     * @param {string[]} excludeTags Exclude items associated with the tag IDs. The tag ID can be fetched from the GET tags operation.
+     */
+    setExcludeTags(excludeTags: string[]): void;
+    excludeTags: string[];
+    /**
+     * @return {ArchiveOpts}
+     */
+    getArchiveOpts(): ArchiveOpts;
+    /**
+     * @param {ArchiveOpts} archiveOpts
+     */
+    setArchiveOpts(archiveOpts: ArchiveOpts): void;
+    /**
+     * Returns Description to be attached with the associated log collection task.
+     * @return {string}
+     */
+    getDescription(): string;
+    /**
+     * Sets Description to be attached with the associated log collection task.
+     * @param {string} description Description to be attached with the associated log collection task.
+     */
+    setDescription(description: string): void;
+    description: string;
+    get$Reserved(): any;
+    get$ObjectType(): string;
+    get$UnknownFields(): any;
+    toJson(forMutation: any): {
+        $reserved: any;
+        $objectType: string;
+        $unknownFields: any;
+        description?: string;
+        archiveOpts?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            uploadParams?: any;
+            archiveName?: string;
+        };
+        excludeTags?: string[];
+        shouldCollectFromDisabledNode?: boolean;
+        nodeIpList?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            prefixLength?: number;
+            value?: string;
+        }[];
+        shouldAnonymize?: boolean;
+        includeTags?: string[];
+        endTime?: any;
+        startTime?: any;
+    };
+    validate(scope: any, properties: any, ...args: any[]): Promise<any>;
+    validateProperty(scope: any, property: any): ValidationError;
+    #private;
+}
+import ArchiveOpts from "./ArchiveOpts";
+import IPv4Address from "../../../common/v1/config/IPv4Address";
+import ValidationError from "../../../validation/ValidationError";