@dynatrace-sdk/client-classic-environment-v2 1.10.0 → 1.12.0

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.
Files changed (89) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/README.md +18259 -8
  3. package/cjs/index.js +4577 -3406
  4. package/docs/DOCS.md +7226 -4091
  5. package/dynatrace-metadata.json +2 -2
  6. package/esm/index.js +4577 -3406
  7. package/package.json +2 -2
  8. package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +4 -0
  9. package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +2 -2
  10. package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +2 -2
  11. package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +0 -2
  12. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +8 -4
  13. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +4 -2
  14. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +9 -6
  15. package/types/packages/client/classic-environment-v2/src/lib/models/any-value.d.ts +6 -0
  16. package/types/packages/client/classic-environment-v2/src/lib/models/any-value.transformation.d.ts +4 -0
  17. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.d.ts +6 -1
  18. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +5 -0
  19. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +5 -0
  20. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +6 -1
  21. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +5 -0
  22. package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.d.ts +2 -0
  23. package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry.d.ts +31 -2
  24. package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry.transformation.d.ts +8 -2
  25. package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +4 -0
  26. package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.transformation.d.ts +1 -0
  27. package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +4 -0
  28. package/types/packages/client/classic-environment-v2/src/lib/models/constraint.transformation.d.ts +1 -0
  29. package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-scope.d.ts +0 -2
  30. package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-scopes-item.d.ts +1 -3
  31. package/types/packages/client/classic-environment-v2/src/lib/models/credentials-scope.d.ts +0 -2
  32. package/types/packages/client/classic-environment-v2/src/lib/models/credentials-scopes-item.d.ts +1 -3
  33. package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-value.d.ts +9 -2
  34. package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-value.transformation.d.ts +2 -2
  35. package/types/packages/client/classic-environment-v2/src/lib/models/enum-value.d.ts +5 -2
  36. package/types/packages/client/classic-environment-v2/src/lib/models/enum-value.transformation.d.ts +2 -2
  37. package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-response.d.ts +4 -0
  38. package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-response.transformation.d.ts +1 -0
  39. package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +6 -16
  40. package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +5 -2
  41. package/types/packages/client/classic-environment-v2/src/lib/models/item.transformation.d.ts +2 -2
  42. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +53 -9
  43. package/types/packages/client/classic-environment-v2/src/lib/models/metric-query-dql-translation-status.d.ts +7 -0
  44. package/types/packages/client/classic-environment-v2/src/lib/models/metric-query-dql-translation-status.transformation.d.ts +4 -0
  45. package/types/packages/client/classic-environment-v2/src/lib/models/metric-query-dql-translation.d.ts +15 -0
  46. package/types/packages/client/classic-environment-v2/src/lib/models/metric-query-dql-translation.transformation.d.ts +9 -0
  47. package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.d.ts +2 -0
  48. package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.transformation.d.ts +2 -0
  49. package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +1 -1
  50. package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +8 -3
  51. package/types/packages/client/classic-environment-v2/src/lib/models/precondition.transformation.d.ts +3 -3
  52. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +12 -4
  53. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.transformation.d.ts +4 -4
  54. package/types/packages/client/classic-environment-v2/src/lib/models/schema-constraint-rest-dto.d.ts +4 -0
  55. package/types/packages/client/classic-environment-v2/src/lib/models/schema-constraint-rest-dto.transformation.d.ts +1 -0
  56. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +9 -2
  57. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.transformation.d.ts +2 -2
  58. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.d.ts +9 -2
  59. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.transformation.d.ts +2 -2
  60. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts +9 -2
  61. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.transformation.d.ts +2 -2
  62. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +9 -2
  63. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.transformation.d.ts +2 -2
  64. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +4 -0
  65. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.transformation.d.ts +1 -0
  66. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +4 -0
  67. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.transformation.d.ts +1 -0
  68. package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization.d.ts +5 -2
  69. package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization.transformation.d.ts +2 -2
  70. package/types/packages/client/classic-environment-v2/src/lib/utils/url-helpers.d.ts +4 -1
  71. package/types/packages/http-client/src/index.d.ts +1 -1
  72. package/types/packages/http-client/src/lib/platform/index.d.ts +1 -0
  73. package/types/packages/http-client/src/lib/platform/oauth-http-client.d.ts +41 -0
  74. package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-patch.d.ts +0 -8
  75. package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-patch.transformation.d.ts +0 -4
  76. package/types/packages/client/classic-environment-v2/src/lib/models/enum-value-value.d.ts +0 -6
  77. package/types/packages/client/classic-environment-v2/src/lib/models/enum-value-value.transformation.d.ts +0 -4
  78. package/types/packages/client/classic-environment-v2/src/lib/models/item-type.d.ts +0 -6
  79. package/types/packages/client/classic-environment-v2/src/lib/models/item-type.transformation.d.ts +0 -5
  80. package/types/packages/client/classic-environment-v2/src/lib/models/precondition-expected-value.d.ts +0 -8
  81. package/types/packages/client/classic-environment-v2/src/lib/models/precondition-expected-value.transformation.d.ts +0 -4
  82. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-default.d.ts +0 -8
  83. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-default.transformation.d.ts +0 -4
  84. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-type.d.ts +0 -6
  85. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-type.transformation.d.ts +0 -5
  86. package/types/packages/client/classic-environment-v2/src/lib/models/settings-value.d.ts +0 -10
  87. package/types/packages/client/classic-environment-v2/src/lib/models/settings-value.transformation.d.ts +0 -4
  88. package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization-insert.d.ts +0 -6
  89. package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization-insert.transformation.d.ts +0 -5
@@ -78,6 +78,8 @@ export * from './aggregated-log-aggregation-result';
78
78
  export * as _AggregatedLogAggregationResultTransformation from './aggregated-log-aggregation-result.transformation';
79
79
  export * from './alerting-profile-stub';
80
80
  export * as _AlertingProfileStubTransformation from './alerting-profile-stub.transformation';
81
+ export * from './any-value';
82
+ export * as _AnyValueTransformation from './any-value.transformation';
81
83
  export * from './api-token';
82
84
  export * as _ApiTokenTransformation from './api-token.transformation';
83
85
  export * from './api-token-additional-metadata';
@@ -148,8 +150,6 @@ export * from './audit-log-entry-category';
148
150
  export * as _AuditLogEntryCategoryTransformation from './audit-log-entry-category.transformation';
149
151
  export * from './audit-log-entry-event-type';
150
152
  export * as _AuditLogEntryEventTypeTransformation from './audit-log-entry-event-type.transformation';
151
- export * from './audit-log-entry-patch';
152
- export * as _AuditLogEntryPatchTransformation from './audit-log-entry-patch.transformation';
153
153
  export * from './audit-log-entry-user-type';
154
154
  export * as _AuditLogEntryUserTypeTransformation from './audit-log-entry-user-type.transformation';
155
155
  export * from './author-dto';
@@ -316,8 +316,6 @@ export * from './enum-type-type';
316
316
  export * as _EnumTypeTypeTransformation from './enum-type-type.transformation';
317
317
  export * from './enum-value';
318
318
  export * as _EnumValueTransformation from './enum-value.transformation';
319
- export * from './enum-value-value';
320
- export * as _EnumValueValueTransformation from './enum-value-value.transformation';
321
319
  export * from './error';
322
320
  export * as _ErrorTransformation from './error.transformation';
323
321
  export * from './error-envelope';
@@ -518,8 +516,6 @@ export * from './item';
518
516
  export * as _ItemTransformation from './item.transformation';
519
517
  export * from './item-metadata';
520
518
  export * as _ItemMetadataTransformation from './item-metadata.transformation';
521
- export * from './item-type';
522
- export * as _ItemTypeTransformation from './item-type.transformation';
523
519
  export * from './json-node';
524
520
  export * as _JsonNodeTransformation from './json-node.transformation';
525
521
  export * from './linked-problem';
@@ -588,6 +584,10 @@ export * from './metric-ingest-error';
588
584
  export * as _MetricIngestErrorTransformation from './metric-ingest-error.transformation';
589
585
  export * from './metric-metadata-dto';
590
586
  export * as _MetricMetadataDtoTransformation from './metric-metadata-dto.transformation';
587
+ export * from './metric-query-dql-translation';
588
+ export * as _MetricQueryDQLTranslationTransformation from './metric-query-dql-translation.transformation';
589
+ export * from './metric-query-dql-translation-status';
590
+ export * as _MetricQueryDQLTranslationStatusTransformation from './metric-query-dql-translation-status.transformation';
591
591
  export * from './metric-series';
592
592
  export * as _MetricSeriesTransformation from './metric-series.transformation';
593
593
  export * from './metric-series-collection';
@@ -654,8 +654,6 @@ export * from './objects-list';
654
654
  export * as _ObjectsListTransformation from './objects-list.transformation';
655
655
  export * from './precondition';
656
656
  export * as _PreconditionTransformation from './precondition.transformation';
657
- export * from './precondition-expected-value';
658
- export * as _PreconditionExpectedValueTransformation from './precondition-expected-value.transformation';
659
657
  export * from './precondition-type';
660
658
  export * as _PreconditionTypeTransformation from './precondition-type.transformation';
661
659
  export * from './private-synthetic-location';
@@ -678,14 +676,10 @@ export * from './process-group-vulnerable-functions';
678
676
  export * as _ProcessGroupVulnerableFunctionsTransformation from './process-group-vulnerable-functions.transformation';
679
677
  export * from './property-definition';
680
678
  export * as _PropertyDefinitionTransformation from './property-definition.transformation';
681
- export * from './property-definition-default';
682
- export * as _PropertyDefinitionDefaultTransformation from './property-definition-default.transformation';
683
679
  export * from './property-definition-metadata';
684
680
  export * as _PropertyDefinitionMetadataTransformation from './property-definition-metadata.transformation';
685
681
  export * from './property-definition-modification-policy';
686
682
  export * as _PropertyDefinitionModificationPolicyTransformation from './property-definition-modification-policy.transformation';
687
- export * from './property-definition-type';
688
- export * as _PropertyDefinitionTypeTransformation from './property-definition-type.transformation';
689
683
  export * from './protocol-details';
690
684
  export * as _ProtocolDetailsTransformation from './protocol-details.transformation';
691
685
  export * from './public-certificate-credentials';
@@ -936,8 +930,6 @@ export * from './settings-object-response';
936
930
  export * as _SettingsObjectResponseTransformation from './settings-object-response.transformation';
937
931
  export * from './settings-object-update';
938
932
  export * as _SettingsObjectUpdateTransformation from './settings-object-update.transformation';
939
- export * from './settings-value';
940
- export * as _SettingsValueTransformation from './settings-value.transformation';
941
933
  export * from './slo-burn-rate';
942
934
  export * as _SloBurnRateTransformation from './slo-burn-rate.transformation';
943
935
  export * from './slo-burn-rate-burn-rate-type';
@@ -1080,8 +1072,6 @@ export * from './truncation-info';
1080
1072
  export * as _TruncationInfoTransformation from './truncation-info.transformation';
1081
1073
  export * from './ui-button-customization';
1082
1074
  export * as _UiButtonCustomizationTransformation from './ui-button-customization.transformation';
1083
- export * from './ui-button-customization-insert';
1084
- export * as _UiButtonCustomizationInsertTransformation from './ui-button-customization-insert.transformation';
1085
1075
  export * from './ui-callback-customization';
1086
1076
  export * as _UiCallbackCustomizationTransformation from './ui-callback-customization.transformation';
1087
1077
  export * from './ui-customization';
@@ -1,7 +1,7 @@
1
1
  import { Constraint } from './constraint';
2
2
  import { DatasourceDefinition } from './datasource-definition';
3
3
  import { ItemMetadata } from './item-metadata';
4
- import { ItemType } from './item-type';
4
+ import { RefPointer } from './ref-pointer';
5
5
  import { UiCustomization } from './ui-customization';
6
6
  /**
7
7
  * An item of a collection property.
@@ -33,6 +33,9 @@ export interface Item {
33
33
  * The subtype of the item's value.
34
34
  */
35
35
  subType?: string;
36
- type: ItemType;
36
+ /**
37
+ * The type of the item's value.
38
+ */
39
+ type: string | RefPointer;
37
40
  uiCustomization?: UiCustomization;
38
41
  }
@@ -2,7 +2,7 @@ import * as _ConstraintTransformation from './constraint.transformation';
2
2
  import * as _DatasourceDefinitionTransformation from './datasource-definition.transformation';
3
3
  import { Item } from './item';
4
4
  import * as _ItemMetadataTransformation from './item-metadata.transformation';
5
- import * as _ItemTypeTransformation from './item-type.transformation';
5
+ import * as _RefPointerTransformation from './ref-pointer.transformation';
6
6
  import * as _UiCustomizationTransformation from './ui-customization.transformation';
7
7
  export interface AsJson {
8
8
  constraints?: _ConstraintTransformation.AsJson[];
@@ -13,7 +13,7 @@ export interface AsJson {
13
13
  metadata?: _ItemMetadataTransformation.AsJson;
14
14
  referencedType?: string;
15
15
  subType?: string;
16
- type: _ItemTypeTransformation.AsJson;
16
+ type: string | _RefPointerTransformation.AsJson;
17
17
  uiCustomization?: _UiCustomizationTransformation.AsJson;
18
18
  }
19
19
  export declare function fromJson($model: AsJson): Item;
@@ -3,14 +3,58 @@
3
3
 
4
4
  The object might contain the following types of case-insensitive keys (the possible key values are listed below):
5
5
 
6
- * Timestamp:
6
+ * **Timestamp:**
7
7
  * The earliest timestamp for a log event is the current time minus 24 hours. If the log event contains a timestamp earlier than the current time minus 24 hours, the event is dropped.
8
8
  * The timestamp for a log event is not limited to future time. If the log event contains a timestamp later than 10 minutes in the future, the timestamp of the event will be overridden by the current time on the server.
9
9
  * The following formats are supported: UTC milliseconds, RFC3339, and RFC3164. For the missing timestamp, the current timestamp is used. For the unsupported timestamp format, the current timestamp is used, and the value of the unsupported timestamp format is stored in the not indexed `unparsed_timestamp` attribute.
10
- * Severity. If not set, `NONE` is used.
11
- * Content. If the content key is not set, the whole JSON is parsed as the content.
12
- * Semantic attribute. Only values of the `String` type are supported. Semantic attributes are indexed and can be used in queries. These are also displayed in aggregations (facets). If an unsupported key occurs, it is not indexed and can't be used in indexing and aggregations.
13
- * Automatic attribute. The dt.auth.origin attribute is automatically added to every log record ingested via API. This attribute is the public part of the API key that the log source authorizes to connect to the generic log ingest API.
10
+ * **Severity.** If not set, `NONE` is used.
11
+ * **Content.** If the content key is not set, the whole JSON is parsed as the content.
12
+ * **Semantic attribute.** Only values of the `String` type are supported. Semantic attributes are indexed and can be used in queries. These are also displayed in aggregations (facets). If an unsupported key occurs, it is not indexed and can't be used in indexing and aggregations.
13
+ * **Automatic attribute.** The dt.auth.origin attribute is automatically added to every log record ingested via API. This attribute is the public part of the API key that the log source authorizes to connect to the generic log ingest API.
14
+
15
+ <br/>
16
+
17
+ **Attributes structure**
18
+
19
+ Complex objects are flattened facilitating ease of handling, and a simpler representation. The following guidelines outline the process:
20
+
21
+ 1. The keys are concatenated using a dot (.) until a simple value is reached in the hierarchy. For example:
22
+
23
+ _Base JSON:_
24
+
25
+ ` {"test": { "attribute": {"one": "value 1", "two": "value 2"}}} `
26
+
27
+ _Result:_
28
+
29
+ ` {"test.attribute.one": "value 1", "test.attribute.two": "value 2" } `
30
+
31
+ 2. When an array is encountered, a multi-value attribute is created at that level. If there are non-simple values within the array, the JSON stringified value is maintained.
32
+
33
+ 3. Name conflicts are resolved as follows:
34
+
35
+ * In case of a name conflict, where a key is overwritten, it is prefixed with "overwritten". For example:
36
+
37
+ *Base JSON:*
38
+
39
+ ` {"host.name": "abc", "host": { "name": "xyz"}} `
40
+
41
+ *Result:*
42
+
43
+ ` {"host.name": "abc", "overwritten1.host.name": "xyz"} `
44
+
45
+ * If a second conflict arises, an index is added starting with 1:
46
+
47
+ *Base JSON:*
48
+
49
+ ` {"service.instance.id": "abc", "service": { "instance.id": "xyz", "instance": { "id": "123"}}} `
50
+
51
+ *Result:*
52
+
53
+ ` {"service.instance.id": "abc", "overwritten1.service.instance.id": "xyz", "overwritten2.service.instance.id": "123" } `
54
+
55
+ <br/>
56
+
57
+ **Limitations**
14
58
 
15
59
  The object value can be a single constant or, in case of semantic attribute, an array of constants. The length of the value is limited. Any content exceeding the limit is trimmed. Default limits:
16
60
 
@@ -20,7 +64,7 @@ The object value can be a single constant or, in case of semantic attribute, an
20
64
  * The maximum payload size of a single request is 5 MB.
21
65
  * 50000 log events per payload.
22
66
 
23
- Supported timestamp keys:
67
+ <br/> **Supported timestamp keys:**
24
68
  * @timestamp
25
69
  * _timestamp
26
70
  * date
@@ -29,20 +73,20 @@ Supported timestamp keys:
29
73
  * syslog.timestamp
30
74
  * timestamp
31
75
 
32
- Supported content keys:
76
+ <br/> **Supported content keys:**
33
77
  * body
34
78
  * content
35
79
  * message
36
80
  * payload
37
81
 
38
- Supported severity keys:
82
+ <br/> **Supported severity keys:**
39
83
  * level
40
84
  * loglevel
41
85
  * severity
42
86
  * status
43
87
  * syslog.severity
44
88
 
45
- Supported semantic attribute keys:
89
+ <br/> **Supported semantic attribute keys:**
46
90
  * audit.action
47
91
  * audit.identity
48
92
  * audit.result
@@ -0,0 +1,7 @@
1
+ /**
2
+ * The status of the DQL translation, either `success` or `not supported`
3
+ */
4
+ export declare enum MetricQueryDQLTranslationStatus {
5
+ NotSupported = "not supported",
6
+ Success = "success"
7
+ }
@@ -0,0 +1,4 @@
1
+ import { MetricQueryDQLTranslationStatus } from './metric-query-dql-translation-status';
2
+ export declare type AsJson = string;
3
+ export declare function fromJson($model: AsJson): MetricQueryDQLTranslationStatus;
4
+ export declare function toJson($model: MetricQueryDQLTranslationStatus): AsJson;
@@ -0,0 +1,15 @@
1
+ import { MetricQueryDQLTranslationStatus } from './metric-query-dql-translation-status';
2
+ /**
3
+ * Metric query translation to DQL.
4
+ */
5
+ export interface MetricQueryDQLTranslation {
6
+ /**
7
+ * Error message - only present if the status is `not supported`
8
+ */
9
+ message?: string;
10
+ /**
11
+ * The DQL query corresponding to the metric query
12
+ */
13
+ query?: string;
14
+ status?: MetricQueryDQLTranslationStatus;
15
+ }
@@ -0,0 +1,9 @@
1
+ import { MetricQueryDQLTranslation } from './metric-query-dql-translation';
2
+ import * as _MetricQueryDQLTranslationStatusTransformation from './metric-query-dql-translation-status.transformation';
3
+ export interface AsJson {
4
+ message?: string;
5
+ query?: string;
6
+ status?: _MetricQueryDQLTranslationStatusTransformation.AsJson;
7
+ }
8
+ export declare function fromJson($model: AsJson): MetricQueryDQLTranslation;
9
+ export declare function toJson($model: MetricQueryDQLTranslation): AsJson;
@@ -1,4 +1,5 @@
1
1
  import { AppliedFilter } from './applied-filter';
2
+ import { MetricQueryDQLTranslation } from './metric-query-dql-translation';
2
3
  import { MetricSeries } from './metric-series';
3
4
  /**
4
5
  * Data points of a metric.
@@ -20,6 +21,7 @@ export interface MetricSeriesCollection {
20
21
  * The ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query.
21
22
  */
22
23
  dimensionCountRatio: number;
24
+ dql?: MetricQueryDQLTranslation;
23
25
  /**
24
26
  * The key of the metric.
25
27
  *
@@ -1,4 +1,5 @@
1
1
  import * as _AppliedFilterTransformation from './applied-filter.transformation';
2
+ import * as _MetricQueryDQLTranslationTransformation from './metric-query-dql-translation.transformation';
2
3
  import { MetricSeriesCollection } from './metric-series-collection';
3
4
  import * as _MetricSeriesTransformation from './metric-series.transformation';
4
5
  export interface AsJson {
@@ -6,6 +7,7 @@ export interface AsJson {
6
7
  data: _MetricSeriesTransformation.AsJson[];
7
8
  dataPointCountRatio: number;
8
9
  dimensionCountRatio: number;
10
+ dql?: _MetricQueryDQLTranslationTransformation.AsJson;
9
11
  metricId: string;
10
12
  warnings?: string[];
11
13
  }
@@ -27,7 +27,7 @@ export interface NetworkZone {
27
27
  /**
28
28
  * The number of OneAgents from other network zones that are using ActiveGates in the network zone.
29
29
  *
30
- * This is a fraction of **numOfOneAgentsUsing**.
30
+ * This is a fraction of **numOfOneAgentsUsing**.
31
31
  *
32
32
  * One possible reason for switching to another zone is that a firewall is preventing a OneAgent from connecting to any ActiveGate in the preferred network zone.
33
33
  */
@@ -1,16 +1,21 @@
1
- import { PreconditionExpectedValue } from './precondition-expected-value';
1
+ import { AnyValue } from './any-value';
2
2
  import { PreconditionType } from './precondition-type';
3
3
  /**
4
4
  * A precondition for visibility of a property.
5
5
  */
6
6
  export interface Precondition {
7
- expectedValue?: PreconditionExpectedValue;
7
+ /**
8
+ * The expected value of the property.
9
+ *
10
+ * Only applicable to properties of the `EQUALS` type.
11
+ */
12
+ expectedValue?: AnyValue;
8
13
  /**
9
14
  * A list of valid values of the property.
10
15
  *
11
16
  * Only applicable to properties of the `IN` type.
12
17
  */
13
- expectedValues?: Record<string, any>[];
18
+ expectedValues?: AnyValue[];
14
19
  /**
15
20
  * The Regular expression which is matched against the property.
16
21
  *
@@ -1,10 +1,10 @@
1
+ import * as _AnyValueTransformation from './any-value.transformation';
1
2
  import { Precondition } from './precondition';
2
- import * as _PreconditionExpectedValueTransformation from './precondition-expected-value.transformation';
3
3
  import * as _PreconditionTypeTransformation from './precondition-type.transformation';
4
4
  import * as _PreconditionTransformation from './precondition.transformation';
5
5
  export interface AsJson {
6
- expectedValue?: _PreconditionExpectedValueTransformation.AsJson;
7
- expectedValues?: Record<string, any>[];
6
+ expectedValue?: _AnyValueTransformation.AsJson;
7
+ expectedValues?: _AnyValueTransformation.AsJson[];
8
8
  pattern?: string;
9
9
  precondition?: _PreconditionTransformation.AsJson;
10
10
  preconditions?: _PreconditionTransformation.AsJson[];
@@ -1,11 +1,11 @@
1
+ import { AnyValue } from './any-value';
1
2
  import { Constraint } from './constraint';
2
3
  import { DatasourceDefinition } from './datasource-definition';
3
4
  import { Item } from './item';
4
5
  import { Precondition } from './precondition';
5
- import { PropertyDefinitionDefault } from './property-definition-default';
6
6
  import { PropertyDefinitionMetadata } from './property-definition-metadata';
7
7
  import { PropertyDefinitionModificationPolicy } from './property-definition-modification-policy';
8
- import { PropertyDefinitionType } from './property-definition-type';
8
+ import { RefPointer } from './ref-pointer';
9
9
  import { UiCustomization } from './ui-customization';
10
10
  /**
11
11
  * Configuration of a property in a settings schema.
@@ -16,7 +16,12 @@ export interface PropertyDefinition {
16
16
  */
17
17
  constraints?: Constraint[];
18
18
  datasource?: DatasourceDefinition;
19
- default?: PropertyDefinitionDefault;
19
+ /**
20
+ * The default value to be used when no value is provided.
21
+ *
22
+ * If a non-singleton has the value of `null`, it means an empty collection.
23
+ */
24
+ default?: AnyValue;
20
25
  /**
21
26
  * A short description of the property.
22
27
  */
@@ -63,6 +68,9 @@ export interface PropertyDefinition {
63
68
  * The subtype of the property's value.
64
69
  */
65
70
  subType?: string;
66
- type: PropertyDefinitionType;
71
+ /**
72
+ * The type of the property's value.
73
+ */
74
+ type: string | RefPointer;
67
75
  uiCustomization?: UiCustomization;
68
76
  }
@@ -1,17 +1,17 @@
1
+ import * as _AnyValueTransformation from './any-value.transformation';
1
2
  import * as _ConstraintTransformation from './constraint.transformation';
2
3
  import * as _DatasourceDefinitionTransformation from './datasource-definition.transformation';
3
4
  import * as _ItemTransformation from './item.transformation';
4
5
  import * as _PreconditionTransformation from './precondition.transformation';
5
6
  import { PropertyDefinition } from './property-definition';
6
- import * as _PropertyDefinitionDefaultTransformation from './property-definition-default.transformation';
7
7
  import * as _PropertyDefinitionMetadataTransformation from './property-definition-metadata.transformation';
8
8
  import * as _PropertyDefinitionModificationPolicyTransformation from './property-definition-modification-policy.transformation';
9
- import * as _PropertyDefinitionTypeTransformation from './property-definition-type.transformation';
9
+ import * as _RefPointerTransformation from './ref-pointer.transformation';
10
10
  import * as _UiCustomizationTransformation from './ui-customization.transformation';
11
11
  export interface AsJson {
12
12
  constraints?: _ConstraintTransformation.AsJson[];
13
13
  datasource?: _DatasourceDefinitionTransformation.AsJson;
14
- default?: _PropertyDefinitionDefaultTransformation.AsJson;
14
+ default?: _AnyValueTransformation.AsJson;
15
15
  description?: string;
16
16
  displayName?: string;
17
17
  documentation?: string;
@@ -26,7 +26,7 @@ export interface AsJson {
26
26
  precondition?: _PreconditionTransformation.AsJson;
27
27
  referencedType?: string;
28
28
  subType?: string;
29
- type: _PropertyDefinitionTypeTransformation.AsJson;
29
+ type: string | _RefPointerTransformation.AsJson;
30
30
  uiCustomization?: _UiCustomizationTransformation.AsJson;
31
31
  }
32
32
  export declare function fromJson($model: AsJson): PropertyDefinition;
@@ -8,6 +8,10 @@ export interface SchemaConstraintRestDto {
8
8
  * The ID of a custom validator.
9
9
  */
10
10
  customValidatorId?: string;
11
+ /**
12
+ * Whether to skip validation on a change made from the UI.
13
+ */
14
+ skipAsyncValidation?: boolean;
11
15
  type: SchemaConstraintRestDtoType;
12
16
  /**
13
17
  * The list of properties for which the combination of values needs to be unique
@@ -3,6 +3,7 @@ import * as _SchemaConstraintRestDtoTypeTransformation from './schema-constraint
3
3
  export interface AsJson {
4
4
  customMessage?: string;
5
5
  customValidatorId?: string;
6
+ skipAsyncValidation?: boolean;
6
7
  type: _SchemaConstraintRestDtoTypeTransformation.AsJson;
7
8
  uniqueProperties?: string[];
8
9
  }
@@ -1,4 +1,4 @@
1
- import { SettingsValue } from './settings-value';
1
+ import { AnyValue } from './any-value';
2
2
  /**
3
3
  * Configuration of a new settings object.
4
4
  */
@@ -35,5 +35,12 @@ export interface SettingsObjectCreate {
35
35
  * The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
36
36
  */
37
37
  scope: string;
38
- value: SettingsValue;
38
+ /**
39
+ * The value of the setting.
40
+ *
41
+ * It defines the actual values of settings' parameters.
42
+ *
43
+ * The actual content depends on the object's schema.
44
+ */
45
+ value: AnyValue;
39
46
  }
@@ -1,5 +1,5 @@
1
+ import * as _AnyValueTransformation from './any-value.transformation';
1
2
  import { SettingsObjectCreate } from './settings-object-create';
2
- import * as _SettingsValueTransformation from './settings-value.transformation';
3
3
  export interface AsJson {
4
4
  externalId?: string;
5
5
  insertAfter?: string;
@@ -7,7 +7,7 @@ export interface AsJson {
7
7
  schemaId: string;
8
8
  schemaVersion?: string;
9
9
  scope: string;
10
- value: _SettingsValueTransformation.AsJson;
10
+ value: _AnyValueTransformation.AsJson;
11
11
  }
12
12
  export declare function fromJson($model: AsJson): SettingsObjectCreate;
13
13
  export declare function toJson($model: SettingsObjectCreate): AsJson;
@@ -1,5 +1,5 @@
1
+ import { AnyValue } from './any-value';
1
2
  import { Error } from './error';
2
- import { SettingsValue } from './settings-value';
3
3
  /**
4
4
  * The response to a creation- or update-request.
5
5
  */
@@ -9,7 +9,14 @@ export interface SettingsObjectResponse {
9
9
  */
10
10
  code: number;
11
11
  error?: Error;
12
- invalidValue?: SettingsValue;
12
+ /**
13
+ * The value of the setting.
14
+ *
15
+ * It defines the actual values of settings' parameters.
16
+ *
17
+ * The actual content depends on the object's schema.
18
+ */
19
+ invalidValue?: AnyValue;
13
20
  /**
14
21
  * For a successful request, the ID of the created or modified settings object.
15
22
  */
@@ -1,10 +1,10 @@
1
+ import * as _AnyValueTransformation from './any-value.transformation';
1
2
  import * as _ErrorTransformation from './error.transformation';
2
3
  import { SettingsObjectResponse } from './settings-object-response';
3
- import * as _SettingsValueTransformation from './settings-value.transformation';
4
4
  export interface AsJson {
5
5
  code: number;
6
6
  error?: _ErrorTransformation.AsJson;
7
- invalidValue?: _SettingsValueTransformation.AsJson;
7
+ invalidValue?: _AnyValueTransformation.AsJson;
8
8
  objectId?: string;
9
9
  }
10
10
  export declare function fromJson($model: AsJson): SettingsObjectResponse;
@@ -1,4 +1,4 @@
1
- import { SettingsValue } from './settings-value';
1
+ import { AnyValue } from './any-value';
2
2
  /**
3
3
  * An update of a settings object.
4
4
  */
@@ -39,5 +39,12 @@ export interface SettingsObjectUpdate {
39
39
  * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
40
40
  */
41
41
  updateToken?: string;
42
- value: SettingsValue;
42
+ /**
43
+ * The value of the setting.
44
+ *
45
+ * It defines the actual values of settings' parameters.
46
+ *
47
+ * The actual content depends on the object's schema.
48
+ */
49
+ value: AnyValue;
43
50
  }
@@ -1,11 +1,11 @@
1
+ import * as _AnyValueTransformation from './any-value.transformation';
1
2
  import { SettingsObjectUpdate } from './settings-object-update';
2
- import * as _SettingsValueTransformation from './settings-value.transformation';
3
3
  export interface AsJson {
4
4
  insertAfter?: string;
5
5
  insertBefore?: string;
6
6
  schemaVersion?: string;
7
7
  updateToken?: string;
8
- value: _SettingsValueTransformation.AsJson;
8
+ value: _AnyValueTransformation.AsJson;
9
9
  }
10
10
  export declare function fromJson($model: AsJson): SettingsObjectUpdate;
11
11
  export declare function toJson($model: SettingsObjectUpdate): AsJson;
@@ -1,5 +1,5 @@
1
+ import { AnyValue } from './any-value';
1
2
  import { ModificationInfo } from './modification-info';
2
- import { SettingsValue } from './settings-value';
3
3
  /**
4
4
  * A settings object.
5
5
  */
@@ -61,5 +61,12 @@ export interface SettingsObject {
61
61
  * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
62
62
  */
63
63
  updateToken?: string;
64
- value?: SettingsValue;
64
+ /**
65
+ * The value of the setting.
66
+ *
67
+ * It defines the actual values of settings' parameters.
68
+ *
69
+ * The actual content depends on the object's schema.
70
+ */
71
+ value?: AnyValue;
65
72
  }
@@ -1,6 +1,6 @@
1
+ import * as _AnyValueTransformation from './any-value.transformation';
1
2
  import * as _ModificationInfoTransformation from './modification-info.transformation';
2
3
  import { SettingsObject } from './settings-object';
3
- import * as _SettingsValueTransformation from './settings-value.transformation';
4
4
  export interface AsJson {
5
5
  author?: string;
6
6
  created?: number;
@@ -16,7 +16,7 @@ export interface AsJson {
16
16
  searchSummary?: string;
17
17
  summary?: string;
18
18
  updateToken?: string;
19
- value?: _SettingsValueTransformation.AsJson;
19
+ value?: _AnyValueTransformation.AsJson;
20
20
  }
21
21
  export declare function fromJson($model: AsJson): SettingsObject;
22
22
  export declare function toJson($model: SettingsObject): AsJson;
@@ -10,6 +10,10 @@ export interface SyntheticMultiProtocolMonitorDto {
10
10
  * If false, the monitor is disabled.
11
11
  */
12
12
  active?: boolean;
13
+ /**
14
+ * Monitor description
15
+ */
16
+ description?: string;
13
17
  /**
14
18
  * The entity id of the monitor.
15
19
  */
@@ -5,6 +5,7 @@ import * as _SyntheticMultiProtocolMonitorStepDtoTransformation from './syntheti
5
5
  import * as _SyntheticTagWithSourceDtoTransformation from './synthetic-tag-with-source-dto.transformation';
6
6
  export interface AsJson {
7
7
  active?: boolean;
8
+ description?: string;
8
9
  entityId: string;
9
10
  frequencyMin: number;
10
11
  locations: string[];
@@ -10,6 +10,10 @@ export interface SyntheticMultiProtocolMonitorUpdateDto {
10
10
  * If false, the monitor is disabled.
11
11
  */
12
12
  active?: boolean;
13
+ /**
14
+ * Monitor description
15
+ */
16
+ description?: string;
13
17
  /**
14
18
  * The frequency of the monitor, in minutes.
15
19
  */
@@ -5,6 +5,7 @@ import * as _SyntheticMultiProtocolMonitorUpdateDtoTypeTransformation from './sy
5
5
  import * as _SyntheticTagWithSourceDtoTransformation from './synthetic-tag-with-source-dto.transformation';
6
6
  export interface AsJson {
7
7
  active?: boolean;
8
+ description?: string;
8
9
  frequencyMin?: number;
9
10
  locations: string[];
10
11
  name: string;
@@ -1,4 +1,4 @@
1
- import { UiButtonCustomizationInsert } from './ui-button-customization-insert';
1
+ import { InsertPosition } from './insert-position';
2
2
  /**
3
3
  * UI customization for defining a button that calls a function when pressed
4
4
  */
@@ -15,5 +15,8 @@ export interface UiButtonCustomization {
15
15
  * The identifier of the function to be called when the button is pressed
16
16
  */
17
17
  identifier: string;
18
- insert: UiButtonCustomizationInsert;
18
+ /**
19
+ * The position where the button should be shown in the UI
20
+ */
21
+ insert: string | InsertPosition;
19
22
  }