@dynatrace-sdk/client-query 1.10.1 → 1.11.1

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 (36) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/README.md +153 -120
  3. package/cjs/index.js +496 -55
  4. package/docs/DOCS.md +113 -84
  5. package/dynatrace-metadata.json +2 -2
  6. package/esm/index.js +496 -55
  7. package/package.json +1 -1
  8. package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts +0 -3
  9. package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts +0 -1
  10. package/types/packages/client/query/src/lib/models/dql-node-node-type.transformation.d.ts +1 -1
  11. package/types/packages/client/query/src/lib/models/execute-request.d.ts +2 -2
  12. package/types/packages/client/query/src/lib/models/field-type-type.transformation.d.ts +1 -1
  13. package/types/packages/client/query/src/lib/models/query-state.transformation.d.ts +1 -1
  14. package/types/packages/client/query/src/lib/models/result-record-value.d.ts +1 -1
  15. package/types/packages/client/query/src/lib/models/result-record-value.transformation.d.ts +1 -1
  16. package/types/packages/client/query/src/lib/models/token-type.transformation.d.ts +1 -1
  17. package/types/packages/client/query/src/lib/models/verify-request.d.ts +1 -0
  18. package/types/packages/client/query/src/lib/models/verify-request.transformation.d.ts +1 -0
  19. package/types/packages/client/query/src/lib/models/verify-response.d.ts +1 -0
  20. package/types/packages/client/query/src/lib/models/verify-response.transformation.d.ts +1 -0
  21. package/types/packages/client/query/src/lib/utils/url-helpers.d.ts +1 -1
  22. package/types/packages/http-client/src/index.d.ts +1 -1
  23. package/types/packages/http-client/src/lib/platform/abort-controller.d.ts +1 -1
  24. package/types/packages/http-client/src/lib/platform/abort-signal.d.ts +1 -1
  25. package/types/packages/http-client/src/lib/platform/decode-form-data.d.ts +48 -0
  26. package/types/packages/http-client/src/lib/platform/http-client.d.ts +19 -0
  27. package/types/packages/http-client/src/lib/platform/index.d.ts +1 -0
  28. package/types/packages/http-client/src/lib/platform/oauth-http-client.d.ts +41 -0
  29. package/types/packages/http-client/src/lib/types/data-types.d.ts +1 -1
  30. package/types/packages/http-client/src/lib/types/form-data-request-body.d.ts +2 -2
  31. package/types/packages/http-client/src/lib/types/form-data-response-body.d.ts +2 -2
  32. package/types/packages/http-client/src/lib/types/request-body-types.d.ts +1 -1
  33. package/types/packages/http-client/src/lib/types/response-body-types.d.ts +1 -1
  34. package/types/packages/platform/error-handlers/src/lib/types/global-dt-runtime-with-error-handlers.d.ts +1 -1
  35. package/types/packages/platform/error-handlers/src/lib/types/global-error-serializer.d.ts +1 -1
  36. package/types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts +1 -1
package/docs/DOCS.md CHANGED
@@ -14,7 +14,7 @@ import NpmLogo from '@site/static/img/npm-logo.png';
14
14
  <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query" target="_blank" rel="noopener noreferrer"> <span class="margin-right--xs">@dynatrace-sdk/client-query</span> <img className="no-zoom" width="20px" src={NpmLogo} /> </a>
15
15
  </div>
16
16
  <div class="col" style={{textAlign: 'right'}}>
17
- <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.10.1" target="_blank" rel="noopener noreferrer">v1.10.1</a>
17
+ <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.11.1" target="_blank" rel="noopener noreferrer">v1.11.1</a>
18
18
  </div>
19
19
  </div>
20
20
 
@@ -29,6 +29,7 @@ import { queryAssistanceClient } from '@dynatrace-sdk/client-query';
29
29
  ```
30
30
 
31
31
 
32
+
32
33
  ### queryAutocomplete
33
34
 
34
35
  <div class="padding-bottom--md">
@@ -82,10 +83,9 @@ a link to docs, etc.
82
83
 
83
84
  #### Parameters
84
85
 
85
- | Name | Type| Description|
86
- |---|---|---|
87
- |config.authorization|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authorization context. Typically start with 'Bearer '. |
88
- |config.body<sup>*required</sup>|[AutocompleteRequest](#autocompleterequest)| |
86
+ | Name | Type |
87
+ | --- | --- |
88
+ |config.body<sup>*required</sup>|[AutocompleteRequest](#autocompleterequest)|
89
89
 
90
90
 
91
91
 
@@ -98,7 +98,6 @@ A list of structured autocomplete suggestions.
98
98
  <details>
99
99
  <summary>
100
100
  Code example
101
-
102
101
  </summary>
103
102
 
104
103
  ```ts
@@ -119,6 +118,7 @@ const data = await queryAssistanceClient.queryAutocomplete({
119
118
  </div>
120
119
 
121
120
 
121
+
122
122
  ### queryParse
123
123
 
124
124
  <div class="padding-bottom--md">
@@ -342,10 +342,9 @@ When displaying the query, pick one option. You may use the other options for ho
342
342
 
343
343
  #### Parameters
344
344
 
345
- | Name | Type| Description|
346
- |---|---|---|
347
- |config.authorization|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authorization context. Typically start with 'Bearer '. |
348
- |config.body<sup>*required</sup>|[ParseRequest](#parserequest)| |
345
+ | Name | Type |
346
+ | --- | --- |
347
+ |config.body<sup>*required</sup>|[ParseRequest](#parserequest)|
349
348
 
350
349
 
351
350
 
@@ -358,7 +357,6 @@ A node containing more nodes, a node offering different (semantically equivalen
358
357
  <details>
359
358
  <summary>
360
359
  Code example
361
-
362
360
  </summary>
363
361
 
364
362
  ```ts
@@ -379,6 +377,7 @@ const data = await queryAssistanceClient.queryParse({
379
377
  </div>
380
378
 
381
379
 
380
+
382
381
  ### queryVerify
383
382
 
384
383
  <div class="padding-bottom--md">
@@ -403,10 +402,9 @@ submitting the query for execution.
403
402
 
404
403
  #### Parameters
405
404
 
406
- | Name | Type| Description|
407
- |---|---|---|
408
- |config.authorization|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authorization context. Typically start with 'Bearer '. |
409
- |config.body<sup>*required</sup>|[VerifyRequest](#verifyrequest)| |
405
+ | Name | Type |
406
+ | --- | --- |
407
+ |config.body<sup>*required</sup>|[VerifyRequest](#verifyrequest)|
410
408
 
411
409
 
412
410
 
@@ -419,7 +417,6 @@ Supplied query and parameters were verified.
419
417
  <details>
420
418
  <summary>
421
419
  Code example
422
-
423
420
  </summary>
424
421
 
425
422
  ```ts
@@ -446,6 +443,7 @@ import { queryExecutionClient } from '@dynatrace-sdk/client-query';
446
443
  ```
447
444
 
448
445
 
446
+
449
447
  ### queryCancel
450
448
 
451
449
  <div class="padding-bottom--md">
@@ -499,8 +497,8 @@ It is guaranteed that every field of every record will have a corresponding type
499
497
 
500
498
  #### Parameters
501
499
 
502
- | Name | Type| Description|
503
- |---|---|---|
500
+ | Name | Type | Description |
501
+ | --- | --- | --- |
504
502
  |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
505
503
  |config.requestToken<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request-token of the query. |
506
504
 
@@ -515,7 +513,6 @@ The query already finished.
515
513
  <details>
516
514
  <summary>
517
515
  Code example
518
-
519
516
  </summary>
520
517
 
521
518
  ```ts
@@ -533,6 +530,7 @@ const data = await queryExecutionClient.queryCancel({
533
530
  </div>
534
531
 
535
532
 
533
+
536
534
  ### queryExecute
537
535
 
538
536
  <div class="padding-bottom--md">
@@ -587,9 +585,8 @@ It is guaranteed that every field of every record will have a corresponding type
587
585
 
588
586
  #### Parameters
589
587
 
590
- | Name | Type| Description|
591
- |---|---|---|
592
- |config.authorization|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authorization context. Typically start with 'Bearer '. |
588
+ | Name | Type | Description |
589
+ | --- | --- | --- |
593
590
  |config.body<sup>*required</sup>|[ExecuteRequest](#executerequest)| |
594
591
  |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
595
592
 
@@ -604,7 +601,6 @@ The final status and results of the supplied query if it finished within a suppl
604
601
  <details>
605
602
  <summary>
606
603
  Code example
607
-
608
604
  </summary>
609
605
 
610
606
  ```ts
@@ -625,6 +621,7 @@ const data = await queryExecutionClient.queryExecute({
625
621
  </div>
626
622
 
627
623
 
624
+
628
625
  ### queryPoll
629
626
 
630
627
  <div class="padding-bottom--md">
@@ -676,8 +673,8 @@ It is guaranteed that every field of every record will have a corresponding type
676
673
 
677
674
  #### Parameters
678
675
 
679
- | Name | Type| Description|
680
- |---|---|---|
676
+ | Name | Type | Description |
677
+ | --- | --- | --- |
681
678
  |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
682
679
  |config.requestTimeoutMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time a client is willing to wait for the query result. In case the query finishes within the specified timeout, the query result is returned. Otherwise, the query status is returned. |
683
680
  |config.requestToken<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request-token of the query. |
@@ -693,7 +690,6 @@ The current status and results of the supplied query.
693
690
  <details>
694
691
  <summary>
695
692
  Code example
696
-
697
693
  </summary>
698
694
 
699
695
  ```ts
@@ -718,8 +714,9 @@ const data = await queryExecutionClient.queryPoll({
718
714
 
719
715
 
720
716
 
721
- | Name | Type| Description|
722
- |---|---|---|
717
+
718
+ | Name | Type | Description |
719
+ | --- | --- | --- |
723
720
  |cursorPosition|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
724
721
  |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
725
722
  |maxDataSuggestions|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
@@ -731,10 +728,11 @@ const data = await queryExecutionClient.queryPoll({
731
728
 
732
729
 
733
730
 
731
+
734
732
  The response of the autocomplete call.
735
733
 
736
- | Name | Type| Description|
737
- |---|---|---|
734
+ | Name | Type | Description |
735
+ | --- | --- | --- |
738
736
  |optional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the suggestions are optional. |
739
737
  |suggestedTtlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Suggested duration in seconds, for how long the response may be cached and reused by the client. It is derived from the volatility of the suggestions on the server (if the suggestions are static, how long the server will cache the volatile suggestions, ...). If not provided, then the result may be cached for long time. Value below 1 means that the result should not be cached. |
740
738
  |suggestions<sup>*required</sup>|Array&lt;[AutocompleteSuggestion](#autocompletesuggestion)&gt;|The list of suggestions. |
@@ -743,10 +741,11 @@ The response of the autocomplete call.
743
741
 
744
742
 
745
743
 
744
+
746
745
  Single suggestion for completion of the query.
747
746
 
748
- | Name | Type| Description|
749
- |---|---|---|
747
+ | Name | Type | Description |
748
+ | --- | --- | --- |
750
749
  |alreadyTypedCharacters<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of characters that the user user already typed for this suggestion. |
751
750
  |parts<sup>*required</sup>|Array&lt;[AutocompleteSuggestionPart](#autocompletesuggestionpart)&gt;|List of suggestion parts. |
752
751
  |suggestion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The suggested continuation of the query. |
@@ -755,10 +754,11 @@ Single suggestion for completion of the query.
755
754
 
756
755
 
757
756
 
757
+
758
758
  Part of the suggestion.
759
759
 
760
- | Name | Type| Description|
761
- |---|---|---|
760
+ | Name | Type | Description |
761
+ | --- | --- | --- |
762
762
  |info|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the suggestion. |
763
763
  |suggestion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The suggested continuation of the query. |
764
764
  |synopsis|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The synopsis of the suggestion. |
@@ -768,10 +768,11 @@ Part of the suggestion.
768
768
 
769
769
 
770
770
 
771
+
771
772
  The DQL node that has alternatives.
772
773
 
773
- | Name | Type| Description|
774
- |---|---|---|
774
+ | Name | Type | Description |
775
+ | --- | --- | --- |
775
776
  |alternatives|object|The different alternatives. |
776
777
  |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
777
778
  |nodeType<sup>*required</sup>|DQLNodeNodeType| |
@@ -781,10 +782,11 @@ The DQL node that has alternatives.
781
782
 
782
783
 
783
784
 
785
+
784
786
  The DQL node that contains other nodes.
785
787
 
786
- | Name | Type| Description|
787
- |---|---|---|
788
+ | Name | Type | Description |
789
+ | --- | --- | --- |
788
790
  |children|Array&lt;[DQLNode](#dqlnode)&gt;|The list of children nodes. |
789
791
  |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
790
792
  |nodeType<sup>*required</sup>|DQLNodeNodeType| |
@@ -795,10 +797,11 @@ The DQL node that contains other nodes.
795
797
 
796
798
 
797
799
 
800
+
798
801
  General Node in the DQL query.
799
802
 
800
- | Name | Type| Description|
801
- |---|---|---|
803
+ | Name | Type | Description |
804
+ | --- | --- | --- |
802
805
  |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
803
806
  |nodeType<sup>*required</sup>|DQLNodeNodeType| |
804
807
  |tokenPosition|[TokenPosition](#tokenposition)| |
@@ -807,10 +810,11 @@ General Node in the DQL query.
807
810
 
808
811
 
809
812
 
813
+
810
814
  Node that represents single token.
811
815
 
812
- | Name | Type| Description|
813
- |---|---|---|
816
+ | Name | Type | Description |
817
+ | --- | --- | --- |
814
818
  |canonicalString|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Canonical form. |
815
819
  |isMandatoryOnUserOrder|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces' |
816
820
  |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
@@ -822,20 +826,22 @@ Node that represents single token.
822
826
 
823
827
 
824
828
 
829
+
825
830
  An &apos;envelope&apos; error object that has the mandatory error object.
826
831
 
827
- | Name | Type|
828
- |---|---|
832
+ | Name | Type |
833
+ | --- | --- |
829
834
  |error<sup>*required</sup>|[ErrorResponse](#errorresponse)|
830
835
 
831
836
  ### ErrorResponse
832
837
 
833
838
 
834
839
 
840
+
835
841
  The response for error state
836
842
 
837
- | Name | Type| Description|
838
- |---|---|---|
843
+ | Name | Type | Description |
844
+ | --- | --- | --- |
839
845
  |code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Error code, which normally matches the HTTP error code. |
840
846
  |details<sup>*required</sup>|[ErrorResponseDetails](#errorresponsedetails)| |
841
847
  |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short, clear error message without details |
@@ -844,10 +850,11 @@ The response for error state
844
850
 
845
851
 
846
852
 
853
+
847
854
  Detailed information about the error.
848
855
 
849
- | Name | Type| Description|
850
- |---|---|---|
856
+ | Name | Type | Description |
857
+ | --- | --- | --- |
851
858
  |arguments<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The arguments for the message format. |
852
859
  |errorMessage<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Complete error message. |
853
860
  |errorMessageFormat<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The message format of the error message, string.format based. |
@@ -864,12 +871,13 @@ Detailed information about the error.
864
871
 
865
872
 
866
873
 
867
- | Name | Type| Description|
868
- |---|---|---|
874
+
875
+ | Name | Type | Description |
876
+ | --- | --- | --- |
869
877
  |defaultSamplingRatio|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|In case not specified in the DQL string, the sampling ratio defined here is applied. Note that this is only applicable to log queries. |
870
878
  |defaultScanLimitGbytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Limit in gigabytes for the amount data that will be scanned during read. |
871
- |defaultTimeframeEnd|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
872
- |defaultTimeframeStart|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
879
+ |defaultTimeframeEnd|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timeframe 'end' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
880
+ |defaultTimeframeStart|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timeframe 'start' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
873
881
  |enablePreview|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response. |
874
882
  |fetchTimeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The query will stop reading data after reaching the fetch-timeout. The query execution will continue, providing a partial result based on the read data. |
875
883
  |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
@@ -884,10 +892,11 @@ Detailed information about the error.
884
892
 
885
893
 
886
894
 
895
+
887
896
  The possible type of a field in DQL.
888
897
 
889
- | Name | Type|
890
- |---|---|
898
+ | Name | Type |
899
+ | --- | --- |
891
900
  |type<sup>*required</sup>|FieldTypeType|
892
901
  |types|Array&lt;[RangedFieldTypes](#rangedfieldtypes)&gt;|
893
902
 
@@ -895,10 +904,11 @@ The possible type of a field in DQL.
895
904
 
896
905
 
897
906
 
907
+
898
908
  DQL data type representing a geolocation point.
899
909
 
900
- | Name | Type| Description|
901
- |---|---|---|
910
+ | Name | Type | Description |
911
+ | --- | --- | --- |
902
912
  |latitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The coordinate that specifies the north-south position of a point on the surface of the earth. |
903
913
  |longitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The coordinate that specifies the east-west position of a point on the surface of the earth. |
904
914
 
@@ -906,10 +916,11 @@ DQL data type representing a geolocation point.
906
916
 
907
917
 
908
918
 
919
+
909
920
  Collects various bits of metadata information.
910
921
 
911
- | Name | Type| Description|
912
- |---|---|---|
922
+ | Name | Type | Description |
923
+ | --- | --- | --- |
913
924
  |analysisTimeframe|[Timeframe](#timeframe)| |
914
925
  |canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The canonical form of the query. It has normalized spaces and canonical constructs. |
915
926
  |dqlVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of DQL that was used to process the query request. |
@@ -928,10 +939,11 @@ Collects various bits of metadata information.
928
939
 
929
940
 
930
941
 
942
+
931
943
  Collects various bits of metadata information.
932
944
 
933
- | Name | Type|
934
- |---|---|
945
+ | Name | Type |
946
+ | --- | --- |
935
947
  |grail|[GrailMetadata](#grailmetadata)|
936
948
  |metrics|Array&lt;[MetricMetadata](#metricmetadata)&gt;|
937
949
 
@@ -939,10 +951,11 @@ Collects various bits of metadata information.
939
951
 
940
952
 
941
953
 
954
+
942
955
  The message that provides additional information about the execution of the query.
943
956
 
944
- | Name | Type| Description|
945
- |---|---|---|
957
+ | Name | Type | Description |
958
+ | --- | --- | --- |
946
959
  |arguments|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The arguments for the message format. |
947
960
  |message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The complete message of the notification. |
948
961
  |messageFormat|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The message format of the notification, string.format based |
@@ -955,10 +968,11 @@ The message that provides additional information about the execution of the quer
955
968
 
956
969
 
957
970
 
971
+
958
972
  An object that defines additional metric metadata.
959
973
 
960
- | Name | Type| Description|
961
- |---|---|---|
974
+ | Name | Type | Description |
975
+ | --- | --- | --- |
962
976
  |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the metadata. |
963
977
  |displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the metadata. |
964
978
  |fieldName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the associated field used in the query. |
@@ -974,8 +988,9 @@ An object that defines additional metric metadata.
974
988
 
975
989
 
976
990
 
977
- | Name | Type| Description|
978
- |---|---|---|
991
+
992
+ | Name | Type | Description |
993
+ | --- | --- | --- |
979
994
  |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
980
995
  |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
981
996
  |queryOptions|[QueryOptions](#queryoptions)| |
@@ -985,15 +1000,17 @@ An object that defines additional metric metadata.
985
1000
 
986
1001
 
987
1002
 
1003
+
988
1004
  The exact position in the query string.
989
1005
 
990
- | Name | Type| Description|
991
- |---|---|---|
1006
+ | Name | Type | Description |
1007
+ | --- | --- | --- |
992
1008
  |column<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Query position column zero based index. |
993
1009
  |index<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Query position index. |
994
1010
  |line<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Query position line zero based index. |
995
1011
 
996
1012
  ### QueryOptions
1013
+ **type**: Record&lt;string, string | undefined&gt;
997
1014
 
998
1015
 
999
1016
 
@@ -1003,10 +1020,11 @@ Query options.
1003
1020
 
1004
1021
 
1005
1022
 
1023
+
1006
1024
  The response of GET query:execute call.
1007
1025
 
1008
- | Name | Type| Description|
1009
- |---|---|---|
1026
+ | Name | Type | Description |
1027
+ | --- | --- | --- |
1010
1028
  |progress|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The progress of the query from 0 to 100. |
1011
1029
  |result|[QueryResult](#queryresult)| |
1012
1030
  |state<sup>*required</sup>|QueryState| |
@@ -1016,10 +1034,11 @@ The response of GET query:execute call.
1016
1034
 
1017
1035
 
1018
1036
 
1037
+
1019
1038
  The result of the DQL query.
1020
1039
 
1021
- | Name | Type| Description|
1022
- |---|---|---|
1040
+ | Name | Type | Description |
1041
+ | --- | --- | --- |
1023
1042
  |metadata<sup>*required</sup>|[Metadata](#metadata)| |
1024
1043
  |records<sup>*required</sup>|Array&lt;null &#124; [ResultRecord](#resultrecord)&gt;|List of records containing the result fields data. |
1025
1044
  |types<sup>*required</sup>|Array&lt;[RangedFieldTypes](#rangedfieldtypes)&gt;|The data types for the result records. |
@@ -1028,10 +1047,11 @@ The result of the DQL query.
1028
1047
 
1029
1048
 
1030
1049
 
1050
+
1031
1051
  The response when starting a query.
1032
1052
 
1033
- | Name | Type| Description|
1034
- |---|---|---|
1053
+ | Name | Type | Description |
1054
+ | --- | --- | --- |
1035
1055
  |progress|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The progress of the query from 0 to 100. |
1036
1056
  |requestToken|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The token returned by the POST query:execute call. |
1037
1057
  |result|[QueryResult](#queryresult)| |
@@ -1042,20 +1062,23 @@ The response when starting a query.
1042
1062
 
1043
1063
 
1044
1064
 
1065
+
1045
1066
  The field type in range.
1046
1067
 
1047
- | Name | Type| Description|
1048
- |---|---|---|
1068
+ | Name | Type | Description |
1069
+ | --- | --- | --- |
1049
1070
  |indexRange|Array&lt;[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)&gt;|The range of elements at use this type in arrays (null for records). |
1050
1071
  |mappings<sup>*required</sup>|[RangedFieldTypesMappings](#rangedfieldtypesmappings)| |
1051
1072
 
1052
1073
  ### RangedFieldTypesMappings
1074
+ **type**: Record&lt;string, FieldType | undefined&gt;
1053
1075
 
1054
1076
 
1055
1077
 
1056
1078
  The mapping between the field name and data type.
1057
1079
 
1058
1080
  ### ResultRecord
1081
+ **type**: Record&lt;string, ResultRecordValue | null | undefined&gt;
1059
1082
 
1060
1083
 
1061
1084
 
@@ -1065,10 +1088,11 @@ Single record that contains the result fields.
1065
1088
 
1066
1089
 
1067
1090
 
1091
+
1068
1092
  DQL data type timeframe.
1069
1093
 
1070
- | Name | Type| Description|
1071
- |---|---|---|
1094
+ | Name | Type | Description |
1095
+ | --- | --- | --- |
1072
1096
  |end|Date|The end time of the timeframe. |
1073
1097
  |start|Date|The start time of the timeframe. |
1074
1098
 
@@ -1076,10 +1100,11 @@ DQL data type timeframe.
1076
1100
 
1077
1101
 
1078
1102
 
1103
+
1079
1104
  The position of a token in a query string used for errors and notification to map the message to a specific part of the query.
1080
1105
 
1081
- | Name | Type|
1082
- |---|---|
1106
+ | Name | Type |
1107
+ | --- | --- |
1083
1108
  |end<sup>*required</sup>|[PositionInfo](#positioninfo)|
1084
1109
  |start<sup>*required</sup>|[PositionInfo](#positioninfo)|
1085
1110
 
@@ -1089,8 +1114,10 @@ The position of a token in a query string used for errors and notification to ma
1089
1114
 
1090
1115
 
1091
1116
 
1092
- | Name | Type| Description|
1093
- |---|---|---|
1117
+
1118
+ | Name | Type | Description |
1119
+ | --- | --- | --- |
1120
+ |generateCanonicalQuery|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| <i>default:</i> <code>false</code>|
1094
1121
  |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'. |
1095
1122
  |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
1096
1123
  |queryOptions|[QueryOptions](#queryoptions)| |
@@ -1100,10 +1127,12 @@ The position of a token in a query string used for errors and notification to ma
1100
1127
 
1101
1128
 
1102
1129
 
1130
+
1103
1131
  Verify response.
1104
1132
 
1105
- | Name | Type| Description|
1106
- |---|---|---|
1133
+ | Name | Type | Description |
1134
+ | --- | --- | --- |
1135
+ |canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
1107
1136
  |notifications|Array&lt;[MetadataNotification](#metadatanotification)&gt;|The notifications related to the supplied DQL query string. |
1108
1137
  |valid<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the supplied DQL query string is valid. |
1109
1138
 
@@ -4,7 +4,7 @@
4
4
  "generatedAt": "",
5
5
  "template": {
6
6
  "name": "@dynatrace-sdk/template-typescript-client",
7
- "version": "0.18.12"
7
+ "version": "0.19.1"
8
8
  },
9
9
  "featureFlags": {
10
10
  "typeguards": true
@@ -12,7 +12,7 @@
12
12
  },
13
13
  "spec": {
14
14
  "title": "DQL Query",
15
- "version": "1.9.0",
15
+ "version": "1.10.0",
16
16
  "baseUrl": "/platform/storage/query/v1"
17
17
  }
18
18
  }