@dynatrace-sdk/client-classic-environment-v2 1.0.4 → 1.2.2

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

@@ -18,7 +18,15 @@ export declare class MetricsClient {
      * Gets the descriptor of the specified metric
      *
      * **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await metricsClient.metric({
+     *   metricKey: "...",
+     * });
      */
     metric(config: {
         /**
@@ -33,6 +41,13 @@ export declare class MetricsClient {
      * Deletes the specified metric
      *
      * **Required scope:** environment-api:metrics:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>Deletion cannot be undone! You can't delete a metric if it has data points ingested within the last two hours.
+     *
+     * @example <caption>Code example</caption>
+     * import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await metricsClient.delete({
+     *   metricKey: "...",
+     * });
      */
     delete(config: {
         /** The key of the required metric. */ metricKey: string;
@@ -48,7 +63,21 @@ export declare class MetricsClient {
      * 1. Specify the number of results per page in the **pageSize** query parameter.
      *
      * 2. Then use the cursor from the **nextPageKey** field of the response in the **nextPageKey** query parameter to obtain subsequent pages. All other query parameters must be omitted.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await metricsClient.allMetrics({
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     *   metricSelector: "...",
+     *   text: "...",
+     *   fields: "...",
+     *   writtenSince: "...",
+     *   metadataSelector: "...",
+     * });
      */
     allMetrics(config: {
         /**
@@ -154,6 +183,8 @@ export declare class MetricsClient {
          * * `dimensionKey("dimkey-1","dimkey-2")`. The filtering applies only to dimensions that were written within the last 14 days.
          * * `custom("true")`. "true" to include only user-defined metrics metrics (without namespace or with `ext:`, `calc:`, `func:`, `appmon:`), "false" to filter them out.
          *
+         * * `exported("true")`. "true" to include only exported metrics, "false" to filter them out.
+         *
          * To set several criteria, separate them with a comma (`,`). For example, `tags("feature","cloud"),unit("Percent"),dimensionKey("location"),custom("true")`. Only results matching **all** criteria are included in response.
          *
          * For example, to list metrics that have the tags **feature** AND **cloud** with a unit of **Percent** OR **MegaByte** AND a dimension with a dimension key **location**, use this **metadataSelector**: `tags("feature"),unit("Percent","MegaByte"),tags("cloud"),dimensionKey("location")`.
@@ -172,7 +203,20 @@ export declare class MetricsClient {
      *
      * The **dataPointCountRatio** specifies the ratio of queried data points divided by the maximum number of data points per metric that are allowed in a single query.
      * The **dimensionCountRatio** specifies the ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await metricsClient.query({
+     *   metricSelector: "...",
+     *   resolution: "...",
+     *   from: "...",
+     *   to: "...",
+     *   entitySelector: "...",
+     *   mzSelector: "...",
+     * });
      */
     query(config: {
         /**
@@ -307,7 +351,15 @@ export declare class MetricsClient {
      * Pushes metric data points to Dynatrace
      *
      * **Required scope:** storage:metrics:write<br/>**Required permission:** storage:metrics:write
+     *
      * @returns The provided metric data points are accepted and will be processed in the background.
+     *
+     * @example <caption>Code example</caption>
+     * import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await metricsClient.ingest({
+     *   body: "server.cpu.temperature,cpu.id=0 42" as string,
+     * });
      */
     ingest(config: {
         body: string;

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

@@ -17,7 +17,18 @@ export declare class MetricsUnitsClient {
      * Converts a value from a source unit into a target unit
      *
      * **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>If no target unit is set, the request finds an appropriate target unit automatically, taking into account the preferred number format (if specified).
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await metricsUnitsClient.convert({
+     *   unitId: "...",
+     *   value: 123,
+     *   targetUnit: "...",
+     *   numberFormat: "...",
+     * });
      */
     convert(config: {
         /** The ID of the source unit. */ unitId: string;
@@ -41,7 +52,15 @@ export declare class MetricsUnitsClient {
      * Gets the properties of the specified unit
      *
      * **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await metricsUnitsClient.unit({
+     *   unitId: "...",
+     * });
      */
     unit(config: {
         unitId: string;
@@ -51,7 +70,16 @@ export declare class MetricsUnitsClient {
      * Lists all available units
      *
      * **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>You can narrow down the output by providing filter criteria in the **unitSelector** field.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await metricsUnitsClient.allUnits({
+     *   unitSelector: "...",
+     *   fields: "...",
+     * });
      */
     allUnits(config?: {
         /**

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

@@ -30,7 +30,21 @@ export declare class MonitoredEntitiesClient {
      * You can limit the output by using pagination:
      * 1. Specify the number of results per page in the **pageSize** query parameter.
      * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await monitoredEntitiesClient.getEntities({
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     *   entitySelector: "...",
+     *   from: "...",
+     *   to: "...",
+     *   fields: "...",
+     *   sort: "...",
+     * });
      */
     getEntities(config?: {
         /**
@@ -138,7 +152,18 @@ export declare class MonitoredEntitiesClient {
      * Gets the properties of the specified monitored entity
      *
      * **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await monitoredEntitiesClient.getEntity({
+     *   entityId: "...",
+     *   from: "...",
+     *   to: "...",
+     *   fields: "...",
+     * });
      */
     getEntity(config: {
         /** The ID of the required entity. */ entityId: string;
@@ -191,7 +216,15 @@ export declare class MonitoredEntitiesClient {
      * Gets a list of properties for the specified entity type
      *
      * **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await monitoredEntitiesClient.getEntityType({
+     *   type: "...",
+     * });
      */
     getEntityType(config: {
         /** The required entity type. */ type: string;
@@ -203,7 +236,16 @@ export declare class MonitoredEntitiesClient {
      * **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>You can limit the output by using pagination:
      * 1. Specify the number of results per page in the **pageSize** query parameter.
      * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await monitoredEntitiesClient.getEntityTypes({
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     * });
      */
     getEntityTypes(config?: {
         /**
@@ -226,7 +268,15 @@ export declare class MonitoredEntitiesClient {
      * Creates or updates a custom device
      *
      * **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await monitoredEntitiesClient.pushCustomDevice(
+     *   { body: {} as CustomDeviceCreation }
+     * );
      */
     pushCustomDevice(config: {
         body: CustomDeviceCreation;

package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts

@@ -18,7 +18,18 @@ export declare class MonitoredEntitiesCustomTagsClient {
      * Gets a list of custom tags applied to the specified entities
      *
      * **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Automatically applied tags and imported tags are not included.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await monitoredEntitiesCustomTagsClient.getTags({
+     *     entitySelector: "...",
+     *     from: "...",
+     *     to: "...",
+     *   });
      */
     getTags(config: {
         /**
@@ -98,7 +109,19 @@ export declare class MonitoredEntitiesCustomTagsClient {
      * Adds custom tags to the specified entities
      *
      * **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>All existing tags remain unaffected.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await monitoredEntitiesCustomTagsClient.postTags({
+     *     entitySelector: "...",
+     *     from: "...",
+     *     to: "...",
+     *     body: {} as AddEntityTags,
+     *   });
      */
     postTags(config: {
         body: AddEntityTags;
@@ -179,7 +202,21 @@ export declare class MonitoredEntitiesCustomTagsClient {
      * Deletes the specified tag from the specified entities
      *
      * **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await monitoredEntitiesCustomTagsClient.deleteTags({
+     *     key: "...",
+     *     value: "...",
+     *     deleteAllWithKey: true,
+     *     entitySelector: "...",
+     *     from: "...",
+     *     to: "...",
+     *   });
      */
     deleteTags(config: {
         /**

package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts

@@ -15,7 +15,16 @@ export declare class MonitoredEntitiesMonitoringStateClient {
      * Lists monitoring states of entities
      *
      * **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Only process group instances are supported.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { monitoredEntitiesMonitoringStateClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await monitoredEntitiesMonitoringStateClient.getStates({
+     *     entitySelector: "...",
+     *   });
      */
     getStates(config: {
         /**

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

@@ -20,7 +20,15 @@ export declare class NetworkZonesClient {
      * Gets parameters of the specified network zone
      *
      * **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await networkZonesClient.getSingleNetworkZone({
+     *   id: "...",
+     * });
      */
     getSingleNetworkZone(config: {
         /** The ID of the required network zone. */ id: string;
@@ -32,7 +40,17 @@ export declare class NetworkZonesClient {
      * **Required scope:** environment-api:network-zones:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>If the network zone with the specified ID does not exist, a new network zone is created.
      *
      *  The ID is not case sensitive. Dynatrace stores the ID in lowercase.
+     *
      * @returns Success. The new network zone has been created. The response body contains the ID of the new network zone.
+     *
+     * @example <caption>Code example</caption>
+     * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await networkZonesClient.createOrUpdateNetworkZone({
+     *     id: "...",
+     *     body: {} as NetworkZone,
+     *   });
      */
     createOrUpdateNetworkZone(config: {
         body: NetworkZone;
@@ -51,6 +69,13 @@ export declare class NetworkZonesClient {
      * **Required scope:** environment-api:network-zones:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).
      *
      *  If the network zone is used as an alternative zone for any OneAgent, it will be automatically removed from the list of possible alternatives.
+     *
+     * @example <caption>Code example</caption>
+     * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await networkZonesClient.deleteNetworkZone({
+     *   id: "...",
+     * });
      */
     deleteNetworkZone(config: {
         /** The ID of the network zone to be deleted. */ id: string;
@@ -60,14 +85,29 @@ export declare class NetworkZonesClient {
      * Lists all existing network zones
      *
      * **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await networkZonesClient.getAllNetworkZones();
      */
     getAllNetworkZones(abortSignal?: AbortSignal): Promise<NetworkZoneList>;
     /**
      * Gets the statistics about hosts using the network zone
      *
      * **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await networkZonesClient.getHostStats({
+     *   id: "...",
+     *   filter: {} as GetHostStatsQueryFilter,
+     * });
      */
     getHostStats(config: {
         /** The ID of the required network zone. */ id: string;
@@ -88,13 +128,28 @@ export declare class NetworkZonesClient {
      * Gets the global configuration of network zones
      *
      * **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await networkZonesClient.getNetworkZoneSettings();
      */
     getNetworkZoneSettings(abortSignal?: AbortSignal): Promise<NetworkZoneSettings>;
     /**
      * Updates the global configuration of network zones
      *
      * **Required scope:** environment-api:network-zones:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await networkZonesClient.updateNetworkZoneSettings({
+     *     body: {} as NetworkZoneSettings,
+     *   });
      */
     updateNetworkZoneSettings(config: {
         body: NetworkZoneSettings;

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

@@ -21,7 +21,16 @@ export declare class ProblemsClient {
      * Closes the specified problem and adds a closing comment on it
      *
      * **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await problemsClient.closeProblem({
+     *   problemId: "...",
+     *   body: {} as ProblemCloseRequestDtoImpl,
+     * });
      */
     closeProblem(config: {
         body: ProblemCloseRequestDtoImpl;
@@ -32,7 +41,17 @@ export declare class ProblemsClient {
      * Gets all comments on the specified problem
      *
      * **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await problemsClient.getComments({
+     *   problemId: "...",
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     * });
      */
     getComments(config: {
         /** The ID of the required problem. */ problemId: string;
@@ -56,6 +75,14 @@ export declare class ProblemsClient {
      * Adds a new comment on the specified problem
      *
      * **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await problemsClient.createComment({
+     *   problemId: "...",
+     *   body: {} as CommentRequestDtoImpl,
+     * });
      */
     createComment(config: {
         body: CommentRequestDtoImpl;
@@ -66,7 +93,16 @@ export declare class ProblemsClient {
      * Gets the specified comment on a problem
      *
      * **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await problemsClient.getComment({
+     *   problemId: "...",
+     *   commentId: "...",
+     * });
      */
     getComment(config: {
         /** The ID of the required problem. */ problemId: string;
@@ -77,6 +113,15 @@ export declare class ProblemsClient {
      * Updates the specified comment on a problem
      *
      * **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await problemsClient.updateComment({
+     *   problemId: "...",
+     *   commentId: "...",
+     *   body: {} as CommentRequestDtoImpl,
+     * });
      */
     updateComment(config: {
         body: CommentRequestDtoImpl;
@@ -88,6 +133,14 @@ export declare class ProblemsClient {
      * Deletes the specified comment from a problem
      *
      * **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await problemsClient.deleteComment({
+     *   problemId: "...",
+     *   commentId: "...",
+     * });
      */
     deleteComment(config: {
         /** The ID of the required problem. */ problemId: string;
@@ -98,7 +151,16 @@ export declare class ProblemsClient {
      * Gets the properties of the specified problem
      *
      * **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await problemsClient.getProblem({
+     *   problemId: "...",
+     *   fields: "...",
+     * });
      */
     getProblem(config: {
         /** The ID of the required problem. */ problemId: string;
@@ -119,7 +181,22 @@ export declare class ProblemsClient {
      * Lists problems observed within the specified timeframe
      *
      * **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await problemsClient.getProblems({
+     *   fields: "...",
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     *   from: "...",
+     *   to: "...",
+     *   problemSelector: "...",
+     *   entitySelector: "...",
+     *   sort: "...",
+     * });
      */
     getProblems(config?: {
         /**

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

@@ -15,7 +15,21 @@ export declare class ReleasesClient {
      * Returns all releases
      *
      * **Required scope:** environment-api:releases:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { releasesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await releasesClient.getReleases({
+     *   from: "...",
+     *   to: "...",
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     *   demo: true,
+     *   releasesSelector: "...",
+     *   sort: "...",
+     * });
      */
     getReleases(config?: {
         /**