@dynatrace-sdk/client-classic-environment-v2 0.6.8 → 0.6.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/LICENSE +174 -0
- package/cjs/index.js +1098 -1027
- package/docs/DOCS.md +362 -96
- package/dynatrace-metadata.json +1 -1
- package/esm/index.js +1099 -1027
- package/package.json +3 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +10 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +24 -24
- package/types/packages/client/classic-environment-v2/src/lib/apis/hub-items-api.d.ts +11 -11
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +8 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +12 -12
- package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-created.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-info-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-created.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +15 -15
- package/types/packages/client/classic-environment-v2/src/lib/models/comment.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/configuration-metadata.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-config.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password-config.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/datasource-definition.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/deletion-constraint.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/description-block.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-value.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-icon.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-value.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/error.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-evidence.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-results.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-details.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/event-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +16 -16
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release.d.ts +31 -19
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-details.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-release.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/extension2-details.d.ts +12 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/filter.d.ts +11 -11
- package/types/packages/client/classic-environment-v2/src/lib/models/image.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/invocation.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/item-details.d.ts +29 -29
- package/types/packages/client/classic-environment-v2/src/lib/models/item-overview.d.ts +5 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-default-aggregation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor.d.ts +19 -19
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-dimension-cardinality.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-ingest-error.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-state-param.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone-fallback-mode.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +8 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/object-node.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +21 -21
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +11 -11
- package/types/packages/client/classic-environment-v2/src/lib/models/related-item.d.ts +5 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/release.d.ts +24 -24
- package/types/packages/client/classic-environment-v2/src/lib/models/rollup.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-type.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.d.ts +12 -12
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.d.ts +24 -24
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +25 -25
- package/types/packages/client/classic-environment-v2/src/lib/models/success.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-execution-stage.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-custom-script.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status-execution-stage.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/technology-details.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-customization.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-expandable-section-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-tab-group-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/upload-extension-body.d.ts +0 -18
|
@@ -13,37 +13,37 @@ import { ProblemStatus, _ProblemStatusTransformation } from './problem-status';
|
|
|
13
13
|
* The properties of a problem.
|
|
14
14
|
*/
|
|
15
15
|
export interface Problem {
|
|
16
|
-
|
|
16
|
+
impactLevel: ProblemImpactLevel;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* The display ID of the problem.
|
|
19
19
|
*/
|
|
20
|
-
|
|
20
|
+
displayId: string;
|
|
21
21
|
/**
|
|
22
|
-
* A list of all entities that are
|
|
22
|
+
* A list of all entities that are affected by the problem.
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
affectedEntities: EntityStub[];
|
|
25
25
|
evidenceDetails?: EvidenceDetails;
|
|
26
26
|
recentComments?: CommentsList;
|
|
27
27
|
impactAnalysis?: ImpactAnalysis;
|
|
28
28
|
rootCauseEntity?: EntityStub;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* A list of all entities that are impacted by the problem.
|
|
31
31
|
*/
|
|
32
|
-
|
|
33
|
-
|
|
32
|
+
impactedEntities: EntityStub[];
|
|
33
|
+
linkedProblemInfo?: LinkedProblem;
|
|
34
34
|
/**
|
|
35
|
-
* A list of
|
|
35
|
+
* A list of alerting profiles that match the problem.
|
|
36
36
|
*/
|
|
37
|
-
|
|
37
|
+
problemFilters: AlertingProfileStub[];
|
|
38
|
+
/**
|
|
39
|
+
* The ID of the problem.
|
|
40
|
+
*/
|
|
41
|
+
problemId: string;
|
|
38
42
|
severityLevel: ProblemSeverityLevel;
|
|
39
43
|
/**
|
|
40
44
|
* A list of all entity tags of the problem.
|
|
41
45
|
*/
|
|
42
46
|
entityTags?: METag[];
|
|
43
|
-
/**
|
|
44
|
-
* The ID of the problem.
|
|
45
|
-
*/
|
|
46
|
-
problemId: string;
|
|
47
47
|
/**
|
|
48
48
|
* A list of all management zones that the problem belongs to.
|
|
49
49
|
*/
|
|
@@ -67,19 +67,19 @@ export interface Problem {
|
|
|
67
67
|
/** @ignore */
|
|
68
68
|
export declare namespace _ProblemTransformation {
|
|
69
69
|
interface AsJson {
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
70
|
+
impactLevel: _ProblemImpactLevelTransformation.AsJson;
|
|
71
|
+
displayId: string;
|
|
72
|
+
affectedEntities: _EntityStubTransformation.AsJson[];
|
|
73
73
|
evidenceDetails?: _EvidenceDetailsTransformation.AsJson;
|
|
74
74
|
recentComments?: _CommentsListTransformation.AsJson;
|
|
75
75
|
impactAnalysis?: _ImpactAnalysisTransformation.AsJson;
|
|
76
76
|
rootCauseEntity?: _EntityStubTransformation.AsJson;
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
77
|
+
impactedEntities: _EntityStubTransformation.AsJson[];
|
|
78
|
+
linkedProblemInfo?: _LinkedProblemTransformation.AsJson;
|
|
79
|
+
problemFilters: _AlertingProfileStubTransformation.AsJson[];
|
|
80
|
+
problemId: string;
|
|
80
81
|
severityLevel: _ProblemSeverityLevelTransformation.AsJson;
|
|
81
82
|
entityTags?: _METagTransformation.AsJson[];
|
|
82
|
-
problemId: string;
|
|
83
83
|
managementZones: _ManagementZoneTransformation.AsJson[];
|
|
84
84
|
status: _ProblemStatusTransformation.AsJson;
|
|
85
85
|
startTime: number;
|
package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts
CHANGED
|
@@ -29,19 +29,21 @@ export interface PropertyDefinition {
|
|
|
29
29
|
minObjects?: number;
|
|
30
30
|
modificationPolicy?: PropertyDefinitionModificationPolicy;
|
|
31
31
|
precondition?: Precondition;
|
|
32
|
-
items?: Item;
|
|
33
32
|
/**
|
|
34
33
|
* The type referenced by the property value
|
|
35
34
|
*/
|
|
36
35
|
referencedType?: string;
|
|
37
|
-
|
|
38
|
-
* The subtype of the property's value.
|
|
39
|
-
*/
|
|
40
|
-
subType?: string;
|
|
36
|
+
items?: Item;
|
|
41
37
|
/**
|
|
42
38
|
* The display name of the property.
|
|
43
39
|
*/
|
|
44
40
|
displayName?: string;
|
|
41
|
+
/**
|
|
42
|
+
* The subtype of the property's value.
|
|
43
|
+
*/
|
|
44
|
+
subType?: string;
|
|
45
|
+
default?: PropertyDefinitionDefault;
|
|
46
|
+
type: PropertyDefinitionType;
|
|
45
47
|
/**
|
|
46
48
|
* A short description of the property.
|
|
47
49
|
*/
|
|
@@ -55,8 +57,6 @@ export interface PropertyDefinition {
|
|
|
55
57
|
* The value can (`true`) or can't (`false`) be `null`.
|
|
56
58
|
*/
|
|
57
59
|
nullable: boolean;
|
|
58
|
-
default?: PropertyDefinitionDefault;
|
|
59
|
-
type: PropertyDefinitionType;
|
|
60
60
|
}
|
|
61
61
|
/** @ignore */
|
|
62
62
|
export declare namespace _PropertyDefinitionTransformation {
|
|
@@ -68,16 +68,16 @@ export declare namespace _PropertyDefinitionTransformation {
|
|
|
68
68
|
minObjects?: number;
|
|
69
69
|
modificationPolicy?: _PropertyDefinitionModificationPolicyTransformation.AsJson;
|
|
70
70
|
precondition?: _PreconditionTransformation.AsJson;
|
|
71
|
-
items?: _ItemTransformation.AsJson;
|
|
72
71
|
referencedType?: string;
|
|
73
|
-
|
|
72
|
+
items?: _ItemTransformation.AsJson;
|
|
74
73
|
displayName?: string;
|
|
74
|
+
subType?: string;
|
|
75
|
+
default?: _PropertyDefinitionDefaultTransformation.AsJson;
|
|
76
|
+
type: _PropertyDefinitionTypeTransformation.AsJson;
|
|
75
77
|
description?: string;
|
|
76
78
|
metadata?: _PropertyDefinitionMetadataTransformation.AsJson;
|
|
77
79
|
constraints?: _ConstraintTransformation.AsJson[];
|
|
78
80
|
nullable: boolean;
|
|
79
|
-
default?: _PropertyDefinitionDefaultTransformation.AsJson;
|
|
80
|
-
type: _PropertyDefinitionTypeTransformation.AsJson;
|
|
81
81
|
}
|
|
82
82
|
function fromJson(model: AsJson): PropertyDefinition;
|
|
83
83
|
function toJson(model: PropertyDefinition): AsJson;
|
|
@@ -7,7 +7,10 @@ export interface RelatedItem {
|
|
|
7
7
|
id?: string;
|
|
8
8
|
name?: string;
|
|
9
9
|
description?: string;
|
|
10
|
-
|
|
10
|
+
/**
|
|
11
|
+
* The logo of the item. Can be a URL or Base64 encoded. Intended for <image> html tags
|
|
12
|
+
*/
|
|
13
|
+
logo?: string;
|
|
11
14
|
/**
|
|
12
15
|
* External link (marketing/documentation) that can provide with additional information.
|
|
13
16
|
*/
|
|
@@ -24,7 +27,7 @@ export declare namespace _RelatedItemTransformation {
|
|
|
24
27
|
id?: string;
|
|
25
28
|
name?: string;
|
|
26
29
|
description?: string;
|
|
27
|
-
|
|
30
|
+
logo?: string;
|
|
28
31
|
externalLink?: string;
|
|
29
32
|
hasClusterLink?: boolean;
|
|
30
33
|
}
|
|
@@ -10,17 +10,9 @@ import { SoftwareTechs, _SoftwareTechsTransformation } from './software-techs';
|
|
|
10
10
|
*/
|
|
11
11
|
export interface Release {
|
|
12
12
|
/**
|
|
13
|
-
* The
|
|
14
|
-
*/
|
|
15
|
-
softwareTechs?: SoftwareTechs[];
|
|
16
|
-
/**
|
|
17
|
-
* The count of bytes per second of the entity
|
|
18
|
-
*/
|
|
19
|
-
throughput?: number;
|
|
20
|
-
/**
|
|
21
|
-
* The entity id of correlating release.
|
|
13
|
+
* The instances entityIds included in this release
|
|
22
14
|
*/
|
|
23
|
-
|
|
15
|
+
instances?: ReleaseInstance[];
|
|
24
16
|
/**
|
|
25
17
|
* The number of security vulnerabilities of the entity
|
|
26
18
|
*/
|
|
@@ -33,6 +25,10 @@ export interface Release {
|
|
|
33
25
|
* Indicates that the security vulnerabilities feature is enabled
|
|
34
26
|
*/
|
|
35
27
|
securityVulnerabilitiesEnabled?: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* The entity id of correlating release.
|
|
30
|
+
*/
|
|
31
|
+
releaseEntityId?: string;
|
|
36
32
|
/**
|
|
37
33
|
* The product name
|
|
38
34
|
*/
|
|
@@ -42,17 +38,25 @@ export interface Release {
|
|
|
42
38
|
*/
|
|
43
39
|
affectedBySecurityVulnerabilities?: boolean;
|
|
44
40
|
/**
|
|
45
|
-
* The
|
|
41
|
+
* The count of bytes per second of the entity
|
|
46
42
|
*/
|
|
47
|
-
|
|
43
|
+
throughput?: number;
|
|
48
44
|
/**
|
|
49
|
-
* The
|
|
45
|
+
* The software technologies of the release
|
|
50
46
|
*/
|
|
51
|
-
|
|
47
|
+
softwareTechs?: SoftwareTechs[];
|
|
52
48
|
/**
|
|
53
49
|
* The identified release version
|
|
54
50
|
*/
|
|
55
51
|
version?: string;
|
|
52
|
+
/**
|
|
53
|
+
* The related PGI is still running/monitored
|
|
54
|
+
*/
|
|
55
|
+
running?: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* The entity name
|
|
58
|
+
*/
|
|
59
|
+
name?: string;
|
|
56
60
|
/**
|
|
57
61
|
* The number of problems of the entity
|
|
58
62
|
*/
|
|
@@ -61,28 +65,24 @@ export interface Release {
|
|
|
61
65
|
* The stage name
|
|
62
66
|
*/
|
|
63
67
|
stage?: string;
|
|
64
|
-
/**
|
|
65
|
-
* The entity name
|
|
66
|
-
*/
|
|
67
|
-
name?: string;
|
|
68
68
|
}
|
|
69
69
|
/** @ignore */
|
|
70
70
|
export declare namespace _ReleaseTransformation {
|
|
71
71
|
interface AsJson {
|
|
72
|
-
|
|
73
|
-
throughput?: number;
|
|
74
|
-
releaseEntityId?: string;
|
|
72
|
+
instances?: _ReleaseInstanceTransformation.AsJson[];
|
|
75
73
|
securityVulnerabilitiesCount?: number;
|
|
76
74
|
affectedByProblems?: boolean;
|
|
77
75
|
securityVulnerabilitiesEnabled?: boolean;
|
|
76
|
+
releaseEntityId?: string;
|
|
78
77
|
product?: string;
|
|
79
78
|
affectedBySecurityVulnerabilities?: boolean;
|
|
80
|
-
|
|
81
|
-
|
|
79
|
+
throughput?: number;
|
|
80
|
+
softwareTechs?: _SoftwareTechsTransformation.AsJson[];
|
|
82
81
|
version?: string;
|
|
82
|
+
running?: boolean;
|
|
83
|
+
name?: string;
|
|
83
84
|
problemCount?: number;
|
|
84
85
|
stage?: string;
|
|
85
|
-
name?: string;
|
|
86
86
|
}
|
|
87
87
|
function fromJson(model: AsJson): Release;
|
|
88
88
|
function toJson(model: Release): AsJson;
|
|
@@ -3,14 +3,14 @@ import { RollupType, _RollupTypeTransformation } from './rollup-type';
|
|
|
3
3
|
* A way of viewing a series as a single value for the purpose of sorting or series-based filters.
|
|
4
4
|
*/
|
|
5
5
|
export interface Rollup {
|
|
6
|
-
parameter?: number;
|
|
7
6
|
type?: RollupType;
|
|
7
|
+
parameter?: number;
|
|
8
8
|
}
|
|
9
9
|
/** @ignore */
|
|
10
10
|
export declare namespace _RollupTransformation {
|
|
11
11
|
interface AsJson {
|
|
12
|
-
parameter?: number;
|
|
13
12
|
type?: _RollupTypeTransformation.AsJson;
|
|
13
|
+
parameter?: number;
|
|
14
14
|
}
|
|
15
15
|
function fromJson(model: AsJson): Rollup;
|
|
16
16
|
function toJson(model: Rollup): AsJson;
|
|
@@ -22,11 +22,11 @@ export interface SchemaType {
|
|
|
22
22
|
* The version of the type.
|
|
23
23
|
*/
|
|
24
24
|
version: string;
|
|
25
|
+
properties: SchemaTypeProperties;
|
|
25
26
|
/**
|
|
26
27
|
* A list of constraints limiting the values to be accepted.
|
|
27
28
|
*/
|
|
28
29
|
constraints?: ComplexConstraint[];
|
|
29
|
-
properties: SchemaTypeProperties;
|
|
30
30
|
/**
|
|
31
31
|
* An extended description and/or links to documentation.
|
|
32
32
|
*/
|
|
@@ -47,8 +47,8 @@ export declare namespace _SchemaTypeTransformation {
|
|
|
47
47
|
searchPattern?: string;
|
|
48
48
|
versionInfo?: string;
|
|
49
49
|
version: string;
|
|
50
|
-
constraints?: _ComplexConstraintTransformation.AsJson[];
|
|
51
50
|
properties: _SchemaTypePropertiesTransformation.AsJson;
|
|
51
|
+
constraints?: _ComplexConstraintTransformation.AsJson[];
|
|
52
52
|
documentation: string;
|
|
53
53
|
displayName?: string;
|
|
54
54
|
description: string;
|
package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts
CHANGED
|
@@ -9,20 +9,21 @@ export interface SettingsObjectCreate {
|
|
|
9
9
|
* Only applicable if an external identifier is provided.
|
|
10
10
|
*/
|
|
11
11
|
objectId?: string;
|
|
12
|
-
/**
|
|
13
|
-
* The schema on which the object is based.
|
|
14
|
-
*/
|
|
15
|
-
schemaId: string;
|
|
16
12
|
/**
|
|
17
13
|
* External identifier for the object being created
|
|
18
14
|
*/
|
|
19
15
|
externalId?: string;
|
|
16
|
+
/**
|
|
17
|
+
* The schema on which the object is based.
|
|
18
|
+
*/
|
|
19
|
+
schemaId: string;
|
|
20
20
|
/**
|
|
21
21
|
* The scope that the object targets.
|
|
22
22
|
*
|
|
23
23
|
* If omitted on creation of a new object and if the schema supports scope generation, the operation will generate a scope from the provided value.
|
|
24
24
|
*/
|
|
25
25
|
scope?: string;
|
|
26
|
+
value: SettingsValue;
|
|
26
27
|
/**
|
|
27
28
|
* The version of the schema on which the object is based.
|
|
28
29
|
*/
|
|
@@ -37,18 +38,17 @@ export interface SettingsObjectCreate {
|
|
|
37
38
|
* Only applicable for objects based on schemas with ordered objects (schema's `ordered` parameter is set to `true`).
|
|
38
39
|
*/
|
|
39
40
|
insertAfter?: string;
|
|
40
|
-
value: SettingsValue;
|
|
41
41
|
}
|
|
42
42
|
/** @ignore */
|
|
43
43
|
export declare namespace _SettingsObjectCreateTransformation {
|
|
44
44
|
interface AsJson {
|
|
45
45
|
objectId?: string;
|
|
46
|
-
schemaId: string;
|
|
47
46
|
externalId?: string;
|
|
47
|
+
schemaId: string;
|
|
48
48
|
scope?: string;
|
|
49
|
+
value: _SettingsValueTransformation.AsJson;
|
|
49
50
|
schemaVersion?: string;
|
|
50
51
|
insertAfter?: string;
|
|
51
|
-
value: _SettingsValueTransformation.AsJson;
|
|
52
52
|
}
|
|
53
53
|
function fromJson(model: AsJson): SettingsObjectCreate;
|
|
54
54
|
function toJson(model: SettingsObjectCreate): AsJson;
|
package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.d.ts
CHANGED
|
@@ -4,11 +4,11 @@ import { SettingsValue, _SettingsValueTransformation } from './settings-value';
|
|
|
4
4
|
* The response to a creation- or update-request.
|
|
5
5
|
*/
|
|
6
6
|
export interface SettingsObjectResponse {
|
|
7
|
+
invalidValue?: SettingsValue;
|
|
7
8
|
/**
|
|
8
9
|
* For a successful request, the ID of the created or modified settings object.
|
|
9
10
|
*/
|
|
10
11
|
objectId?: string;
|
|
11
|
-
invalidValue?: SettingsValue;
|
|
12
12
|
/**
|
|
13
13
|
* The HTTP status code for the object.
|
|
14
14
|
*/
|
|
@@ -18,8 +18,8 @@ export interface SettingsObjectResponse {
|
|
|
18
18
|
/** @ignore */
|
|
19
19
|
export declare namespace _SettingsObjectResponseTransformation {
|
|
20
20
|
interface AsJson {
|
|
21
|
-
objectId?: string;
|
|
22
21
|
invalidValue?: _SettingsValueTransformation.AsJson;
|
|
22
|
+
objectId?: string;
|
|
23
23
|
code: number;
|
|
24
24
|
error?: _ErrorTransformation.AsJson;
|
|
25
25
|
}
|
package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { SettingsValue, _SettingsValueTransformation } from './settings-value';
|
|
|
3
3
|
* An update of a settings object.
|
|
4
4
|
*/
|
|
5
5
|
export interface SettingsObjectUpdate {
|
|
6
|
+
value: SettingsValue;
|
|
6
7
|
/**
|
|
7
8
|
* The version of the schema on which the object is based.
|
|
8
9
|
*/
|
|
@@ -39,16 +40,15 @@ export interface SettingsObjectUpdate {
|
|
|
39
40
|
* Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
|
|
40
41
|
*/
|
|
41
42
|
insertBefore?: string;
|
|
42
|
-
value: SettingsValue;
|
|
43
43
|
}
|
|
44
44
|
/** @ignore */
|
|
45
45
|
export declare namespace _SettingsObjectUpdateTransformation {
|
|
46
46
|
interface AsJson {
|
|
47
|
+
value: _SettingsValueTransformation.AsJson;
|
|
47
48
|
schemaVersion?: string;
|
|
48
49
|
updateToken?: string;
|
|
49
50
|
insertAfter?: string;
|
|
50
51
|
insertBefore?: string;
|
|
51
|
-
value: _SettingsValueTransformation.AsJson;
|
|
52
52
|
}
|
|
53
53
|
function fromJson(model: AsJson): SettingsObjectUpdate;
|
|
54
54
|
function toJson(model: SettingsObjectUpdate): AsJson;
|
|
@@ -7,10 +7,6 @@ export interface SettingsObject {
|
|
|
7
7
|
* The timestamp of the creation.
|
|
8
8
|
*/
|
|
9
9
|
created?: number;
|
|
10
|
-
/**
|
|
11
|
-
* The schema on which the object is based.
|
|
12
|
-
*/
|
|
13
|
-
schemaId?: string;
|
|
14
10
|
/**
|
|
15
11
|
* The timestamp of the last modification.
|
|
16
12
|
*/
|
|
@@ -23,10 +19,15 @@ export interface SettingsObject {
|
|
|
23
19
|
* The external identifier of the settings object.
|
|
24
20
|
*/
|
|
25
21
|
externalId?: string;
|
|
22
|
+
/**
|
|
23
|
+
* The schema on which the object is based.
|
|
24
|
+
*/
|
|
25
|
+
schemaId?: string;
|
|
26
26
|
/**
|
|
27
27
|
* The scope that the object targets.
|
|
28
28
|
*/
|
|
29
29
|
scope?: string;
|
|
30
|
+
value?: SettingsValue;
|
|
30
31
|
/**
|
|
31
32
|
* The ID of the settings object.
|
|
32
33
|
*/
|
|
@@ -51,23 +52,22 @@ export interface SettingsObject {
|
|
|
51
52
|
* A short summary of settings. This can contain Markdown and will be escaped accordingly.
|
|
52
53
|
*/
|
|
53
54
|
summary?: string;
|
|
54
|
-
value?: SettingsValue;
|
|
55
55
|
}
|
|
56
56
|
/** @ignore */
|
|
57
57
|
export declare namespace _SettingsObjectTransformation {
|
|
58
58
|
interface AsJson {
|
|
59
59
|
created?: number;
|
|
60
|
-
schemaId?: string;
|
|
61
60
|
modified?: number;
|
|
62
61
|
author?: string;
|
|
63
62
|
externalId?: string;
|
|
63
|
+
schemaId?: string;
|
|
64
64
|
scope?: string;
|
|
65
|
+
value?: _SettingsValueTransformation.AsJson;
|
|
65
66
|
objectId?: string;
|
|
66
67
|
schemaVersion?: string;
|
|
67
68
|
updateToken?: string;
|
|
68
69
|
searchSummary?: string;
|
|
69
70
|
summary?: string;
|
|
70
|
-
value?: _SettingsValueTransformation.AsJson;
|
|
71
71
|
}
|
|
72
72
|
function fromJson(model: AsJson): SettingsObject;
|
|
73
73
|
function toJson(model: SettingsObject): AsJson;
|
|
@@ -3,6 +3,15 @@ import { SloBurnRateBurnRateType, _SloBurnRateBurnRateTypeTransformation } from
|
|
|
3
3
|
* Error budget burn rate evaluation of a service-level objective (SLO).
|
|
4
4
|
*/
|
|
5
5
|
export interface SloBurnRate {
|
|
6
|
+
burnRateType?: SloBurnRateBurnRateType;
|
|
7
|
+
/**
|
|
8
|
+
* The burn rate of the SLO, calculated for the last hour.
|
|
9
|
+
*/
|
|
10
|
+
burnRateValue?: number;
|
|
11
|
+
/**
|
|
12
|
+
* The estimated time left to consume the error budget in hours.
|
|
13
|
+
*/
|
|
14
|
+
estimatedTimeToConsumeErrorBudget?: number;
|
|
6
15
|
/**
|
|
7
16
|
* The error budget burn rate visualization is enabled (`true`) or disabled (`false`).
|
|
8
17
|
*
|
|
@@ -13,29 +22,20 @@ export interface SloBurnRate {
|
|
|
13
22
|
* The threshold between a slow and a fast burn rate.
|
|
14
23
|
*/
|
|
15
24
|
fastBurnThreshold?: number;
|
|
16
|
-
burnRateType?: SloBurnRateBurnRateType;
|
|
17
|
-
/**
|
|
18
|
-
* The burn rate of the SLO, calculated for the last hour.
|
|
19
|
-
*/
|
|
20
|
-
burnRateValue?: number;
|
|
21
25
|
/**
|
|
22
26
|
* The calculated value of the SLO for the timeframe chosen for the burn rate calculation.
|
|
23
27
|
*/
|
|
24
28
|
sloValue?: number;
|
|
25
|
-
/**
|
|
26
|
-
* The estimated time left to consume the error budget in hours.
|
|
27
|
-
*/
|
|
28
|
-
estimatedTimeToConsumeErrorBudget?: number;
|
|
29
29
|
}
|
|
30
30
|
/** @ignore */
|
|
31
31
|
export declare namespace _SloBurnRateTransformation {
|
|
32
32
|
interface AsJson {
|
|
33
|
-
burnRateVisualizationEnabled?: boolean;
|
|
34
|
-
fastBurnThreshold?: number;
|
|
35
33
|
burnRateType?: _SloBurnRateBurnRateTypeTransformation.AsJson;
|
|
36
34
|
burnRateValue?: number;
|
|
37
|
-
sloValue?: number;
|
|
38
35
|
estimatedTimeToConsumeErrorBudget?: number;
|
|
36
|
+
burnRateVisualizationEnabled?: boolean;
|
|
37
|
+
fastBurnThreshold?: number;
|
|
38
|
+
sloValue?: number;
|
|
39
39
|
}
|
|
40
40
|
function fromJson(model: AsJson): SloBurnRate;
|
|
41
41
|
function toJson(model: SloBurnRate): AsJson;
|
package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.d.ts
CHANGED
|
@@ -21,6 +21,26 @@ export interface SloConfigItemDtoImpl {
|
|
|
21
21
|
* The percentage-based metric expression for the calculation of the SLO.
|
|
22
22
|
*/
|
|
23
23
|
metricExpression?: string;
|
|
24
|
+
evaluationType?: SloConfigItemDtoImplEvaluationType;
|
|
25
|
+
/**
|
|
26
|
+
* The entity filter for the SLO evaluation. Use the [syntax of entity selector](https://dt-url.net/entityselector).
|
|
27
|
+
*/
|
|
28
|
+
filter?: string;
|
|
29
|
+
/**
|
|
30
|
+
* The target value of the SLO.
|
|
31
|
+
*/
|
|
32
|
+
target?: number;
|
|
33
|
+
/**
|
|
34
|
+
* The warning value of the SLO.
|
|
35
|
+
*
|
|
36
|
+
* At warning state the SLO is still fulfilled but is getting close to failure.
|
|
37
|
+
*/
|
|
38
|
+
warning?: number;
|
|
39
|
+
errorBudgetBurnRate?: SloBurnRateConfig;
|
|
40
|
+
/**
|
|
41
|
+
* The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
|
|
42
|
+
*/
|
|
43
|
+
timeframe?: string;
|
|
24
44
|
/**
|
|
25
45
|
* The type of the metric to use for SLO calculation:
|
|
26
46
|
*
|
|
@@ -48,26 +68,6 @@ export interface SloConfigItemDtoImpl {
|
|
|
48
68
|
* Required when the **useRateMetric** is set to `false`.
|
|
49
69
|
*/
|
|
50
70
|
metricDenominator?: string;
|
|
51
|
-
evaluationType?: SloConfigItemDtoImplEvaluationType;
|
|
52
|
-
/**
|
|
53
|
-
* The entity filter for the SLO evaluation. Use the [syntax of entity selector](https://dt-url.net/entityselector).
|
|
54
|
-
*/
|
|
55
|
-
filter?: string;
|
|
56
|
-
/**
|
|
57
|
-
* The target value of the SLO.
|
|
58
|
-
*/
|
|
59
|
-
target?: number;
|
|
60
|
-
/**
|
|
61
|
-
* The warning value of the SLO.
|
|
62
|
-
*
|
|
63
|
-
* At warning state the SLO is still fulfilled but is getting close to failure.
|
|
64
|
-
*/
|
|
65
|
-
warning?: number;
|
|
66
|
-
errorBudgetBurnRate?: SloBurnRateConfig;
|
|
67
|
-
/**
|
|
68
|
-
* The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
|
|
69
|
-
*/
|
|
70
|
-
timeframe?: string;
|
|
71
71
|
}
|
|
72
72
|
/** @ignore */
|
|
73
73
|
export declare namespace _SloConfigItemDtoImplTransformation {
|
|
@@ -77,16 +77,16 @@ export declare namespace _SloConfigItemDtoImplTransformation {
|
|
|
77
77
|
description?: string;
|
|
78
78
|
metricName?: string;
|
|
79
79
|
metricExpression?: string;
|
|
80
|
-
useRateMetric?: boolean | null;
|
|
81
|
-
metricRate?: string;
|
|
82
|
-
metricNumerator?: string;
|
|
83
|
-
metricDenominator?: string;
|
|
84
80
|
evaluationType?: _SloConfigItemDtoImplEvaluationTypeTransformation.AsJson;
|
|
85
81
|
filter?: string;
|
|
86
82
|
target?: number;
|
|
87
83
|
warning?: number;
|
|
88
84
|
errorBudgetBurnRate?: _SloBurnRateConfigTransformation.AsJson;
|
|
89
85
|
timeframe?: string;
|
|
86
|
+
useRateMetric?: boolean | null;
|
|
87
|
+
metricRate?: string;
|
|
88
|
+
metricNumerator?: string;
|
|
89
|
+
metricDenominator?: string;
|
|
90
90
|
}
|
|
91
91
|
function fromJson(model: AsJson): SloConfigItemDtoImpl;
|
|
92
92
|
function toJson(model: SloConfigItemDtoImpl): AsJson;
|
|
@@ -9,6 +9,12 @@ export interface SLO {
|
|
|
9
9
|
* 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.
|
|
10
10
|
*/
|
|
11
11
|
problemFilters?: string[];
|
|
12
|
+
/**
|
|
13
|
+
* The error budget of the calculated SLO.
|
|
14
|
+
*
|
|
15
|
+
* The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.
|
|
16
|
+
*/
|
|
17
|
+
errorBudget?: number;
|
|
12
18
|
/**
|
|
13
19
|
* The percentage-based metric expression for the calculation of the SLO.
|
|
14
20
|
*/
|
|
@@ -43,11 +49,9 @@ export interface SLO {
|
|
|
43
49
|
evaluationType?: SLOEvaluationType;
|
|
44
50
|
errorBudgetBurnRate?: SloBurnRate;
|
|
45
51
|
/**
|
|
46
|
-
* The error budget
|
|
47
|
-
*
|
|
48
|
-
* The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.
|
|
52
|
+
* The error budget burn rate key for a metric expression.
|
|
49
53
|
*/
|
|
50
|
-
|
|
54
|
+
burnRateMetricKey?: string;
|
|
51
55
|
/**
|
|
52
56
|
* The calculated value of the SLO. Has the value of the evaluated SLO or the value of `-1`:
|
|
53
57
|
*
|
|
@@ -55,10 +59,6 @@ export interface SLO {
|
|
|
55
59
|
* * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
|
|
56
60
|
*/
|
|
57
61
|
evaluatedPercentage?: number;
|
|
58
|
-
/**
|
|
59
|
-
* The error budget burn rate key for a metric expression.
|
|
60
|
-
*/
|
|
61
|
-
burnRateMetricKey?: string;
|
|
62
62
|
/**
|
|
63
63
|
* The error budget key for a metric expression.
|
|
64
64
|
*/
|
|
@@ -99,6 +99,18 @@ export interface SLO {
|
|
|
99
99
|
* The entity filter for the SLO evaluation. Use the [syntax of entity selector](https://dt-url.net/entityselector).
|
|
100
100
|
*/
|
|
101
101
|
filter?: string;
|
|
102
|
+
/**
|
|
103
|
+
* The name of the SLO.
|
|
104
|
+
*/
|
|
105
|
+
name?: string;
|
|
106
|
+
/**
|
|
107
|
+
* The ID of the SLO
|
|
108
|
+
*/
|
|
109
|
+
id?: string;
|
|
110
|
+
/**
|
|
111
|
+
* The target value of the SLO.
|
|
112
|
+
*/
|
|
113
|
+
target?: number;
|
|
102
114
|
/**
|
|
103
115
|
* A short description of the SLO.
|
|
104
116
|
*/
|
|
@@ -120,23 +132,12 @@ export interface SLO {
|
|
|
120
132
|
* At warning state the SLO is still fulfilled but is getting close to failure.
|
|
121
133
|
*/
|
|
122
134
|
warning?: number;
|
|
123
|
-
/**
|
|
124
|
-
* The name of the SLO.
|
|
125
|
-
*/
|
|
126
|
-
name?: string;
|
|
127
|
-
/**
|
|
128
|
-
* The ID of the SLO
|
|
129
|
-
*/
|
|
130
|
-
id?: string;
|
|
131
|
-
/**
|
|
132
|
-
* The target value of the SLO.
|
|
133
|
-
*/
|
|
134
|
-
target?: number;
|
|
135
135
|
}
|
|
136
136
|
/** @ignore */
|
|
137
137
|
export declare namespace _SLOTransformation {
|
|
138
138
|
interface AsJson {
|
|
139
139
|
problemFilters?: string[];
|
|
140
|
+
errorBudget?: number;
|
|
140
141
|
metricExpression?: string;
|
|
141
142
|
useRateMetric?: boolean;
|
|
142
143
|
metricRate?: string;
|
|
@@ -144,9 +145,8 @@ export declare namespace _SLOTransformation {
|
|
|
144
145
|
metricDenominator?: string;
|
|
145
146
|
evaluationType?: _SLOEvaluationTypeTransformation.AsJson;
|
|
146
147
|
errorBudgetBurnRate?: _SloBurnRateTransformation.AsJson;
|
|
147
|
-
errorBudget?: number;
|
|
148
|
-
evaluatedPercentage?: number;
|
|
149
148
|
burnRateMetricKey?: string;
|
|
149
|
+
evaluatedPercentage?: number;
|
|
150
150
|
errorBudgetMetricKey?: string;
|
|
151
151
|
normalizedErrorBudgetMetricKey?: string;
|
|
152
152
|
numeratorValue?: number;
|
|
@@ -156,14 +156,14 @@ export declare namespace _SLOTransformation {
|
|
|
156
156
|
metricKey?: string;
|
|
157
157
|
timeframe?: string;
|
|
158
158
|
filter?: string;
|
|
159
|
+
name?: string;
|
|
160
|
+
id?: string;
|
|
161
|
+
target?: number;
|
|
159
162
|
description?: string;
|
|
160
163
|
enabled?: boolean;
|
|
161
164
|
status?: _SLOStatusTransformation.AsJson;
|
|
162
165
|
error?: string;
|
|
163
166
|
warning?: number;
|
|
164
|
-
name?: string;
|
|
165
|
-
id?: string;
|
|
166
|
-
target?: number;
|
|
167
167
|
}
|
|
168
168
|
function fromJson(model: AsJson): SLO;
|
|
169
169
|
function toJson(model: SLO): AsJson;
|