@dynatrace-sdk/client-classic-environment-v2 2.0.0 → 3.2.0

package/types/packages/client/classic-environment-v2/src/lib/models/metric-default-aggregation.d.ts

@@ -9,5 +9,8 @@ export interface MetricDefaultAggregation {
      * Applicable only to the `percentile` aggregation type.
      */
     parameter?: number;
+    /**
+     * The type of default aggregation.
+     */
     type: MetricDefaultAggregationType;
 }

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

@@ -31,6 +31,9 @@ export interface MetricDescriptor {
      *  [Metric expressions](https://dt-url.net/metricExpression) don't return this field.
      */
     dduBillable?: boolean;
+    /**
+     * The default aggregation of a metric.
+     */
     defaultAggregation?: MetricDefaultAggregation;
     /**
      * A short description of the metric.
@@ -94,6 +97,9 @@ export interface MetricDescriptor {
      * The metric selector that is used when querying a func: metric.
      */
     metricSelector?: string;
+    /**
+     * The value type for the metric.
+     */
     metricValueType?: MetricValueType;
     /**
      * The minimum allowed value of the metric.
@@ -132,6 +138,17 @@ export interface MetricDescriptor {
      * The unit of the metric.
      */
     unit?: string;
+    /**
+     * The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
+     *
+     * Binary: 1 MiB = 1024 KiB = 1,048,576 bytes
+     *
+     * Decimal: 1 MB = 1000 kB = 1,000,000 bytes
+     *
+     * If not set, the decimal system is used.
+     *
+     *  [Metric expressions](https://dt-url.net/metricExpression) don't return this field.
+     */
     unitDisplayFormat?: MetricDescriptorUnitDisplayFormat;
     /**
      * A list of potential warnings that affect this ID. For example deprecated feature usage etc.

package/types/packages/client/classic-environment-v2/src/lib/models/metric-dimension-definition.d.ts

@@ -23,5 +23,8 @@ export interface MetricDimensionDefinition {
      * The name of the dimension.
      */
     name: string;
+    /**
+     * The type of the dimension.
+     */
     type: MetricDimensionDefinitionType;
 }

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

@@ -7,5 +7,8 @@ export interface MetricDto {
      * Metric key
      */
     key?: string;
+    /**
+     * Metric metadata
+     */
     metadata?: MetricMetadataDto;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/metric-query-dql-translation.d.ts

@@ -11,5 +11,8 @@ export interface MetricQueryDQLTranslation {
      * The DQL query corresponding to the metric query
      */
     query?: string;
+    /**
+     * The status of the DQL translation, either `success` or `not supported`
+     */
     status?: MetricQueryDQLTranslationStatus;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.d.ts

@@ -21,6 +21,9 @@ export interface MetricSeriesCollection {
      * The ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query.
      */
     dimensionCountRatio: number;
+    /**
+     * Metric query translation to DQL.
+     */
     dql?: MetricQueryDQLTranslation;
     /**
      * The key of the metric.

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

@@ -7,6 +7,8 @@ import { MetricSeriesDimensionMap } from './metric-series-dimension-map';
 export interface MetricSeries {
     dimensionMap: MetricSeriesDimensionMap;
     /**
+     * Deprecated, refer to `dimensionMap` instead.
+     *
      * The ordered list of dimensions to which the data point list belongs.
      *
      *  Each metric can have a certain number of dimensions. Dimensions exceeding this number are aggregated into one, which is shown as `null` here.

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

@@ -3,5 +3,8 @@ import { MetricValueTypeType } from './metric-value-type-type';
  * The value type for the metric.
  */
 export interface MetricValueType {
+    /**
+     * The metric value type
+     */
     type: MetricValueTypeType;
 }

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

@@ -1,11 +1,11 @@
 /**
- * The modification info for a single updatable setting.
+ * The modification info for a single updatable setting. Replaced by `resourceContext`.
  */
 export interface ModificationInfo {
     /**
      * If settings value can be deleted
      */
-    deletable?: boolean;
+    deletable: boolean;
     /**
      * If non-moveable settings value is in the first group of non-moveable settings, or in the last (start or end of list)
      */
@@ -13,17 +13,17 @@ export interface ModificationInfo {
     /**
      * If settings value can be modified
      */
-    modifiable?: boolean;
+    modifiable: boolean;
     /**
      * Property paths which are modifiable, regardless of the state of `modifiable`
      */
-    modifiablePaths?: string[];
+    modifiablePaths: string[];
     /**
      * If settings value can be moved/reordered. Only applicable for ordered list schema
      */
-    movable?: boolean;
+    movable: boolean;
     /**
      * Property paths which are not modifiable, when `modifiable` is true
      */
-    nonModifiablePaths?: string[];
+    nonModifiablePaths: string[];
 }

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

@@ -1,11 +1,11 @@
 import { ModificationInfo } from './modification-info';
 export interface AsJson {
-    deletable?: boolean;
+    deletable: boolean;
     first?: boolean;
-    modifiable?: boolean;
-    modifiablePaths?: string[];
-    movable?: boolean;
-    nonModifiablePaths?: string[];
+    modifiable: boolean;
+    modifiablePaths: string[];
+    movable: boolean;
+    nonModifiablePaths: string[];
 }
 export declare function fromJson($model: AsJson): ModificationInfo;
 export declare function toJson($model: ModificationInfo): AsJson;

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

@@ -0,0 +1,21 @@
+/**
+ * The additional modification details for this settings object.
+ */
+export interface Modification {
+    /**
+     * If non-moveable settings object is in the first group of non-moveable settings, or in the last (start or end of list).
+     */
+    first?: boolean;
+    /**
+     * Property paths which are modifiable, regardless if the `write` operation is allowed.
+     */
+    modifiablePaths: string[];
+    /**
+     * If settings object can be moved/reordered. Only applicable for ordered list schema.
+     */
+    movable?: boolean;
+    /**
+     * Property paths which are not modifiable, even if the `write` operation is allowed.
+     */
+    nonModifiablePaths: string[];
+}

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

@@ -0,0 +1,9 @@
+import { Modification } from './modification';
+export interface AsJson {
+    first?: boolean;
+    modifiablePaths: string[];
+    movable?: boolean;
+    nonModifiablePaths: string[];
+}
+export declare function fromJson($model: AsJson): Modification;
+export declare function toJson($model: Modification): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts

@@ -26,6 +26,7 @@ export declare enum MonitoredEntityStatesState {
     Ok = "ok",
     ParentProcessRestartRequired = "parent_process_restart_required",
     PodmanDisabled = "podman_disabled",
+    ProcessGroupDifferentIdDueToDeclarativeGrouping = "process_group_different_id_due_to_declarative_grouping",
     ProcessGroupDisabled = "process_group_disabled",
     ProcessGroupDisabledViaContainerInjectionRule = "process_group_disabled_via_container_injection_rule",
     ProcessGroupDisabledViaContainerInjectionRuleRestart = "process_group_disabled_via_container_injection_rule_restart",

package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts

@@ -13,6 +13,12 @@ export interface MonitoredEntityStates {
      * Additional parameters of the monitoring state.
      */
     params?: MonitoredEntityStateParam[];
+    /**
+     * The type of the monitoring state.
+     */
     severity?: MonitoredEntityStatesSeverity;
+    /**
+     * The name of the monitoring state.
+     */
     state?: MonitoredEntityStatesState;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/monitoring-configuration-dto.d.ts

@@ -4,5 +4,8 @@ export interface MonitoringConfigurationDto {
      * The scope this monitoring configuration will be defined for
      */
     scope: string;
+    /**
+     * The monitoring configuration
+     */
     value?: JsonNode;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/monitoring-configuration-update-dto.d.ts

@@ -1,4 +1,7 @@
 import { JsonNode } from './json-node';
 export interface MonitoringConfigurationUpdateDto {
+    /**
+     * The monitoring configuration
+     */
     value?: JsonNode;
 }

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

@@ -7,6 +7,9 @@ export interface MuteState {
      * A user's comment.
      */
     comment?: string;
+    /**
+     * The reason for the mute state change.
+     */
     reason?: MuteStateReason;
     /**
      * The user who has muted or unmuted the problem.

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

@@ -11,6 +11,9 @@ export interface NetworkZone {
      * A short description of the network zone.
      */
     description?: string;
+    /**
+     * The fallback mode of the network zone.
+     */
     fallbackMode?: NetworkZoneFallbackMode;
     /**
      * The ID of the network zone.

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

@@ -0,0 +1,13 @@
+/**
+ * Optional context data
+ */
+export interface PermissionContext {
+    /**
+     * Settings schema id for conditional permission
+     */
+    schemaId: string;
+    /**
+     * Settings scope for conditional permission
+     */
+    scope: string;
+}

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

@@ -0,0 +1,7 @@
+import { PermissionContext } from './permission-context';
+export interface AsJson {
+    schemaId: string;
+    scope: string;
+}
+export declare function fromJson($model: AsJson): PermissionContext;
+export declare function toJson($model: PermissionContext): AsJson;

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

@@ -22,6 +22,9 @@ export interface Precondition {
      * Only applicable to properties of the `REGEX_MATCH` type.
      */
     pattern?: string;
+    /**
+     * A precondition for visibility of a property.
+     */
     precondition?: Precondition;
     /**
      * A list of child preconditions to be evaluated.
@@ -33,5 +36,8 @@ export interface Precondition {
      * The property to be evaluated.
      */
     property?: string;
+    /**
+     * The type of the precondition.
+     */
     type: PreconditionType;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/problem-close-result.d.ts

@@ -11,6 +11,9 @@ export interface ProblemCloseResult {
      * True, if the problem is being closed.
      */
     closing: boolean;
+    /**
+     * The comment to a problem.
+     */
     comment?: Comment;
     /**
      * The ID of the problem.

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

@@ -31,13 +31,37 @@ export interface Problem {
      * A list of all entity tags of the problem.
      */
     entityTags?: METag[];
+    /**
+     * The evidence details of a problem.
+     */
     evidenceDetails?: EvidenceDetails;
+    /**
+     * A list of all impacts of the problem.
+     */
     impactAnalysis?: ImpactAnalysis;
+    /**
+     * The impact level of the problem. It shows what is affected by the problem.
+     */
     impactLevel: ProblemImpactLevel;
     /**
      * A list of all entities that are impacted by the problem.
      */
     impactedEntities: EntityStub[];
+    /**
+     * The related Kubernetes cluster names.
+     */
+    'k8s.cluster.name'?: string[];
+    /**
+     * The related Kubernetes cluster UIDs.
+     */
+    'k8s.cluster.uid'?: string[];
+    /**
+     * The related Kubernetes namespace names.
+     */
+    'k8s.namespace.name'?: string[];
+    /**
+     * The properties of the linked problem.
+     */
     linkedProblemInfo?: LinkedProblem;
     /**
      * A list of all management zones that the problem belongs to.
@@ -51,13 +75,25 @@ export interface Problem {
      * The ID of the problem.
      */
     problemId: string;
+    /**
+     * A list of comments.
+     */
     recentComments?: CommentsList;
+    /**
+     * A short representation of a monitored entity.
+     */
     rootCauseEntity?: EntityStub;
+    /**
+     * The severity of the problem.
+     */
     severityLevel: ProblemSeverityLevel;
     /**
      * The start timestamp of the problem, in UTC milliseconds.
      */
     startTime: number;
+    /**
+     * The status of the problem.
+     */
     status: ProblemStatus;
     /**
      * The name of the problem, displayed in the UI.

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

@@ -19,6 +19,9 @@ export interface AsJson {
     impactAnalysis?: _ImpactAnalysisTransformation.AsJson;
     impactLevel: _ProblemImpactLevelTransformation.AsJson;
     impactedEntities: _EntityStubTransformation.AsJson[];
+    'k8s.cluster.name'?: string[];
+    'k8s.cluster.uid'?: string[];
+    'k8s.namespace.name'?: string[];
     linkedProblemInfo?: _LinkedProblemTransformation.AsJson;
     managementZones: _ManagementZoneTransformation.AsJson[];
     problemFilters: _AlertingProfileStubTransformation.AsJson[];

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

@@ -15,6 +15,9 @@ export interface PropertyDefinition {
      * A list of constraints limiting the values to be accepted.
      */
     constraints?: Constraint[];
+    /**
+     * Configuration of a datasource for a property.
+     */
     datasource?: DatasourceDefinition;
     /**
      * The default value to be used when no value is provided.
@@ -38,6 +41,9 @@ export interface PropertyDefinition {
      * Defines if value is allowed to be modified when secret properties are not
      */
     forceSecretResubmission?: boolean;
+    /**
+     * An item of a collection property.
+     */
     items?: Item;
     /**
      * The maximum number of **objects** in a collection property.
@@ -45,6 +51,9 @@ export interface PropertyDefinition {
      *  Has the value of `1` for singletons.
      */
     maxObjects: number;
+    /**
+     * Metadata of the property.
+     */
     metadata?: PropertyDefinitionMetadata;
     /**
      * Pattern with references to properties to create a new value.
@@ -54,11 +63,17 @@ export interface PropertyDefinition {
      * The minimum number of **objects** in a collection property.
      */
     minObjects?: number;
+    /**
+     * Modification policy of the property.
+     */
     modificationPolicy?: PropertyDefinitionModificationPolicy;
     /**
      * The value can (`true`) or can't (`false`) be `null`.
      */
     nullable: boolean;
+    /**
+     * A precondition for visibility of a property.
+     */
     precondition?: Precondition;
     /**
      * The type referenced by the property value
@@ -72,5 +87,8 @@ export interface PropertyDefinition {
      * The type of the property's value.
      */
     type: string | RefPointer;
+    /**
+     * Customization for UI elements
+     */
     uiCustomization?: UiCustomization;
 }

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

@@ -3,5 +3,8 @@ import { HttpProtocolDetails } from './http-protocol-details';
  * Details that are specific to the used protocol.
  */
 export interface ProtocolDetails {
+    /**
+     * HTTP specific request details.
+     */
     http?: HttpProtocolDetails;
 }

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

@@ -7,6 +7,9 @@ export interface RelatedService {
      * A list of affected entities related to the entity.
      */
     affectedEntities?: string[];
+    /**
+     * The level of exposure of the service.
+     */
     exposure?: RelatedServiceExposure;
     /**
      * The Dynatrace entity ID of the entity.

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

@@ -1,3 +1,4 @@
+import { AssessmentAccuracyDetails } from './assessment-accuracy-details';
 import { RemediationAssessmentAssessmentAccuracy } from './remediation-assessment-assessment-accuracy';
 import { RemediationAssessmentDataAssets } from './remediation-assessment-data-assets';
 import { RemediationAssessmentExposure } from './remediation-assessment-exposure';
@@ -7,8 +8,21 @@ import { VulnerableFunction } from './vulnerable-function';
  * Assessment of the remediation item.
  */
 export interface RemediationAssessment {
+    /**
+     * The accuracy of the assessment.
+     */
     assessmentAccuracy?: RemediationAssessmentAssessmentAccuracy;
+    /**
+     * The assessment accuracy details.
+     */
+    assessmentAccuracyDetails?: AssessmentAccuracyDetails;
+    /**
+     * The reachability of related data assets by affected entities.
+     */
     dataAssets?: RemediationAssessmentDataAssets;
+    /**
+     * The level of exposure of affected entities.
+     */
     exposure?: RemediationAssessmentExposure;
     /**
      * The number of related data assets.
@@ -18,6 +32,9 @@ export interface RemediationAssessment {
      * Whether a restart is required for the latest vulnerable function data.
      */
     vulnerableFunctionRestartRequired?: boolean;
+    /**
+     * The usage of vulnerable functions
+     */
     vulnerableFunctionUsage?: RemediationAssessmentVulnerableFunctionUsage;
     /**
      * A list of vulnerable functions that are in use.

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

@@ -1,3 +1,4 @@
+import * as _AssessmentAccuracyDetailsTransformation from './assessment-accuracy-details.transformation';
 import { RemediationAssessment } from './remediation-assessment';
 import * as _RemediationAssessmentAssessmentAccuracyTransformation from './remediation-assessment-assessment-accuracy.transformation';
 import * as _RemediationAssessmentDataAssetsTransformation from './remediation-assessment-data-assets.transformation';
@@ -6,6 +7,7 @@ import * as _RemediationAssessmentVulnerableFunctionUsageTransformation from './
 import * as _VulnerableFunctionTransformation from './vulnerable-function.transformation';
 export interface AsJson {
     assessmentAccuracy?: _RemediationAssessmentAssessmentAccuracyTransformation.AsJson;
+    assessmentAccuracyDetails?: _AssessmentAccuracyDetailsTransformation.AsJson;
     dataAssets?: _RemediationAssessmentDataAssetsTransformation.AsJson;
     exposure?: _RemediationAssessmentExposureTransformation.AsJson;
     numberOfDataAssets?: number;

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-details-item.d.ts

@@ -8,14 +8,26 @@ import { TrackingLink } from './tracking-link';
  * Detailed information of a remediation item for a security problem.
  */
 export interface RemediationDetailsItem {
+    /**
+     * Assessment of the remediation item.
+     */
     assessment?: RemediationAssessment;
     entityIds?: string[];
     firstAffectedTimestamp?: number;
     id?: string;
+    /**
+     * The mute state of a remediation item of a security problem.
+     */
     muteState?: RemediationItemMuteState;
     name?: string;
+    /**
+     * The progress of this remediation item. It contains affected and unaffected entities.
+     */
     remediationProgress?: RemediationProgress;
     resolvedTimestamp?: number;
+    /**
+     * External tracking link URL associated with the remediable entity of the security problem.
+     */
     trackingLink?: TrackingLink;
     vulnerabilityState?: RemediationDetailsItemVulnerabilityState;
     /**

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state-change.d.ts

@@ -11,5 +11,8 @@ export interface RemediationItemMuteStateChange {
      * The desired mute state of the remediation item.
      */
     muted: boolean;
+    /**
+     * The reason for the mute state change.
+     */
     reason: RemediationItemMuteStateChangeReason;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state.d.ts

@@ -15,6 +15,9 @@ export interface RemediationItemMuteState {
      * The remediation is (`true`) or is not (`false`) muted.
      */
     muted?: boolean;
+    /**
+     * The reason for the most recent mute state change.
+     */
     reason?: RemediationItemMuteStateReason;
     /**
      * The user who last changed the mute state.

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary.d.ts

@@ -7,6 +7,9 @@ export interface RemediationItemMutingSummary {
      * Whether a mute state change for the given remediation item was triggered by this request.
      */
     muteStateChangeTriggered: boolean;
+    /**
+     * Contains a reason, in case the requested operation was not executed.
+     */
     reason?: RemediationItemMutingSummaryReason;
     /**
      * The id of the remediation item that will be (un-)muted.

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

@@ -8,14 +8,26 @@ import { VulnerableComponent } from './vulnerable-component';
  * A possible remediation for a security problem.
  */
 export interface RemediationItem {
+    /**
+     * Assessment of the remediation item.
+     */
     assessment?: RemediationAssessment;
     entityIds?: string[];
     firstAffectedTimestamp?: number;
     id?: string;
+    /**
+     * The mute state of a remediation item of a security problem.
+     */
     muteState?: RemediationItemMuteState;
     name?: string;
+    /**
+     * The progress of this remediation item. It contains affected and unaffected entities.
+     */
     remediationProgress?: RemediationProgress;
     resolvedTimestamp?: number;
+    /**
+     * External tracking link URL associated with the remediable entity of the security problem.
+     */
     trackingLink?: TrackingLink;
     vulnerabilityState?: RemediationItemVulnerabilityState;
     /**

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute.d.ts

@@ -7,6 +7,9 @@ export interface RemediationItemsBulkMute {
      * A comment about the muting reason.
      */
     comment?: string;
+    /**
+     * The reason for muting the remediation items.
+     */
     reason: RemediationItemsBulkMuteReason;
     /**
      * The ids of the remediation items to be muted.

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute.d.ts

@@ -7,6 +7,9 @@ export interface RemediationItemsBulkUnmute {
      * A comment about the un-muting reason.
      */
     comment?: string;
+    /**
+     * The reason for un-muting the remediation items.
+     */
     reason: RemediationItemsBulkUnmuteReason;
     /**
      * The ids of the remediation items to be un-muted.

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto.d.ts

@@ -9,5 +9,12 @@ export interface RemediationItemsBulkUpdateDeleteDto {
      * List of remediation item IDs of the security problem for which to remove the tracking links.
      */
     deletes?: string[];
+    /**
+     * Tracking links to set for the security problem.
+     *
+     * Map of remediation item ID to tracking link objects.
+     *
+     * Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.
+     */
     updates?: RemediationItemsBulkUpdateDeleteDtoUpdates;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity-assessment.d.ts

@@ -8,6 +8,9 @@ export interface RemediationProgressEntityAssessment {
      * Whether a restart is required for the latest vulnerable function data.
      */
     vulnerableFunctionRestartRequired?: boolean;
+    /**
+     * The usage of vulnerable functions
+     */
     vulnerableFunctionUsage?: RemediationProgressEntityAssessmentVulnerableFunctionUsage;
     /**
      * A list of vulnerable functions that are in use.