@dynatrace-sdk/client-classic-environment-v2 1.4.2 → 1.6.0

package/types/packages/client/classic-environment-v2/src/lib/apis/unified-analysis-api.d.ts

@@ -0,0 +1,670 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { GetListScreenDefinition_1QueryUiContext } from '../models/get-list-screen-definition-1-query-ui-context';
+import { GetListScreenDefinition_2Body } from '../models/get-list-screen-definition-2-body';
+import { GetScreenDefinition_1QueryUiContext } from '../models/get-screen-definition-1-query-ui-context';
+import { GetScreenDefinitionQueryUiContext } from '../models/get-screen-definition-query-ui-context';
+import { UACorrelationCandidatesInputDto } from '../models/ua-correlation-candidates-input-dto';
+import { UAEntityScreenDefinition } from '../models/ua-entity-screen-definition';
+import { UAEntityScreenInput } from '../models/ua-entity-screen-input';
+import { UAListScreenDefinition } from '../models/ua-list-screen-definition';
+import { UAReleasedEntity } from '../models/ua-released-entity';
+import { UAReleasedEntityTypes } from '../models/ua-released-entity-types';
+import { UAScreenDefinitionResponseDto } from '../models/ua-screen-definition-response-dto';
+/**
+ * Read entity page definition
+ */
+export declare class UnifiedAnalysisClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a UnifiedAnalysisClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const unifiedAnalysisClientNodeJs = new UnifiedAnalysisClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Provides the correlation candidates of a metric | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.getCorrelationCandidates({
+     *     body: { metricExpression: "..." },
+     *   });
+     */
+    getCorrelationCandidates(config: {
+        body: UACorrelationCandidatesInputDto;
+        /** Value of `Content-Type` header. Leave it blank to use default `Content-Type` for `UACorrelationCandidatesInputDto` type */ type?: string;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of three days is used (`now-3d`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<UAEntityScreenDefinition>;
+    /**
+     * Download UA configuration stored in Settings 2.0. | maturity=EARLY_ADOPTER
+     *
+     * **One of the following scopes is required:**
+     * + unified-analysis:screen-definition:read
+     * + settings:objects:read
+     *
+     * <br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Ok - download file
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await unifiedAnalysisClient.downloadConfig({
+     *   scopeClass: "...",
+     *   scopeIdentifier: "...",
+     * });
+     */
+    downloadConfig(config: {
+        /** Settings 2.0 scope class. */ scopeClass: string;
+        /** Settings 2.0 scope identifier. */ scopeIdentifier: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Provide a screen definition for a given monitored entity and a screen type | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.getSingleEntityScreenDefinition(
+     *     { body: { entityId: "..." } },
+     *   );
+     */
+    getSingleEntityScreenDefinition(config: {
+        body: UAEntityScreenInput;
+        /** Value of `Content-Type` header. Leave it blank to use default `Content-Type` for `UAEntityScreenInput` type */ type?: string;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of three days is used (`now-3d`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<UAEntityScreenDefinition>;
+    /**
+     * Provide a list screen definition for a given monitored entity type | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.getListScreenDefinition({
+     *     body: { entityId: "..." },
+     *   });
+     */
+    getListScreenDefinition(config: {
+        body: UAEntityScreenInput;
+        /** Value of `Content-Type` header. Leave it blank to use default `Content-Type` for `UAEntityScreenInput` type */ type?: string;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of three days is used (`now-3d`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<UAListScreenDefinition>;
+    /**
+     * Provide a list screen definition for a given monitored entity type | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.getListScreenDefinition_1({
+     *     entityType: "...",
+     *   });
+     */
+    getListScreenDefinition_1(config: {
+        /** The entity type. */ entityType: string;
+        /** A optional list screen state state id */ stateId?: string;
+        /** If true, screen config will be taken from settings, overriding default one. No effect for custom screens. */ useLocalConfig?: boolean;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of three days is used (`now-3d`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        /** A list of screen markers expressions */ screenMarker?: string[];
+        /** Time zone offset for markers time formatting */ timezone?: string;
+        /** UI context of a request */ uiContext?: GetListScreenDefinition_1QueryUiContext;
+        abortSignal?: AbortSignal;
+    }): Promise<UAListScreenDefinition>;
+    /**
+     * Stored the provided list screen state and returns a screen state id that can be used to read the state date again | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.storeListScreenState({
+     *     entityType: "...",
+     *     stateId: "...",
+     *     body: "...",
+     *   });
+     */
+    storeListScreenState(config: {
+        body: string;
+        /** Value of `Content-Type` header. Leave it blank to use default `Content-Type` for `string` type */ type?: string;
+        /** The entity type. */ entityType: string;
+        /** The screen state id that should be stored */ stateId: string;
+        /** A list of screen markers expressions */ screenMarker?: string[];
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Provide a list screen definition for a given monitored entity and a screen type | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.getListScreenDefinition_2({
+     *     entityType: "...",
+     *     screenType: "...",
+     *     body: GetListScreenDefinition_2Body.Classic,
+     *   });
+     */
+    getListScreenDefinition_2(config: {
+        body: GetListScreenDefinition_2Body;
+        /** Value of `Content-Type` header. Leave it blank to use default `Content-Type` for `GetListScreenDefinition_2Body` type */ type?: string;
+        /** The entity type. */ entityType: string;
+        /** The screen type. If not specified default is used */ screenType: string;
+        /** A optional screen state state id */ stateId?: string;
+        /** A optional me sub type */ meSubType?: string;
+        /** If true, screen config will be taken from settings, overriding default one. No effect for custom screens. */ useLocalConfig?: boolean;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of three days is used (`now-3d`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        /** A list of screen markers expressions */ screenMarker?: string[];
+        /** Time zone offset for markers time formatting */ timezone?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<UAListScreenDefinition>;
+    /**
+     * Stored the provided list screen state and returns a screen state id that can be used to read the state date again | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.storeListScreenState_1({
+     *     entityType: "...",
+     *     screenType: "...",
+     *     stateId: "...",
+     *     body: "...",
+     *   });
+     */
+    storeListScreenState_1(config: {
+        body: string;
+        /** Value of `Content-Type` header. Leave it blank to use default `Content-Type` for `string` type */ type?: string;
+        /** The entity type. */ entityType: string;
+        /** The screen type. If not specified default is used */ screenType: string;
+        /** The screen state id that should be stored */ stateId: string;
+        /** A list of screen markers expressions */ screenMarker?: string[];
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Provide a list of entity types that are released and navigation should lead to UA page | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.getReleasedEntityTypes();
+     */
+    getReleasedEntityTypes(abortSignal?: AbortSignal): Promise<UAReleasedEntityTypes>;
+    /**
+     * Provide information if entity is released and entity navigation should lead to UA page | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await unifiedAnalysisClient.isEntityReleased({
+     *   entityId: "...",
+     * });
+     */
+    isEntityReleased(config: {
+        /** The ID of the required entity. */ entityId: string;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of three days is used (`now-3d`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<UAReleasedEntity>;
+    /**
+     * Provide a screen definition schema for given entity type | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.getScreenDefinitionSchema({
+     *     entityType: "...",
+     *   });
+     */
+    getScreenDefinitionSchema(config: {
+        /** The entity type. */ entityType: string;
+        abortSignal?: AbortSignal;
+    }): Promise<UAScreenDefinitionResponseDto>;
+    /**
+     * Sync settings 2.0 UA configuration with one stored in cluster json files. | maturity=EARLY_ADOPTER
+     *
+     * **One of the following scopes is required:**
+     * + unified-analysis:screen-definition:read
+     * + settings:objects:write
+     * + settings:objects:read
+     *
+     * <br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await unifiedAnalysisClient.syncConfig({
+     *   scopeClass: "...",
+     *   scopeIdentifier: "...",
+     * });
+     */
+    syncConfig(config: {
+        /** Settings 2.0 scope class. */ scopeClass: string;
+        /** Settings 2.0 scope identifier. */ scopeIdentifier: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Provide a screen definition for a given monitored entity | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.getScreenDefinition({
+     *     entityId: "...",
+     *   });
+     */
+    getScreenDefinition(config: {
+        /** The ID of the required entity. */ entityId: string;
+        /** A optional screen state state id */ stateId?: string;
+        /** If true, screen config will be taken from settings, overriding default one. No effect for custom screens. */ useLocalConfig?: boolean;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of three days is used (`now-3d`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        /** A list of screen markers expressions */ screenMarker?: string[];
+        /** Time zone offset for markers time formatting */ timezone?: string;
+        /** UI context of a request */ uiContext?: GetScreenDefinitionQueryUiContext;
+        abortSignal?: AbortSignal;
+    }): Promise<UAEntityScreenDefinition>;
+    /**
+     * Stored the provided screen state and returns a screen state id that can be used to read the state date again | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await unifiedAnalysisClient.storeScreenState({
+     *   entityId: "...",
+     *   stateId: "...",
+     *   body: "...",
+     * });
+     */
+    storeScreenState(config: {
+        body: string;
+        /** Value of `Content-Type` header. Leave it blank to use default `Content-Type` for `string` type */ type?: string;
+        /** The ID of the required entity. */ entityId: string;
+        /** The screen state id that should be stored */ stateId: string;
+        /** A list of screen markers expressions */ screenMarker?: string[];
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Provide a screen definition for a given monitored entity and a screen type | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await unifiedAnalysisClient.getScreenDefinition_1({
+     *     entityId: "...",
+     *     screenType: "...",
+     *   });
+     */
+    getScreenDefinition_1(config: {
+        /** The ID of the required entity. */ entityId: string;
+        /** The screen type. If not specified default is used */ screenType: string;
+        /** A optional screen state state id */ stateId?: string;
+        /** If true, screen config will be taken from settings, overriding default one. No effect for custom screens. */ useLocalConfig?: boolean;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of three days is used (`now-3d`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        /** A list of screen markers expressions */ screenMarker?: string[];
+        /** Time zone offset for markers time formatting */ timezone?: string;
+        /** UI context of a request */ uiContext?: GetScreenDefinition_1QueryUiContext;
+        abortSignal?: AbortSignal;
+    }): Promise<UAEntityScreenDefinition>;
+    /**
+     * Stored the provided screen state and returns a screen state id that can be used to read the state date again | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** unified-analysis:screen-definition:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { unifiedAnalysisClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await unifiedAnalysisClient.storeScreenState_1(
+     *   {
+     *     entityId: "...",
+     *     screenType: "...",
+     *     stateId: "...",
+     *     body: "...",
+     *   },
+     * );
+     */
+    storeScreenState_1(config: {
+        body: string;
+        /** Value of `Content-Type` header. Leave it blank to use default `Content-Type` for `string` type */ type?: string;
+        /** The ID of the required entity. */ entityId: string;
+        /** The screen type. If not specified default is used */ screenType: string;
+        /** The screen state id that should be stored */ stateId: string;
+        /** A list of screen markers expressions */ screenMarker?: string[];
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+}
+export declare const unifiedAnalysisClient: UnifiedAnalysisClient;