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

package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config.d.ts

@@ -6,6 +6,15 @@ import { ExternalVaultConfigType } from './external-vault-config-type';
 export interface ExternalVaultConfig {
     credentialsUsedForExternalSynchronization?: string[];
     passwordSecretName?: string;
+    /**
+     * Defines the actual set of fields depending on the value. See one of the following objects:
+     *
+     * * `HASHICORP_VAULT_APPROLE` -> HashicorpApproleConfig
+     * * `HASHICORP_VAULT_CERTIFICATE` -> HashicorpCertificateConfig
+     * * `AZURE_KEY_VAULT_CLIENT_SECRET` -> AzureClientSecretConfig
+     * * `CYBERARK_VAULT_USERNAME_PASSWORD` -> CyberArkUsernamePasswordConfig
+     * * `CYBERARK_VAULT_ALLOWED_LOCATION` -> CyberArkAllowedLocationConfig
+     */
     sourceAuthMethod?: ExternalVaultConfigSourceAuthMethod;
     tokenSecretName?: string;
     type?: ExternalVaultConfigType;

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

@@ -11,6 +11,15 @@ export interface ExternalVault {
      * The name of the secret saved in external vault where password is stored.
      */
     passwordSecretName?: string;
+    /**
+     * Defines the actual set of fields depending on the value. See one of the following objects:
+     *
+     * * `HASHICORP_VAULT_APPROLE` -> HashicorpApprole
+     * * `HASHICORP_VAULT_CERTIFICATE` -> HashicorpCertificate
+     * * `AZURE_KEY_VAULT_CLIENT_SECRET` -> AzureClientSecret
+     * * `CYBERARK_VAULT_USERNAME_PASSWORD` -> CyberArkUsernamePassword
+     * * `CYBERARK_VAULT_ALLOWED_LOCATION` -> CyberArkAllowedLocationDto
+     */
     sourceAuthMethod?: ExternalVaultSourceAuthMethod;
     /**
      * The name of the secret saved in external vault where token is stored.

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

@@ -9,6 +9,9 @@ export interface Filter {
      * If the type is `not`, `and` or `or`, then holds the contained filters.
      */
     operands?: Filter[];
+    /**
+     * Invocation of a function, e.g. the `entitySelector` function.
+     */
     referenceInvocation?: Invocation;
     /**
      * For filters that match a dimension against a valkue, such as `eq` or `ne`, holds the value to compare the dimension against.
@@ -18,6 +21,9 @@ export interface Filter {
      * For the operands of `series` filters that match against a number, holds the number to compare against.
      */
     referenceValue?: number;
+    /**
+     * A way of viewing a series as a single value for the purpose of sorting or series-based filters.
+     */
     rollup?: Rollup;
     /**
      * If the type applies to a dimension, then holds the target dimension.
@@ -27,5 +33,25 @@ export interface Filter {
      * If the type applies to n dimensions, then holds the target dimensions. Currently only used for the `remainder` filter.
      */
     targetDimensions?: string[];
+    /**
+     * Type of this filter, determines which other fields are present.Can be any of:
+     * * `eq`,
+     * * `ne`,
+     * * `prefix`,
+     * * `in`,
+     * * `remainder`,
+     * * `suffix`,
+     * * `contains`,
+     * * `existsKey`,
+     * * `series`,
+     * * `or`,
+     * * `and`,
+     * * `not`,
+     * * `ge`,
+     * * `gt`,
+     * * `le`,
+     * * `lt`,
+     * * `otherwise`.
+     */
     type?: FilterType;
 }

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

@@ -19,6 +19,9 @@ export interface FunctionDefinition {
      * The function/method name of the function definition.
      */
     functionName?: string;
+    /**
+     * A list of values that has possibly been truncated.
+     */
     parameterTypes?: TruncatableListString;
     /**
      * The return type of the function.

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

@@ -4,7 +4,13 @@ import { TruncatableListHttpRequestParameter } from './truncatable-list-http-req
  * HTTP specific request details.
  */
 export interface HttpProtocolDetails {
+    /**
+     * A list of values that has possibly been truncated.
+     */
     headers?: TruncatableListAttackRequestHeader;
+    /**
+     * A list of values that has possibly been truncated.
+     */
     parameters?: TruncatableListHttpRequestParameter;
     /**
      * The HTTP request method.

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

@@ -0,0 +1,8 @@
+/**
+ * The type of the identity.
+ */
+export declare enum IdentityType {
+    AllUsers = "all-users",
+    Group = "group",
+    User = "user"
+}

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

@@ -0,0 +1,4 @@
+import { IdentityType } from './identity-type';
+export type AsJson = string;
+export declare function fromJson($model: AsJson): IdentityType;
+export declare function toJson($model: IdentityType): AsJson;

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

@@ -0,0 +1,14 @@
+import { IdentityType } from './identity-type';
+/**
+ * An Identity describing either a user, a group, or the all-users group (applying to all users).
+ */
+export interface Identity {
+    /**
+     * The user id or user group id if type is 'user' or 'group', missing if type is 'all-users'.
+     */
+    id?: string;
+    /**
+     * The type of the identity.
+     */
+    type: IdentityType;
+}

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

@@ -0,0 +1,8 @@
+import { Identity } from './identity';
+import * as _IdentityTypeTransformation from './identity-type.transformation';
+export interface AsJson {
+    id?: string;
+    type: _IdentityTypeTransformation.AsJson;
+}
+export declare function fromJson($model: AsJson): Identity;
+export declare function toJson($model: Identity): AsJson;

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

@@ -10,6 +10,17 @@ export interface Impact {
      * The estimated number of affected users.
      */
     estimatedAffectedUsers: number;
+    /**
+     * Defines the actual set of fields depending on the value. See one of the following objects:
+     *
+     * * `SERVICE` -> ServiceImpact
+     * * `APPLICATION` -> ApplicationImpact
+     * * `MOBILE` -> MobileImpact
+     * * `CUSTOM_APPLICATION` -> CustomApplicationImpact
+     */
     impactType: ImpactImpactType;
+    /**
+     * A short representation of a monitored entity.
+     */
     impactedEntity: EntityStub;
 }

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

@@ -24,8 +24,12 @@ export * from './active-gate-global-auto-update-config';
 export * as _ActiveGateGlobalAutoUpdateConfigTransformation from './active-gate-global-auto-update-config.transformation';
 export * from './active-gate-global-auto-update-config-global-setting';
 export * as _ActiveGateGlobalAutoUpdateConfigGlobalSettingTransformation from './active-gate-global-auto-update-config-global-setting.transformation';
+export * from './active-gate-group';
+export * as _ActiveGateGroupTransformation from './active-gate-group.transformation';
 export * from './active-gate-group-info-dto';
 export * as _ActiveGateGroupInfoDtoTransformation from './active-gate-group-info-dto.transformation';
+export * from './active-gate-groups';
+export * as _ActiveGateGroupsTransformation from './active-gate-groups.transformation';
 export * from './active-gate-groups-info-dto';
 export * as _ActiveGateGroupsInfoDtoTransformation from './active-gate-groups-info-dto.transformation';
 export * from './active-gate-info-dto';
@@ -510,6 +514,10 @@ export * from './http-protocol-details';
 export * as _HttpProtocolDetailsTransformation from './http-protocol-details.transformation';
 export * from './http-request-parameter';
 export * as _HttpRequestParameterTransformation from './http-request-parameter.transformation';
+export * from './identity';
+export * as _IdentityTransformation from './identity.transformation';
+export * from './identity-type';
+export * as _IdentityTypeTransformation from './identity-type.transformation';
 export * from './impact';
 export * as _ImpactTransformation from './impact.transformation';
 export * from './impact-analysis';

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

@@ -11,6 +11,9 @@ export interface Item {
      * A list of constraints limiting the values to be accepted.
      */
     constraints?: Constraint[];
+    /**
+     * Configuration of a datasource for a property.
+     */
     datasource?: DatasourceDefinition;
     /**
      * A short description of the item.
@@ -24,6 +27,9 @@ export interface Item {
      * An extended description and/or links to documentation.
      */
     documentation?: string;
+    /**
+     * Metadata of the items.
+     */
     metadata?: ItemMetadata;
     /**
      * The type referenced by the item's value.
@@ -37,5 +43,8 @@ export interface Item {
      * The type of the item's value.
      */
     type: string | RefPointer;
+    /**
+     * Customization for UI elements
+     */
     uiCustomization?: UiCustomization;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/list-credentials-query-type.d.ts

@@ -1,5 +1,6 @@
 export declare enum ListCredentialsQueryType {
     Certificate = "CERTIFICATE",
     UsernamePassword = "USERNAME_PASSWORD",
-    Token = "TOKEN"
+    Token = "TOKEN",
+    Snmpv3 = "SNMPV3"
 }

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

@@ -10,6 +10,11 @@ export interface LocationCollectionElement {
      * The list of location's capabilities.
      */
     capabilities?: string[];
+    /**
+     * The cloud provider where the location is hosted.
+     *
+     *  Only applicable to `PUBLIC` locations.
+     */
     cloudPlatform?: LocationCollectionElementCloudPlatform;
     /**
      * The Dynatrace entity ID of the location.
@@ -49,7 +54,16 @@ export interface LocationCollectionElement {
      * The name of the location.
      */
     name: string;
+    /**
+     * The release stage of the location.
+     */
     stage?: LocationCollectionElementStage;
+    /**
+     * The status of the location.
+     */
     status?: LocationCollectionElementStatus;
+    /**
+     * The type of the location.
+     */
     type: LocationCollectionElementType;
 }

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

@@ -5,12 +5,21 @@ import { LogRecordStatus } from './log-record-status';
  * A single log record.
  */
 export interface LogRecord {
+    /**
+     * Additional columns of the log record.
+     */
     additionalColumns?: LogRecordAdditionalColumns;
     /**
      * The content of the log record.
      */
     content?: string;
+    /**
+     * Type of event
+     */
     eventType?: LogRecordEventType;
+    /**
+     * The log status (based on the log level).
+     */
     status?: LogRecordStatus;
     /**
      * The timestamp of the log record, in UTC milliseconds.

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/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/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,8 +31,17 @@ 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.
@@ -50,6 +59,9 @@ export interface Problem {
      * 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.
@@ -63,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/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

@@ -8,9 +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.
@@ -20,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.