@dynatrace-sdk/client-classic-environment-v2 1.2.4 → 1.4.0

package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.d.ts

@@ -4,12 +4,12 @@ import { SettingsValue } from './settings-value';
  * The response to a creation- or update-request.
  */
 export interface SettingsObjectResponse {
-    invalidValue?: SettingsValue;
-    error?: Error;
     /**
      * The HTTP status code for the object.
      */
     code: number;
+    error?: Error;
+    invalidValue?: SettingsValue;
     /**
      * For a successful request, the ID of the created or modified settings object.
      */

package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.transformation.d.ts

@@ -2,9 +2,9 @@ import * as _ErrorTransformation from './error.transformation';
 import { SettingsObjectResponse } from './settings-object-response';
 import * as _SettingsValueTransformation from './settings-value.transformation';
 export interface AsJson {
-    invalidValue?: _SettingsValueTransformation.AsJson;
-    error?: _ErrorTransformation.AsJson;
     code: number;
+    error?: _ErrorTransformation.AsJson;
+    invalidValue?: _SettingsValueTransformation.AsJson;
     objectId?: string;
 }
 export declare function fromJson($model: AsJson): SettingsObjectResponse;

package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts

@@ -3,19 +3,6 @@ import { SettingsValue } from './settings-value';
  * An update of a settings object.
  */
 export interface SettingsObjectUpdate {
-    value: SettingsValue;
-    /**
-     * The version of the schema on which the object is based.
-     */
-    schemaVersion?: string;
-    /**
-     * The update token of the object. You can use it to detect simultaneous modifications by different users.
-     *
-     * It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
-     *
-     * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
-     */
-    updateToken?: string;
     /**
      * The position of the updated object. The new object will be moved behind the specified one.
      *
@@ -40,4 +27,17 @@ export interface SettingsObjectUpdate {
      * Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
      */
     insertBefore?: string;
+    /**
+     * The version of the schema on which the object is based.
+     */
+    schemaVersion?: string;
+    /**
+     * The update token of the object. You can use it to detect simultaneous modifications by different users.
+     *
+     * It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
+     *
+     * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
+     */
+    updateToken?: string;
+    value: SettingsValue;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.transformation.d.ts

@@ -1,11 +1,11 @@
 import { SettingsObjectUpdate } from './settings-object-update';
 import * as _SettingsValueTransformation from './settings-value.transformation';
 export interface AsJson {
-    value: _SettingsValueTransformation.AsJson;
-    schemaVersion?: string;
-    updateToken?: string;
     insertAfter?: string;
     insertBefore?: string;
+    schemaVersion?: string;
+    updateToken?: string;
+    value: _SettingsValueTransformation.AsJson;
 }
 export declare function fromJson($model: AsJson): SettingsObjectUpdate;
 export declare function toJson($model: SettingsObjectUpdate): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts

@@ -5,53 +5,61 @@ import { SettingsValue } from './settings-value';
  */
 export interface SettingsObject {
     /**
-     * The timestamp of the last modification.
+     * The user (identified by a user ID or a public token ID) who performed that most recent modification.
      */
-    modified?: number;
+    author?: string;
+    /**
+     * The timestamp of the creation.
+     */
+    created?: number;
+    /**
+     * The unique identifier of the user who created the settings object.
+     */
+    createdBy?: string;
     /**
      * The external identifier of the settings object.
      */
     externalId?: string;
     modificationInfo?: ModificationInfo;
     /**
-     * The schema on which the object is based.
+     * The timestamp of the last modification.
      */
-    schemaId?: string;
+    modified?: number;
     /**
-     * The user (identified by a user ID or a public token ID) who performed that most recent modification.
+     * The unique identifier of the user who performed the most recent modification.
      */
-    author?: string;
+    modifiedBy?: string;
     /**
-     * The timestamp of the creation.
+     * The ID of the settings object.
      */
-    created?: number;
+    objectId?: string;
     /**
-     * The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
+     * The schema on which the object is based.
      */
-    scope?: string;
-    value?: SettingsValue;
+    schemaId?: string;
     /**
      * The version of the schema on which the object is based.
      */
     schemaVersion?: string;
     /**
-     * The update token of the object. You can use it to detect simultaneous modifications by different users.
-     *
-     * It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
-     *
-     * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
+     * The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
      */
-    updateToken?: string;
+    scope?: string;
     /**
      * A searchable summary string of the setting value. Plain text without Markdown.
      */
     searchSummary?: string;
-    /**
-     * The ID of the settings object.
-     */
-    objectId?: string;
     /**
      * A short summary of settings. This can contain Markdown and will be escaped accordingly.
      */
     summary?: string;
+    /**
+     * The update token of the object. You can use it to detect simultaneous modifications by different users.
+     *
+     * It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
+     *
+     * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
+     */
+    updateToken?: string;
+    value?: SettingsValue;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.transformation.d.ts

@@ -2,19 +2,21 @@ import * as _ModificationInfoTransformation from './modification-info.transforma
 import { SettingsObject } from './settings-object';
 import * as _SettingsValueTransformation from './settings-value.transformation';
 export interface AsJson {
-    modified?: number;
+    author?: string;
+    created?: number;
+    createdBy?: string;
     externalId?: string;
     modificationInfo?: _ModificationInfoTransformation.AsJson;
+    modified?: number;
+    modifiedBy?: string;
+    objectId?: string;
     schemaId?: string;
-    author?: string;
-    created?: number;
-    scope?: string;
-    value?: _SettingsValueTransformation.AsJson;
     schemaVersion?: string;
-    updateToken?: string;
+    scope?: string;
     searchSummary?: string;
-    objectId?: string;
     summary?: string;
+    updateToken?: string;
+    value?: _SettingsValueTransformation.AsJson;
 }
 export declare function fromJson($model: AsJson): SettingsObject;
 export declare function toJson($model: SettingsObject): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/sl-os.d.ts

@@ -4,19 +4,19 @@ import { SLO } from './slo';
  */
 export interface SLOs {
     /**
-     * The list of SLOs.
+     * The cursor for the next page of results. Has the value of `null` on the last page.
+     *
+     * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
      */
-    slo: SLO[];
+    nextPageKey?: string;
     /**
      * The number of entries per page.
      */
     pageSize?: number;
     /**
-     * The cursor for the next page of results. Has the value of `null` on the last page.
-     *
-     * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
+     * The list of SLOs.
      */
-    nextPageKey?: string;
+    slo: SLO[];
     /**
      * The total number of entries in the result.
      */

package/types/packages/client/classic-environment-v2/src/lib/models/sl-os.transformation.d.ts

@@ -1,9 +1,9 @@
 import { SLOs } from './sl-os';
 import * as _SLOTransformation from './slo.transformation';
 export interface AsJson {
-    slo: _SLOTransformation.AsJson[];
-    pageSize?: number;
     nextPageKey?: string;
+    pageSize?: number;
+    slo: _SLOTransformation.AsJson[];
     totalCount: number;
 }
 export declare function fromJson($model: AsJson): SLOs;

package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate-config.d.ts

@@ -3,9 +3,11 @@
  */
 export interface SloBurnRateConfig {
     /**
-     * The error budget burn rate visualization is enabled (`true`) or disabled (`false`).
+     * The error budget burn rate calculation is enabled (`true`) or disabled (`false`).
      *
      * In case of `false`, no calculated values will be present here.
+     *
+     * If not defined, the error budget burn rate calculation is disabled by default.
      */
     burnRateVisualizationEnabled?: boolean;
     /**

package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.d.ts

@@ -3,12 +3,21 @@ import { SloBurnRateBurnRateType } from './slo-burn-rate-burn-rate-type';
  * Error budget burn rate evaluation of a service-level objective (SLO).
  */
 export interface SloBurnRate {
+    burnRateType?: SloBurnRateBurnRateType;
+    /**
+     * The burn rate of the SLO, calculated for the last hour.
+     */
+    burnRateValue?: number;
     /**
-     * The error budget burn rate visualization is enabled (`true`) or disabled (`false`).
+     * The error budget burn rate calculation is enabled (`true`) or disabled (`false`).
      *
      * In case of `false`, no calculated values will be present here.
      */
     burnRateVisualizationEnabled: boolean;
+    /**
+     * The estimated time left to consume the error budget in hours.
+     */
+    estimatedTimeToConsumeErrorBudget?: number;
     /**
      * The threshold between a slow and a fast burn rate.
      */
@@ -17,13 +26,4 @@ export interface SloBurnRate {
      * The calculated value of the SLO for the timeframe chosen for the burn rate calculation.
      */
     sloValue?: number;
-    /**
-     * The estimated time left to consume the error budget in hours.
-     */
-    estimatedTimeToConsumeErrorBudget?: number;
-    burnRateType?: SloBurnRateBurnRateType;
-    /**
-     * The burn rate of the SLO, calculated for the last hour.
-     */
-    burnRateValue?: number;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.transformation.d.ts

@@ -1,12 +1,12 @@
 import { SloBurnRate } from './slo-burn-rate';
 import * as _SloBurnRateBurnRateTypeTransformation from './slo-burn-rate-burn-rate-type.transformation';
 export interface AsJson {
+    burnRateType?: _SloBurnRateBurnRateTypeTransformation.AsJson;
+    burnRateValue?: number;
     burnRateVisualizationEnabled: boolean;
+    estimatedTimeToConsumeErrorBudget?: number;
     fastBurnThreshold?: number;
     sloValue?: number;
-    estimatedTimeToConsumeErrorBudget?: number;
-    burnRateType?: _SloBurnRateBurnRateTypeTransformation.AsJson;
-    burnRateValue?: number;
 }
 export declare function fromJson($model: AsJson): SloBurnRate;
 export declare function toJson($model: SloBurnRate): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.d.ts

@@ -2,40 +2,35 @@ import { SloBurnRateConfig } from './slo-burn-rate-config';
 import { SloConfigItemDtoImplEvaluationType } from './slo-config-item-dto-impl-evaluation-type';
 export interface SloConfigItemDtoImpl {
     /**
-     * The SLO is enabled (`true`) or disabled (`false`).
+     * The description of the SLO.
      */
-    enabled?: boolean;
+    description?: string;
     /**
-     * The name of the SLO.
+     * The SLO is enabled (`true`) or disabled (`false`).
+     *
+     * If not defined, the SLO is disabled by default.
      */
-    name: string;
+    enabled?: boolean;
+    errorBudgetBurnRate?: SloBurnRateConfig;
+    evaluationType: SloConfigItemDtoImplEvaluationType;
     /**
-     * The description of the SLO.
+     * The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the [syntax of entity selector](https://dt-url.net/entityselector).
      */
-    description?: string;
+    filter?: string;
     /**
-     * The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
+     * The total count metric (the denominator in rate calculation).
+     *
+     * Required when the **useRateMetric** is set to `false`.
      */
-    metricName?: string;
+    metricDenominator?: string;
     /**
      * The percentage-based metric expression for the calculation of the SLO.
      */
     metricExpression?: string;
     /**
-     * The type of the metric to use for SLO calculation:
-     *
-     * * `true`: An existing percentage-based metric.
-     * * `false`: A ratio of two metrics.
-     *
-     * For a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call.
-     */
-    useRateMetric?: boolean | null;
-    /**
-     * The percentage-based metric for the calculation of the SLO.
-     *
-     * Required when the **useRateMetric** is set to `true`.
+     * The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
      */
-    metricRate?: string;
+    metricName?: string;
     /**
      * The metric for the count of successes (the numerator in rate calculation).
      *
@@ -43,29 +38,36 @@ export interface SloConfigItemDtoImpl {
      */
     metricNumerator?: string;
     /**
-     * The total count metric (the denominator in rate calculation).
+     * The percentage-based metric for the calculation of the SLO.
      *
-     * Required when the **useRateMetric** is set to `false`.
+     * Required when the **useRateMetric** is set to `true`.
      */
-    metricDenominator?: string;
-    evaluationType: SloConfigItemDtoImplEvaluationType;
+    metricRate?: string;
     /**
-     * The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the [syntax of entity selector](https://dt-url.net/entityselector).
+     * The name of the SLO.
      */
-    filter?: string;
+    name: string;
     /**
      * The target value of the SLO.
      */
     target: number;
+    /**
+     * The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
+     */
+    timeframe: string;
+    /**
+     * The type of the metric to use for SLO calculation:
+     *
+     * * `true`: An existing percentage-based metric.
+     * * `false`: A ratio of two metrics.
+     *
+     * For a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call.
+     */
+    useRateMetric?: boolean | null;
     /**
      * The warning value of the SLO.
      *
      *  At warning state the SLO is still fulfilled but is getting close to failure.
      */
     warning: number;
-    errorBudgetBurnRate?: SloBurnRateConfig;
-    /**
-     * The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
-     */
-    timeframe: string;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.transformation.d.ts

@@ -2,21 +2,21 @@ import * as _SloBurnRateConfigTransformation from './slo-burn-rate-config.transf
 import { SloConfigItemDtoImpl } from './slo-config-item-dto-impl';
 import * as _SloConfigItemDtoImplEvaluationTypeTransformation from './slo-config-item-dto-impl-evaluation-type.transformation';
 export interface AsJson {
-    enabled?: boolean;
-    name: string;
     description?: string;
-    metricName?: string;
-    metricExpression?: string;
-    useRateMetric?: boolean | null;
-    metricRate?: string;
-    metricNumerator?: string;
-    metricDenominator?: string;
+    enabled?: boolean;
+    errorBudgetBurnRate?: _SloBurnRateConfigTransformation.AsJson;
     evaluationType: _SloConfigItemDtoImplEvaluationTypeTransformation.AsJson;
     filter?: string;
+    metricDenominator?: string;
+    metricExpression?: string;
+    metricName?: string;
+    metricNumerator?: string;
+    metricRate?: string;
+    name: string;
     target: number;
-    warning: number;
-    errorBudgetBurnRate?: _SloBurnRateConfigTransformation.AsJson;
     timeframe: string;
+    useRateMetric?: boolean | null;
+    warning: number;
 }
 export declare function fromJson($model: AsJson): SloConfigItemDtoImpl;
 export declare function toJson($model: SloConfigItemDtoImpl): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts

@@ -5,25 +5,74 @@ import { SLOStatus } from './slo-status';
  * Parameters of a service-level objective (SLO).
  */
 export interface SLO {
+    /**
+     * The key for the SLO's error budget burn rate func metric.
+     */
+    burnRateMetricKey: string;
+    /**
+     * The denominator value used to evaluate the SLO when **useRateMetric** is set to `false`.
+     */
+    denominatorValue?: number;
+    /**
+     * A short description of the SLO.
+     */
+    description?: string;
+    /**
+     * The SLO is enabled (`true`) or disabled (`false`).
+     */
+    enabled: boolean;
+    /**
+     * The error of the SLO calculation.
+     *
+     * If the value differs from `NONE`, there is something wrong with the SLO calculation.
+     */
+    error: string;
+    /**
+     * The error budget of the calculated SLO.
+     *
+     * The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.
+     *
+     * Has the value of the evaluated error budget or the value of `-1`:
+     *
+     * * If there is an error with the SLO calculation; in that case check the value of the **error** property.
+     * * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
+     */
+    errorBudget: number;
+    errorBudgetBurnRate: SloBurnRate;
     /**
      * The key for the SLO's error budget func metric.
      */
     errorBudgetMetricKey: string;
     /**
-     * The type of the metric to use for SLO calculation:
-     *
-     * * `true`: An existing percentage-based metric.
-     * * `false`: A ratio of two metrics.
+     * The calculated status value of the SLO. Has the value of the evaluated SLO status or the value of `-1`:
      *
-     * For a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call.
+     * * If there is an error with the SLO calculation; in that case check the value of the **error** property.
+     * * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
      */
-    useRateMetric?: boolean;
+    evaluatedPercentage: number;
+    evaluationType: SLOEvaluationType;
     /**
-     * The percentage-based metric for the calculation of the SLO.
+     * The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the [syntax of entity selector](https://dt-url.net/entityselector).
+     */
+    filter: string;
+    /**
+     * The ID of the SLO
+     */
+    id: string;
+    /**
+     * The total count metric (the denominator in rate calculation).
      *
-     * Required when the **useRateMetric** is set to `true`.
+     * Required when the **useRateMetric** is set to `false`.
      */
-    metricRate?: string;
+    metricDenominator?: string;
+    /**
+     * The percentage-based metric expression for the calculation of the SLO.
+     */
+    metricExpression: string;
+    /**
+     * The key for the SLO's status func metric.
+     */
+    metricKey: string;
     /**
      * The metric for the count of successes (the numerator in rate calculation).
      *
@@ -31,17 +80,15 @@ export interface SLO {
      */
     metricNumerator?: string;
     /**
-     * The total count metric (the denominator in rate calculation).
+     * The percentage-based metric for the calculation of the SLO.
      *
-     * Required when the **useRateMetric** is set to `false`.
+     * Required when the **useRateMetric** is set to `true`.
      */
-    metricDenominator?: string;
-    evaluationType: SLOEvaluationType;
+    metricRate?: string;
     /**
-     * The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
+     * The name of the SLO.
      */
-    timeframe: string;
-    errorBudgetBurnRate: SloBurnRate;
+    name: string;
     /**
      * The key for the SLO's normalized error budget func metric.
      */
@@ -51,9 +98,9 @@ export interface SLO {
      */
     numeratorValue?: number;
     /**
-     * The denominator value used to evaluate the SLO when **useRateMetric** is set to `false`.
+     * The entity filter for fetching the number of problems related to an SLO. Auto-generated in case no filter has been added to the SLO.
      */
-    denominatorValue?: number;
+    problemFilters?: string[];
     /**
      * Number of open problems related to the SLO.
      *
@@ -66,75 +113,28 @@ export interface SLO {
      * Has the value of `-1` if there's an error with fetching SLO related problems.
      */
     relatedTotalProblems?: number;
+    status: SLOStatus;
     /**
-     * The entity filter for fetching the number of problems related to an SLO. Auto-generated in case no filter has been added to the SLO.
-     */
-    problemFilters?: string[];
-    /**
-     * The percentage-based metric expression for the calculation of the SLO.
+     * The target value of the SLO.
      */
-    metricExpression: string;
+    target: number;
     /**
-     * The calculated status value of the SLO. Has the value of the evaluated SLO status or the value of `-1`:
-     *
-     * * If there is an error with the SLO calculation; in that case check the value of the **error** property.
-     * * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
+     * The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
      */
-    evaluatedPercentage: number;
+    timeframe: string;
     /**
-     * The error budget of the calculated SLO.
-     *
-     * The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.
-     *
-     * Has the value of the evaluated error budget or the value of `-1`:
+     * The type of the metric to use for SLO calculation:
      *
-     * * If there is an error with the SLO calculation; in that case check the value of the **error** property.
-     * * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
-     */
-    errorBudget: number;
-    /**
-     * The key for the SLO's status func metric.
-     */
-    metricKey: string;
-    /**
-     * The key for the SLO's error budget burn rate func metric.
-     */
-    burnRateMetricKey: string;
-    /**
-     * The error of the SLO calculation.
+     * * `true`: An existing percentage-based metric.
+     * * `false`: A ratio of two metrics.
      *
-     * If the value differs from `NONE`, there is something wrong with the SLO calculation.
+     * For a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call.
      */
-    error: string;
+    useRateMetric?: boolean;
     /**
      * The warning value of the SLO.
      *
      *  At warning state the SLO is still fulfilled but is getting close to failure.
      */
     warning: number;
-    /**
-     * The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the [syntax of entity selector](https://dt-url.net/entityselector).
-     */
-    filter: string;
-    /**
-     * The SLO is enabled (`true`) or disabled (`false`).
-     */
-    enabled: boolean;
-    /**
-     * A short description of the SLO.
-     */
-    description?: string;
-    status: SLOStatus;
-    /**
-     * The name of the SLO.
-     */
-    name: string;
-    /**
-     * The ID of the SLO
-     */
-    id: string;
-    /**
-     * The target value of the SLO.
-     */
-    target: number;
 }