@dynatrace-sdk/client-query 1.0.5 → 1.2.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 (82) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +1 -1
  3. package/cjs/index.js +2602 -2489
  4. package/docs/DOCS.md +25 -1
  5. package/dynatrace-metadata.json +3 -3
  6. package/esm/index.js +2607 -2489
  7. package/package.json +2 -2
  8. package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts +6 -0
  9. package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts +6 -0
  10. package/types/packages/client/query/src/lib/models/autocomplete-request.d.ts +0 -13
  11. package/types/packages/client/query/src/lib/models/autocomplete-request.transformation.d.ts +11 -0
  12. package/types/packages/client/query/src/lib/models/autocomplete-response.d.ts +1 -13
  13. package/types/packages/client/query/src/lib/models/autocomplete-response.transformation.d.ts +11 -0
  14. package/types/packages/client/query/src/lib/models/autocomplete-suggestion-part.d.ts +1 -14
  15. package/types/packages/client/query/src/lib/models/autocomplete-suggestion-part.transformation.d.ts +12 -0
  16. package/types/packages/client/query/src/lib/models/autocomplete-suggestion.d.ts +1 -13
  17. package/types/packages/client/query/src/lib/models/autocomplete-suggestion.transformation.d.ts +11 -0
  18. package/types/packages/client/query/src/lib/models/dql-alternative-node.d.ts +1 -11
  19. package/types/packages/client/query/src/lib/models/dql-alternative-node.transformation.d.ts +9 -0
  20. package/types/packages/client/query/src/lib/models/dql-container-node.d.ts +1 -12
  21. package/types/packages/client/query/src/lib/models/dql-container-node.transformation.d.ts +10 -0
  22. package/types/packages/client/query/src/lib/models/dql-node-node-type.d.ts +0 -6
  23. package/types/packages/client/query/src/lib/models/dql-node-node-type.transformation.d.ts +6 -0
  24. package/types/packages/client/query/src/lib/models/dql-node.d.ts +2 -19
  25. package/types/packages/client/query/src/lib/models/dql-node.transformation.d.ts +17 -0
  26. package/types/packages/client/query/src/lib/models/dql-terminal-node.d.ts +2 -14
  27. package/types/packages/client/query/src/lib/models/dql-terminal-node.transformation.d.ts +12 -0
  28. package/types/packages/client/query/src/lib/models/error-envelope.d.ts +1 -14
  29. package/types/packages/client/query/src/lib/models/error-envelope.transformation.d.ts +12 -0
  30. package/types/packages/client/query/src/lib/models/error-response-details.d.ts +1 -18
  31. package/types/packages/client/query/src/lib/models/error-response-details.transformation.d.ts +16 -0
  32. package/types/packages/client/query/src/lib/models/error-response.d.ts +1 -13
  33. package/types/packages/client/query/src/lib/models/error-response.transformation.d.ts +11 -0
  34. package/types/packages/client/query/src/lib/models/execute-request.d.ts +0 -20
  35. package/types/packages/client/query/src/lib/models/execute-request.transformation.d.ts +18 -0
  36. package/types/packages/client/query/src/lib/models/field-type-type.d.ts +0 -6
  37. package/types/packages/client/query/src/lib/models/field-type-type.transformation.d.ts +6 -0
  38. package/types/packages/client/query/src/lib/models/field-type.d.ts +2 -13
  39. package/types/packages/client/query/src/lib/models/field-type.transformation.d.ts +11 -0
  40. package/types/packages/client/query/src/lib/models/geo-point.d.ts +0 -11
  41. package/types/packages/client/query/src/lib/models/geo-point.transformation.d.ts +9 -0
  42. package/types/packages/client/query/src/lib/models/grail-metadata.d.ts +6 -22
  43. package/types/packages/client/query/src/lib/models/grail-metadata.transformation.d.ts +21 -0
  44. package/types/packages/client/query/src/lib/models/index.d.ts +35 -0
  45. package/types/packages/client/query/src/lib/models/metadata-notification.d.ts +1 -17
  46. package/types/packages/client/query/src/lib/models/metadata-notification.transformation.d.ts +15 -0
  47. package/types/packages/client/query/src/lib/models/metadata.d.ts +2 -13
  48. package/types/packages/client/query/src/lib/models/metadata.transformation.d.ts +11 -0
  49. package/types/packages/client/query/src/lib/models/metric-metadata.d.ts +0 -13
  50. package/types/packages/client/query/src/lib/models/metric-metadata.transformation.d.ts +11 -0
  51. package/types/packages/client/query/src/lib/models/parse-request.d.ts +0 -12
  52. package/types/packages/client/query/src/lib/models/parse-request.transformation.d.ts +10 -0
  53. package/types/packages/client/query/src/lib/models/position-info.d.ts +0 -12
  54. package/types/packages/client/query/src/lib/models/position-info.transformation.d.ts +10 -0
  55. package/types/packages/client/query/src/lib/models/query-poll-response.d.ts +2 -15
  56. package/types/packages/client/query/src/lib/models/query-poll-response.transformation.d.ts +13 -0
  57. package/types/packages/client/query/src/lib/models/query-result.d.ts +3 -15
  58. package/types/packages/client/query/src/lib/models/query-result.transformation.d.ts +13 -0
  59. package/types/packages/client/query/src/lib/models/query-start-response.d.ts +2 -16
  60. package/types/packages/client/query/src/lib/models/query-start-response.transformation.d.ts +14 -0
  61. package/types/packages/client/query/src/lib/models/query-state.d.ts +0 -6
  62. package/types/packages/client/query/src/lib/models/query-state.transformation.d.ts +6 -0
  63. package/types/packages/client/query/src/lib/models/ranged-field-types-mappings.d.ts +1 -11
  64. package/types/packages/client/query/src/lib/models/ranged-field-types-mappings.transformation.d.ts +9 -0
  65. package/types/packages/client/query/src/lib/models/ranged-field-types.d.ts +1 -12
  66. package/types/packages/client/query/src/lib/models/ranged-field-types.transformation.d.ts +10 -0
  67. package/types/packages/client/query/src/lib/models/result-record-value.d.ts +3 -23
  68. package/types/packages/client/query/src/lib/models/result-record-value.transformation.d.ts +26 -0
  69. package/types/packages/client/query/src/lib/models/result-record.d.ts +1 -11
  70. package/types/packages/client/query/src/lib/models/result-record.transformation.d.ts +9 -0
  71. package/types/packages/client/query/src/lib/models/timeframe.d.ts +0 -11
  72. package/types/packages/client/query/src/lib/models/timeframe.transformation.d.ts +9 -0
  73. package/types/packages/client/query/src/lib/models/token-position.d.ts +1 -15
  74. package/types/packages/client/query/src/lib/models/token-position.transformation.d.ts +13 -0
  75. package/types/packages/client/query/src/lib/models/token-type.d.ts +0 -6
  76. package/types/packages/client/query/src/lib/models/token-type.transformation.d.ts +6 -0
  77. package/types/packages/client/query/src/lib/models/verify-request.d.ts +0 -12
  78. package/types/packages/client/query/src/lib/models/verify-request.transformation.d.ts +10 -0
  79. package/types/packages/client/query/src/lib/models/verify-response.d.ts +1 -12
  80. package/types/packages/client/query/src/lib/models/verify-response.transformation.d.ts +10 -0
  81. package/types/packages/platform/error-handlers/src/lib/types/common-serialized-error.d.ts +1 -0
  82. package/types/packages/platform/error-handlers/src/lib/types/http-serialized-error.d.ts +1 -0
package/docs/DOCS.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Storage – Query Service
2
2
 
3
- SDK package version **1.0.5**
3
+ SDK package version **1.2.0**
4
4
 
5
5
  ```bash
6
6
  npm install @dynatrace-sdk/client-query
@@ -24,6 +24,8 @@ import { queryAssistanceClient } from '@dynatrace-sdk/client-query';
24
24
 
25
25
  Get a structured list of suggestions for the query at the given position.
26
26
 
27
+ For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
28
+
27
29
  ## Overview
28
30
 
29
31
  We provide a list of suggestions that may be used after the cursor position. The following queries will all provide the
@@ -138,6 +140,8 @@ A list of structured autocomplete suggestions.
138
140
 
139
141
  Get a structured tree of the canonical form of the query.
140
142
 
143
+ For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
144
+
141
145
  ## Overview
142
146
 
143
147
  Returns the parsed query as a tree, containing the structure of the canonical query. Tree-nodes can contain references to
@@ -408,6 +412,8 @@ A node containing more nodes, a node offering different (semantically equivalen
408
412
 
409
413
  Verifies a query without executing it.
410
414
 
415
+ For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
416
+
411
417
  ## Overview
412
418
 
413
419
  Verifies the supplied query string and other query parameters for lack of any errors, but without actually
@@ -502,6 +508,8 @@ import { queryExecutionClient } from '@dynatrace-sdk/client-query';
502
508
 
503
509
  Cancels the query and returns the result if the query was already finished, otherwise discards it.
504
510
 
511
+ For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
512
+
505
513
  ### Overview:
506
514
 
507
515
  Cancels a running Grail query and returns a list of records if the query already finished.
@@ -603,6 +611,8 @@ The query already finished.
603
611
 
604
612
  Starts a Grail query.
605
613
 
614
+ For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
615
+
606
616
  ### Overview:
607
617
 
608
618
  Executes a query and returns a list of records.
@@ -729,6 +739,8 @@ The final status and results of the supplied query if it finished within a suppl
729
739
 
730
740
  Retrieves query status and final result from Grail.
731
741
 
742
+ For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://www.dynatrace.com/support/help/platform/grail/assign-permissions-in-grail).
743
+
732
744
  ### Overview:
733
745
 
734
746
  Polls the status of a Grail query. Returns the status of the query, including the result if the query finished.
@@ -1824,6 +1836,18 @@ The id of the query
1824
1836
 
1825
1837
 
1826
1838
 
1839
+ </div>
1840
+
1841
+ <div class="padding-left--md padding-bottom--md">
1842
+ <strong>sampled</strong>: boolean
1843
+ <div class="padding-left--md">
1844
+
1845
+ True if sampling was used for at least one segment.
1846
+
1847
+ </div>
1848
+
1849
+
1850
+
1827
1851
  </div>
1828
1852
 
1829
1853
  <div class="padding-left--md padding-bottom--md">
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "dynagen": {
3
- "version": "0.10.6",
3
+ "version": "0.10.8",
4
4
  "generatedAt": "",
5
5
  "template": {
6
6
  "name": "@dynatrace-sdk/template-typescript-client",
7
- "version": "0.14.1"
7
+ "version": "0.17.0"
8
8
  },
9
9
  "featureFlags": {
10
10
  "typeguards": true
@@ -12,7 +12,7 @@
12
12
  },
13
13
  "spec": {
14
14
  "title": "Storage – Query Service",
15
- "version": "1.0.0",
15
+ "version": "1.1.0",
16
16
  "baseUrl": "/platform/storage/query/v1"
17
17
  },
18
18
  "docs": {