@dynatrace-sdk/client-classic-environment-v2 5.2.2 → 6.1.0

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

@@ -1,80 +0,0 @@
-import { AnyValue } from './any-value';
-import { Identity } from './identity';
-import { ResourceContext } from './resource-context';
-/**
- * The response to a get by objectId request.
- */
-export interface SettingsObjectByObjectIdResponse {
-    /**
-     * The user (identified by a user ID or a public token ID) who performed that most recent modification.
-     */
-    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;
-    /**
-     * The timestamp of the last modification.
-     */
-    modified?: number;
-    /**
-     * The unique identifier of the user who performed the most recent modification.
-     */
-    modifiedBy?: string;
-    /**
-     * The ID of the settings object.
-     */
-    objectId?: string;
-    /**
-     * An Identity describing either a user, a group, or the all-users group (applying to all users).
-     */
-    owner?: Identity;
-    /**
-     * The resource context, which contains additional permission information about the object.
-     */
-    resourceContext?: ResourceContext;
-    /**
-     * The schema on which the object is based.
-     */
-    schemaId?: string;
-    /**
-     * The version of the schema on which the object is based.
-     */
-    schemaVersion?: string;
-    /**
-     * The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
-     */
-    scope?: string;
-    /**
-     * A searchable summary string of the setting value. Plain text without Markdown.
-     */
-    searchSummary?: 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;
-    /**
-     * The value of the setting.
-     *
-     *  It defines the actual values of settings' parameters.
-     *
-     * The actual content depends on the object's schema.
-     */
-    value?: AnyValue;
-}

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

@@ -1,46 +0,0 @@
-import { AnyValue } from './any-value';
-/**
- * Configuration of a new settings object.
- */
-export interface SettingsObjectCreate {
-    /**
-     * External identifier for the object being created
-     */
-    externalId?: string;
-    /**
-     * The position of the new object. The new object will be added after the specified one.
-     *
-     * If `null` (or unset), the new object will be placed in the last position.
-     *
-     * If set to an empty string, the new object will be placed in the first position.
-     *
-     * Only applicable for objects based on schemas with ordered objects (schema's `ordered` parameter is set to `true`).
-     */
-    insertAfter?: string;
-    /**
-     * The ID of the settings object that should be replaced.
-     *
-     * Only applicable if an external identifier is provided.
-     */
-    objectId?: string;
-    /**
-     * The schema on which the object is based.
-     */
-    schemaId: string;
-    /**
-     * The version of the schema on which the object is based.
-     */
-    schemaVersion?: string;
-    /**
-     * The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
-     */
-    scope: string;
-    /**
-     * The value of the setting.
-     *
-     *  It defines the actual values of settings' parameters.
-     *
-     * The actual content depends on the object's schema.
-     */
-    value: AnyValue;
-}

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

@@ -1,24 +0,0 @@
-import { AnyValue } from './any-value';
-import { Error } from './error';
-/**
- * The response to a creation- or update-request.
- */
-export interface SettingsObjectResponse {
-    /**
-     * The HTTP status code for the object.
-     */
-    code: number;
-    error?: Error;
-    /**
-     * The value of the setting.
-     *
-     *  It defines the actual values of settings' parameters.
-     *
-     * The actual content depends on the object's schema.
-     */
-    invalidValue?: AnyValue;
-    /**
-     * For a successful request, the ID of the created or modified settings object.
-     */
-    objectId?: string;
-}

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

@@ -1,50 +0,0 @@
-import { AnyValue } from './any-value';
-/**
- * An update of a settings object.
- */
-export interface SettingsObjectUpdate {
-    /**
-     * The position of the updated object. The new object will be moved behind the specified one.
-     *
-     * **insertAfter** and **insertBefore** are evaluated together and only one of both can be set (and be non `null`).
-     *
-     * If `null` (or unset) and **insertBefore** is `null` (or unset), the existing object keeps the current position.
-     *
-     * If set to an empty string, the updated object will be placed in the first position.
-     *
-     * Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
-     */
-    insertAfter?: string;
-    /**
-     * The position of the updated object. The new object will be moved in front of the specified one.
-     *
-     * **insertAfter** and **insertBefore** are evaluated together and only one of both can be set (and be non `null`).
-     *
-     * If `null` (or unset) and **insertAfter** is `null` (or unset), the existing object keeps the current position.
-     *
-     * If set to an empty string, the updated object will be placed in the last position.
-     *
-     * 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;
-    /**
-     * The value of the setting.
-     *
-     *  It defines the actual values of settings' parameters.
-     *
-     * The actual content depends on the object's schema.
-     */
-    value: AnyValue;
-}

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

@@ -1,87 +0,0 @@
-import { AnyValue } from './any-value';
-import { Identity } from './identity';
-import { ModificationInfo } from './modification-info';
-import { ResourceContext } from './resource-context';
-/**
- * A settings object.
- */
-export interface SettingsObject {
-    /**
-     * The user (identified by a user ID or a public token ID) who performed that most recent modification.
-     */
-    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;
-    /**
-     * The modification info for a single updatable setting. Replaced by `resourceContext`.
-     *
-     * @deprecated
-     */
-    modificationInfo?: ModificationInfo;
-    /**
-     * The timestamp of the last modification.
-     */
-    modified?: number;
-    /**
-     * The unique identifier of the user who performed the most recent modification.
-     */
-    modifiedBy?: string;
-    /**
-     * The ID of the settings object.
-     */
-    objectId?: string;
-    /**
-     * An Identity describing either a user, a group, or the all-users group (applying to all users).
-     */
-    owner?: Identity;
-    /**
-     * The resource context, which contains additional permission information about the object.
-     */
-    resourceContext?: ResourceContext;
-    /**
-     * The schema on which the object is based.
-     */
-    schemaId?: string;
-    /**
-     * The version of the schema on which the object is based.
-     */
-    schemaVersion?: string;
-    /**
-     * The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
-     */
-    scope?: string;
-    /**
-     * A searchable summary string of the setting value. Plain text without Markdown.
-     */
-    searchSummary?: 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;
-    /**
-     * The value of the setting.
-     *
-     *  It defines the actual values of settings' parameters.
-     *
-     * The actual content depends on the object's schema.
-     */
-    value?: AnyValue;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/single-permission-request.d.ts

@@ -1,14 +0,0 @@
-import { PermissionContext } from './permission-context';
-/**
- * A list of permissions.
- */
-export interface SinglePermissionRequest {
-    /**
-     * Optional context data
-     */
-    context?: PermissionContext;
-    /**
-     * Permission to be probed
-     */
-    permission: string;
-}

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

@@ -1,24 +0,0 @@
-import { SLO } from './slo';
-/**
- * Contains SLOs and paging information.
- */
-export interface 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.
-     */
-    nextPageKey?: string;
-    /**
-     * The number of entries per page.
-     */
-    pageSize?: number;
-    /**
-     * The list of SLOs.
-     */
-    slo: SLO[];
-    /**
-     * The total number of entries in the result.
-     */
-    totalCount: number;
-}

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

@@ -1,12 +0,0 @@
-/**
- * The calculated burn rate type.
- *
- * Has a value of 'FAST', 'SLOW' or 'NONE'.
- *
- * @deprecated Use literal values.
- */
-export declare enum SloBurnRateBurnRateType {
-    Fast = "FAST",
-    None = "NONE",
-    Slow = "SLOW"
-}

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

@@ -1,17 +0,0 @@
-/**
- * Error budget burn rate configuration of a service-level objective (SLO).
- */
-export interface SloBurnRateConfig {
-    /**
-     * 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;
-    /**
-     * The threshold between a slow and a fast burn rate.
-     */
-    fastBurnThreshold?: number;
-}

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

@@ -1,33 +0,0 @@
-/**
- * Error budget burn rate evaluation of a service-level objective (SLO).
- */
-export interface SloBurnRate {
-    /**
-     * The calculated burn rate type.
-     *
-     * Has a value of 'FAST', 'SLOW' or 'NONE'.
-     */
-    burnRateType?: 'FAST' | 'NONE' | 'SLOW';
-    /**
-     * The burn rate of the SLO, calculated for the last hour.
-     */
-    burnRateValue?: number;
-    /**
-     * 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.
-     */
-    fastBurnThreshold?: number;
-    /**
-     * The calculated value of the SLO for the timeframe chosen for the burn rate calculation.
-     */
-    sloValue?: number;
-}

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

@@ -1,8 +0,0 @@
-/**
- * The evaluation type of the SLO.
- *
- * @deprecated Use literal values.
- */
-export declare enum SloConfigItemDtoImplEvaluationType {
-    Aggregate = "AGGREGATE"
-}

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

@@ -1,86 +0,0 @@
-import { SloBurnRateConfig } from './slo-burn-rate-config';
-export interface SloConfigItemDtoImpl {
-    /**
-     * The description of the SLO.
-     */
-    description?: string;
-    /**
-     * The SLO is enabled (`true`) or disabled (`false`).
-     *
-     * If not defined, the SLO is disabled by default.
-     */
-    enabled?: boolean;
-    /**
-     * Error budget burn rate configuration of a service-level objective (SLO).
-     */
-    errorBudgetBurnRate?: SloBurnRateConfig;
-    /**
-     * The evaluation type of the SLO.
-     */
-    evaluationType: 'AGGREGATE';
-    /**
-     * 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 total count metric (the denominator in rate calculation).
-     *
-     * Required when the **useRateMetric** is set to `false`.
-     *
-     * @deprecated
-     */
-    metricDenominator?: string;
-    /**
-     * The percentage-based metric expression for the calculation of the SLO.
-     */
-    metricExpression?: string;
-    /**
-     * The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
-     */
-    metricName?: string;
-    /**
-     * The metric for the count of successes (the numerator in rate calculation).
-     *
-     * Required when the **useRateMetric** is set to `false`.
-     *
-     * @deprecated
-     */
-    metricNumerator?: string;
-    /**
-     * The percentage-based metric for the calculation of the SLO.
-     *
-     * Required when the **useRateMetric** is set to `true`.
-     *
-     * @deprecated
-     */
-    metricRate?: string;
-    /**
-     * The name of the SLO.
-     */
-    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.
-     *
-     * @deprecated
-     */
-    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;
-}

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

@@ -1,8 +0,0 @@
-/**
- * The evaluation type of the SLO.
- *
- * @deprecated Use literal values.
- */
-export declare enum SLOEvaluationType {
-    Aggregate = "AGGREGATE"
-}

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

@@ -1,10 +0,0 @@
-/**
- * The status of the calculated SLO.
- *
- * @deprecated Use literal values.
- */
-export declare enum SLOStatus {
-    Failure = "FAILURE",
-    Success = "SUCCESS",
-    Warning = "WARNING"
-}

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

@@ -1,165 +0,0 @@
-import { SloBurnRate } from './slo-burn-rate';
-/**
- * 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`.
-     *
-     * @deprecated
-     */
-    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;
-    /**
-     * Error budget burn rate evaluation of a service-level objective (SLO).
-     */
-    errorBudgetBurnRate: SloBurnRate;
-    /**
-     * The key for the SLO's error budget func metric.
-     */
-    errorBudgetMetricKey: string;
-    /**
-     * 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.
-     */
-    evaluatedPercentage: number;
-    /**
-     * The evaluation type of the SLO.
-     */
-    evaluationType: 'AGGREGATE';
-    /**
-     * 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 `false`.
-     *
-     * @deprecated
-     */
-    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 name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
-     */
-    metricName: string;
-    /**
-     * The metric for the count of successes (the numerator in rate calculation).
-     *
-     * Required when the **useRateMetric** is set to `false`.
-     *
-     * @deprecated
-     */
-    metricNumerator?: string;
-    /**
-     * The percentage-based metric for the calculation of the SLO.
-     *
-     * Required when the **useRateMetric** is set to `true`.
-     *
-     * @deprecated
-     */
-    metricRate?: string;
-    /**
-     * The name of the SLO.
-     */
-    name: string;
-    /**
-     * The key for the SLO's normalized error budget func metric.
-     */
-    normalizedErrorBudgetMetricKey: string;
-    /**
-     * The numerator value used to evaluate the SLO when **useRateMetric** is set to `false`.
-     *
-     * @deprecated
-     */
-    numeratorValue?: number;
-    /**
-     * 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.
-     *
-     * @deprecated
-     */
-    problemFilters?: string[];
-    /**
-     * Number of open problems related to the SLO.
-     *
-     * Has the value of `-1` if there's an error with fetching SLO related problems.
-     */
-    relatedOpenProblems?: number;
-    /**
-     * Total number of problems related to the SLO.
-     *
-     * Has the value of `-1` if there's an error with fetching SLO related problems.
-     */
-    relatedTotalProblems?: number;
-    /**
-     * The status of the calculated SLO.
-     */
-    status: 'FAILURE' | 'SUCCESS' | 'WARNING';
-    /**
-     * 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.
-     *
-     * @deprecated
-     */
-    useRateMetric?: boolean;
-    /**
-     * The warning value of the SLO.
-     *
-     *  At warning state the SLO is still fulfilled but is getting close to failure.
-     */
-    warning: number;
-}