@dynatrace-sdk/client-query 1.20.2 → 1.21.2

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 CHANGED
@@ -2,6 +2,30 @@
2
2
 
3
3
  @dynatrace-sdk/client-query
4
4
 
5
+ ## 1.21.2
6
+
7
+ ### Patch Changes
8
+
9
+ - Fix transformations for date format strings. (APPDEV-14400)
10
+ - Update dependencies. (APPDEV-14014)
11
+ - Update dependencies. (APPDEV-13611)
12
+
13
+ ## 1.21.1
14
+
15
+ ### Patch Changes
16
+
17
+ - Update dependencies. (APPDEV-11813)
18
+
19
+ ## 1.21.0
20
+
21
+ ### Minor Changes
22
+
23
+ - Add new token types to the `TokenType` enum
24
+ - Add `Retry-After` header that indicates the number of seconds to wait before retrying the request
25
+ - Add `retryAfterSeconds` property to ErrorResponse to indicate the number of seconds to wait until the next retry
26
+ - Deprecate `enfore-query-consumption-limit` header
27
+ - Add `enforceQueryConsumptionLimit` body parameter to `ExecuteRequest` and `AutocompleteRequest`
28
+
5
29
  ## 1.20.2
6
30
 
7
31
  ### Patch Changes
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @dynatrace-sdk/client-query
2
2
 
3
- [![npm](https://img.shields.io/badge/npm-v1.20.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.20.2)
3
+ [![npm](https://img.shields.io/badge/npm-v1.21.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.21.2)
4
4
  [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5
5
 
6
6
  Exposes an API to fetch records stored in Grail
@@ -92,7 +92,7 @@ a link to docs, etc.
92
92
  | --- | --- | --- |
93
93
  |config.body<sup>*required</sup>|<a href="#autocompleterequest" target="_blank" rel="noopener noreferrer">AutocompleteRequest</a>| |
94
94
  |config.dtClientContext|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. |
95
- |config.enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set, query consumption limit will be enforced. |
95
+ |config.enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|(DEPRECATED use body parameter 'enforceQueryConsumptionLimit' instead) If set, query consumption limit will be enforced. |
96
96
 
97
97
 
98
98
 
@@ -101,14 +101,14 @@ a link to docs, etc.
101
101
 
102
102
  | Return type | Description |
103
103
  |---|---|
104
- |Promise&lt;AutocompleteResponse&gt;|A list of structured autocomplete suggestions.|
104
+ |[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[AutocompleteResponse](#autocompleteresponse)&gt; | A list of structured autocomplete suggestions.|
105
105
 
106
106
 
107
107
  #### Throws
108
108
 
109
109
  | Error Type | Error Message |
110
110
  |---|---|
111
- |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. \| An internal server error has occurred.|
111
+ |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. &#124; An internal server error has occurred.|
112
112
 
113
113
 
114
114
  <details>
@@ -355,14 +355,14 @@ When displaying the query, pick one option. You may use the other options for ho
355
355
 
356
356
  | Return type | Description |
357
357
  |---|---|
358
- |Promise&lt;DQLNode&gt;|A node containing more nodes, a node offering different (semantically equivalent) versions of the query parts, or a terminal node that shows the canonical form.|
358
+ |[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[DQLNode](#dqlnode)&gt; | A node containing more nodes, a node offering different (semantically equivalent) versions of the query parts, or a terminal node that shows the canonical form.|
359
359
 
360
360
 
361
361
  #### Throws
362
362
 
363
363
  | Error Type | Error Message |
364
364
  |---|---|
365
- |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. \| An internal server error has occurred.|
365
+ |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. &#124; An internal server error has occurred.|
366
366
 
367
367
 
368
368
  <details>
@@ -424,14 +424,14 @@ submitting the query for execution.
424
424
 
425
425
  | Return type | Description |
426
426
  |---|---|
427
- |Promise&lt;VerifyResponse&gt;|Supplied query and parameters were verified.|
427
+ |[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[VerifyResponse](#verifyresponse)&gt; | Supplied query and parameters were verified.|
428
428
 
429
429
 
430
430
  #### Throws
431
431
 
432
432
  | Error Type | Error Message |
433
433
  |---|---|
434
- |ErrorEnvelopeError|The supplied request is wrong. \| An internal server error has occurred.|
434
+ |ErrorEnvelopeError|The supplied request is wrong. &#124; An internal server error has occurred.|
435
435
 
436
436
 
437
437
  <details>
@@ -528,14 +528,14 @@ It is guaranteed that every field of every record will have a corresponding type
528
528
 
529
529
  | Return type | Description |
530
530
  |---|---|
531
- |Promise&lt;QueryPollResponse \| void&gt;|The query already finished.|
531
+ |[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[QueryPollResponse](#querypollresponse) \| void&gt; | The query already finished.|
532
532
 
533
533
 
534
534
  #### Throws
535
535
 
536
536
  | Error Type | Error Message |
537
537
  |---|---|
538
- |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. \| An internal server error has occurred.|
538
+ |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. &#124; An internal server error has occurred.|
539
539
 
540
540
 
541
541
  <details>
@@ -615,7 +615,7 @@ It is guaranteed that every field of every record will have a corresponding type
615
615
  | --- | --- | --- |
616
616
  |config.body<sup>*required</sup>|<a href="#executerequest">ExecuteRequest</a>| |
617
617
  |config.dtClientContext|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. |
618
- |config.enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set, query consumption limit will be enforced. |
618
+ |config.enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|(DEPRECATED use body parameter 'enforceQueryConsumptionLimit' instead) If set, query consumption limit will be enforced. |
619
619
  |config.enrich|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If set additional data will be available in the metadata section. |
620
620
 
621
621
 
@@ -625,14 +625,14 @@ It is guaranteed that every field of every record will have a corresponding type
625
625
 
626
626
  | Return type | Description |
627
627
  |---|---|
628
- |Promise&lt;QueryStartResponse&gt;|The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. \| The status of the query to start.|
628
+ |[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[QueryStartResponse](#querystartresponse)&gt; | The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. &#124; The status of the query to start.|
629
629
 
630
630
 
631
631
  #### Throws
632
632
 
633
633
  | Error Type | Error Message |
634
634
  |---|---|
635
- |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. \| Too many requests. \| An internal server error has occurred. \| Service is unavailable. \| Client error. \| Server error.|
635
+ |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. &#124; Too many requests. &#124; An internal server error has occurred. &#124; Service is unavailable. &#124; Client error. &#124; Server error.|
636
636
  |InsufficientPermission|Insufficient permissions.|
637
637
 
638
638
 
@@ -723,14 +723,14 @@ It is guaranteed that every field of every record will have a corresponding type
723
723
 
724
724
  | Return type | Description |
725
725
  |---|---|
726
- |Promise&lt;QueryPollResponse&gt;|The current status and results of the supplied query.|
726
+ |[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[QueryPollResponse](#querypollresponse)&gt; | The current status and results of the supplied query.|
727
727
 
728
728
 
729
729
  #### Throws
730
730
 
731
731
  | Error Type | Error Message |
732
732
  |---|---|
733
- |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. \| An internal server error has occurred.|
733
+ |ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. &#124; An internal server error has occurred.|
734
734
 
735
735
 
736
736
  <details>
@@ -759,6 +759,7 @@ const data = await queryExecutionClient.queryPoll({
759
759
  | Name | Type | Description |
760
760
  | --- | --- | --- |
761
761
  |cursorPosition|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
762
+ |enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean to indicate if the query consumption limit should be enforced |
762
763
  |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'. |
763
764
  |maxDataSuggestions|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
764
765
  |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
@@ -794,7 +795,7 @@ Part of the suggestion.
794
795
  |info|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the suggestion. |
795
796
  |suggestion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The suggested continuation of the query. |
796
797
  |synopsis|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The synopsis of the suggestion. |
797
- |type<sup>*required</sup>|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "SEARCH_OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "SEARCH_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "SAVED_TABLE_NAME" &#124; "PARAMETER_MODIFIER" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE"|The type of the autocomplete token. |
798
+ |type<sup>*required</sup>|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "SEARCH_OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "SEARCH_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "SAVED_TABLE_NAME" &#124; "TABULAR_FILE_NAME" &#124; "PARAMETER_MODIFIER" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE" &#124; "ENUM_STRING" &#124; "FIELD_PREFIX" &#124; "BUCKET" &#124; "SMARTSCAPE_NODE_PATTERN" &#124; "SMARTSCAPE_EDGE_PATTERN" &#124; "SMARTSCAPE_NODE_TYPE" &#124; "SMARTSCAPE_EDGE_TYPE"|The type of the autocomplete token. |
798
799
 
799
800
  ### DQLAlternativeNode
800
801
 
@@ -840,7 +841,7 @@ Node that represents single token.
840
841
  |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
841
842
  |nodeType<sup>*required</sup>|"TERMINAL" &#124; "CONTAINER" &#124; "ALTERNATIVE"|The type of the node. |
842
843
  |tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
843
- |type|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "SEARCH_OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "SEARCH_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "SAVED_TABLE_NAME" &#124; "PARAMETER_MODIFIER" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE"|The type of the autocomplete token. |
844
+ |type|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "SEARCH_OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "SEARCH_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "SAVED_TABLE_NAME" &#124; "TABULAR_FILE_NAME" &#124; "PARAMETER_MODIFIER" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE" &#124; "ENUM_STRING" &#124; "FIELD_PREFIX" &#124; "BUCKET" &#124; "SMARTSCAPE_NODE_PATTERN" &#124; "SMARTSCAPE_EDGE_PATTERN" &#124; "SMARTSCAPE_NODE_TYPE" &#124; "SMARTSCAPE_EDGE_TYPE"|The type of the autocomplete token. |
844
845
 
845
846
  ### ErrorEnvelope
846
847
 
@@ -859,6 +860,7 @@ The response for error state
859
860
  |code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Error code, which normally matches the HTTP error code. |
860
861
  |details|<a href="#errorresponsedetails" target="_blank" rel="noopener noreferrer">ErrorResponseDetails</a>|Detailed information about the error. |
861
862
  |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short, clear error message without details |
863
+ |retryAfterSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of seconds to wait until the next retry. |
862
864
 
863
865
  ### ErrorResponseDetails
864
866
 
@@ -896,6 +898,7 @@ Detailed information about the error.
896
898
  |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> |
897
899
  |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> |
898
900
  |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. |
901
+ |enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean to indicate if the query consumption limit should be enforced |
899
902
  |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. |
900
903
  |filterSegments|<a href="#filtersegments">FilterSegments</a>|Represents a collection of filter segments. |
901
904
  |includeTypes|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Parameter to exclude the type information from the query result. In case not specified, the type information will be included. <i>default:</i> <code>true</code>|
@@ -1128,7 +1131,10 @@ Verify response.
1128
1131
  ## Enums
1129
1132
 
1130
1133
  <a name="dqlnodenodetype"></a>
1131
- ### DQLNodeNodeType
1134
+ ### ~~DQLNodeNodeType~~
1135
+
1136
+ > ⚠️ **Deprecated**
1137
+ > Use literal values.
1132
1138
 
1133
1139
  <div class="padding-left--md">
1134
1140
 
@@ -1146,7 +1152,10 @@ The type of the node.
1146
1152
  </div>
1147
1153
 
1148
1154
  <a name="fieldtypetype"></a>
1149
- ### FieldTypeType
1155
+ ### ~~FieldTypeType~~
1156
+
1157
+ > ⚠️ **Deprecated**
1158
+ > Use literal values.
1150
1159
 
1151
1160
  <div class="padding-left--md">
1152
1161
 
@@ -1164,7 +1173,10 @@ The type of the node.
1164
1173
  </div>
1165
1174
 
1166
1175
  <a name="querystate"></a>
1167
- ### QueryState
1176
+ ### ~~QueryState~~
1177
+
1178
+ > ⚠️ **Deprecated**
1179
+ > Use literal values.
1168
1180
 
1169
1181
  <div class="padding-left--md">
1170
1182
 
@@ -1182,7 +1194,10 @@ Possible state of the query.
1182
1194
  </div>
1183
1195
 
1184
1196
  <a name="tokentype"></a>
1185
- ### TokenType
1197
+ ### ~~TokenType~~
1198
+
1199
+ > ⚠️ **Deprecated**
1200
+ > Use literal values.
1186
1201
 
1187
1202
  <div class="padding-left--md">
1188
1203
 
@@ -1192,7 +1207,7 @@ The type of the autocomplete token.
1192
1207
 
1193
1208
  <div class="padding-left--md">
1194
1209
 
1195
- `Assignment` | `BooleanFalse` | `BooleanTrue` | `BraceClose` | `BraceOpen` | `BracketClose` | `BracketOpen` | `Colon` | `Comma` | `CommandName` | `DataObject` | `Dot` | `EndComment` | `EntityAttribute` | `EntitySelectorPart` | `EntityType` | `FieldModifier` | `FieldPattern` | `FunctionName` | `Indent` | `Linebreak` | `MetricKey` | `Null` | `Number` | `Operator` | `ParameterKey` | `ParameterModifier` | `ParameterValueScope` | `ParenthesisClose` | `ParenthesisOpen` | `ParsePattern` | `Pipe` | `Quote` | `SavedTableName` | `SearchOperator` | `SearchPattern` | `SimpleIdentifier` | `SingleQuote` | `Slash` | `SmartscapeIdValue` | `Space` | `String` | `TimeUnit` | `TimeseriesAggregation` | `TimeseriesAggregationExpression` | `TimestampValue` | `TraversalHopCount` | `TraversalOperator` | `TraversalRelationName` | `UidValue` | `Variable`
1210
+ `Assignment` | `BooleanFalse` | `BooleanTrue` | `BraceClose` | `BraceOpen` | `BracketClose` | `BracketOpen` | `Bucket` | `Colon` | `Comma` | `CommandName` | `DataObject` | `Dot` | `EndComment` | `EntityAttribute` | `EntitySelectorPart` | `EntityType` | `EnumString` | `FieldModifier` | `FieldPattern` | `FieldPrefix` | `FunctionName` | `Indent` | `Linebreak` | `MetricKey` | `Null` | `Number` | `Operator` | `ParameterKey` | `ParameterModifier` | `ParameterValueScope` | `ParenthesisClose` | `ParenthesisOpen` | `ParsePattern` | `Pipe` | `Quote` | `SavedTableName` | `SearchOperator` | `SearchPattern` | `SimpleIdentifier` | `SingleQuote` | `Slash` | `SmartscapeEdgePattern` | `SmartscapeEdgeType` | `SmartscapeIdValue` | `SmartscapeNodePattern` | `SmartscapeNodeType` | `Space` | `String` | `TabularFileName` | `TimeUnit` | `TimeseriesAggregation` | `TimeseriesAggregationExpression` | `TimestampValue` | `TraversalHopCount` | `TraversalOperator` | `TraversalRelationName` | `UidValue` | `Variable`
1196
1211
 
1197
1212
  </div>
1198
1213
 
package/cjs/index.js CHANGED
@@ -210,7 +210,7 @@ function partialMatch(key, keyPatterns) {
210
210
  }
211
211
  return false;
212
212
  }
213
- var dateTimePattern = /^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[+-]\d{2}:\d{2})?)$/i;
213
+ var dateTimePattern = /^(\d{4}-\d{2}-\d{2})(T\d{2}:\d{2}:\d{2}(?:\.\d+)?(Z|[+-]\d{2}:\d{2})?)?$/i;
214
214
  function isDateLike(value) {
215
215
  if (typeof value === "string") {
216
216
  return dateTimePattern.test(value);
@@ -1968,10 +1968,18 @@ var TokenType = /* @__PURE__ */ ((TokenType2) => {
1968
1968
  TokenType2["SearchPattern"] = "SEARCH_PATTERN";
1969
1969
  TokenType2["EntitySelectorPart"] = "ENTITY_SELECTOR_PART";
1970
1970
  TokenType2["SavedTableName"] = "SAVED_TABLE_NAME";
1971
+ TokenType2["TabularFileName"] = "TABULAR_FILE_NAME";
1971
1972
  TokenType2["ParameterModifier"] = "PARAMETER_MODIFIER";
1972
1973
  TokenType2["FieldModifier"] = "FIELD_MODIFIER";
1973
1974
  TokenType2["EntityType"] = "ENTITY_TYPE";
1974
1975
  TokenType2["EntityAttribute"] = "ENTITY_ATTRIBUTE";
1975
1976
  TokenType2["SmartscapeIdValue"] = "SMARTSCAPE_ID_VALUE";
1977
+ TokenType2["EnumString"] = "ENUM_STRING";
1978
+ TokenType2["FieldPrefix"] = "FIELD_PREFIX";
1979
+ TokenType2["Bucket"] = "BUCKET";
1980
+ TokenType2["SmartscapeNodePattern"] = "SMARTSCAPE_NODE_PATTERN";
1981
+ TokenType2["SmartscapeEdgePattern"] = "SMARTSCAPE_EDGE_PATTERN";
1982
+ TokenType2["SmartscapeNodeType"] = "SMARTSCAPE_NODE_TYPE";
1983
+ TokenType2["SmartscapeEdgeType"] = "SMARTSCAPE_EDGE_TYPE";
1976
1984
  return TokenType2;
1977
1985
  })(TokenType || {});
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "dynagen": {
3
- "version": "0.19.2",
3
+ "version": "0.19.9",
4
4
  "template": {
5
5
  "name": "@dynatrace-sdk/template-typescript-client",
6
- "version": "0.33.7"
6
+ "version": "0.34.4"
7
7
  },
8
8
  "featureFlags": {
9
9
  "typeguards": true
@@ -11,7 +11,7 @@
11
11
  },
12
12
  "spec": {
13
13
  "title": "DQL Query",
14
- "version": "1.15.0",
14
+ "version": "1.16.0",
15
15
  "baseUrl": "/platform/storage/query/v1"
16
16
  }
17
17
  }
package/esm/index.js CHANGED
@@ -175,7 +175,7 @@ function partialMatch(key, keyPatterns) {
175
175
  }
176
176
  return false;
177
177
  }
178
- var dateTimePattern = /^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[+-]\d{2}:\d{2})?)$/i;
178
+ var dateTimePattern = /^(\d{4}-\d{2}-\d{2})(T\d{2}:\d{2}:\d{2}(?:\.\d+)?(Z|[+-]\d{2}:\d{2})?)?$/i;
179
179
  function isDateLike(value) {
180
180
  if (typeof value === "string") {
181
181
  return dateTimePattern.test(value);
@@ -1952,11 +1952,19 @@ var TokenType = /* @__PURE__ */ ((TokenType2) => {
1952
1952
  TokenType2["SearchPattern"] = "SEARCH_PATTERN";
1953
1953
  TokenType2["EntitySelectorPart"] = "ENTITY_SELECTOR_PART";
1954
1954
  TokenType2["SavedTableName"] = "SAVED_TABLE_NAME";
1955
+ TokenType2["TabularFileName"] = "TABULAR_FILE_NAME";
1955
1956
  TokenType2["ParameterModifier"] = "PARAMETER_MODIFIER";
1956
1957
  TokenType2["FieldModifier"] = "FIELD_MODIFIER";
1957
1958
  TokenType2["EntityType"] = "ENTITY_TYPE";
1958
1959
  TokenType2["EntityAttribute"] = "ENTITY_ATTRIBUTE";
1959
1960
  TokenType2["SmartscapeIdValue"] = "SMARTSCAPE_ID_VALUE";
1961
+ TokenType2["EnumString"] = "ENUM_STRING";
1962
+ TokenType2["FieldPrefix"] = "FIELD_PREFIX";
1963
+ TokenType2["Bucket"] = "BUCKET";
1964
+ TokenType2["SmartscapeNodePattern"] = "SMARTSCAPE_NODE_PATTERN";
1965
+ TokenType2["SmartscapeEdgePattern"] = "SMARTSCAPE_EDGE_PATTERN";
1966
+ TokenType2["SmartscapeNodeType"] = "SMARTSCAPE_NODE_TYPE";
1967
+ TokenType2["SmartscapeEdgeType"] = "SMARTSCAPE_EDGE_TYPE";
1960
1968
  return TokenType2;
1961
1969
  })(TokenType || {});
1962
1970
  export {
package/package.json CHANGED
@@ -1,12 +1,11 @@
1
1
  {
2
2
  "name": "@dynatrace-sdk/client-query",
3
- "version": "1.20.2",
3
+ "version": "1.21.2",
4
4
  "description": "Exposes an API to fetch records stored in Grail.",
5
5
  "license": "Apache-2.0",
6
6
  "dependencies": {
7
- "@dynatrace-sdk/error-handlers": "^1.2.0",
8
- "@dynatrace-sdk/http-client": "^1.3.0",
9
- "@dynatrace-sdk/shared-errors": "^1.0.0"
7
+ "@dynatrace-sdk/http-client": "^1.3.1",
8
+ "@dynatrace-sdk/shared-errors": "^1.0.2"
10
9
  },
11
10
  "main": "./cjs/index.js",
12
11
  "module": "./esm/index.js",
@@ -327,7 +327,7 @@ export declare class QueryAssistanceClient {
327
327
  queryAutocomplete(config: {
328
328
  body: AutocompleteRequest;
329
329
  /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
330
- /** If set, query consumption limit will be enforced. */ enforceQueryConsumptionLimit?: boolean;
330
+ /** (DEPRECATED use body parameter 'enforceQueryConsumptionLimit' instead) If set, query consumption limit will be enforced. */ enforceQueryConsumptionLimit?: boolean;
331
331
  abortSignal?: AbortSignal;
332
332
  }): Promise<AutocompleteResponse>;
333
333
  }
@@ -134,7 +134,7 @@ export declare class QueryExecutionClient {
134
134
  body: ExecuteRequest;
135
135
  /** If set additional data will be available in the metadata section. */ enrich?: string;
136
136
  /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
137
- /** If set, query consumption limit will be enforced. */ enforceQueryConsumptionLimit?: boolean;
137
+ /** (DEPRECATED use body parameter 'enforceQueryConsumptionLimit' instead) If set, query consumption limit will be enforced. */ enforceQueryConsumptionLimit?: boolean;
138
138
  abortSignal?: AbortSignal;
139
139
  }): Promise<QueryStartResponse>;
140
140
  /**
@@ -18,4 +18,8 @@ export interface AutocompleteRequest {
18
18
  * Query options enhance query functionality for Dynatrace internal services.
19
19
  */
20
20
  queryOptions?: QueryOptions;
21
+ /**
22
+ * Boolean to indicate if the query consumption limit should be enforced
23
+ */
24
+ enforceQueryConsumptionLimit?: boolean;
21
25
  }
@@ -5,7 +5,7 @@ export interface AutocompleteSuggestionPart {
5
5
  /**
6
6
  * The type of the autocomplete token.
7
7
  */
8
- type: 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'SEARCH_OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE';
8
+ type: 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'SEARCH_OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'TABULAR_FILE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE' | 'ENUM_STRING' | 'FIELD_PREFIX' | 'BUCKET' | 'SMARTSCAPE_NODE_PATTERN' | 'SMARTSCAPE_EDGE_PATTERN' | 'SMARTSCAPE_NODE_TYPE' | 'SMARTSCAPE_EDGE_TYPE';
9
9
  /**
10
10
  * The type of the suggestion.
11
11
  */
@@ -6,7 +6,7 @@ export interface DQLTerminalNode extends DQLNode {
6
6
  /**
7
7
  * The type of the autocomplete token.
8
8
  */
9
- type?: 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'SEARCH_OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE';
9
+ type?: 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'SEARCH_OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'TABULAR_FILE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE' | 'ENUM_STRING' | 'FIELD_PREFIX' | 'BUCKET' | 'SMARTSCAPE_NODE_PATTERN' | 'SMARTSCAPE_EDGE_PATTERN' | 'SMARTSCAPE_NODE_TYPE' | 'SMARTSCAPE_EDGE_TYPE';
10
10
  /**
11
11
  * For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces'
12
12
  */
@@ -15,4 +15,8 @@ export interface ErrorResponse {
15
15
  * Error code, which normally matches the HTTP error code.
16
16
  */
17
17
  code: number;
18
+ /**
19
+ * The number of seconds to wait until the next retry.
20
+ */
21
+ retryAfterSeconds?: number;
18
22
  }
@@ -61,4 +61,8 @@ export interface ExecuteRequest {
61
61
  * Parameter to exclude the type information from the query result. In case not specified, the type information will be included.
62
62
  */
63
63
  includeTypes?: boolean;
64
+ /**
65
+ * Boolean to indicate if the query consumption limit should be enforced
66
+ */
67
+ enforceQueryConsumptionLimit?: boolean;
64
68
  }
@@ -50,9 +50,17 @@ export declare enum TokenType {
50
50
  SearchPattern = "SEARCH_PATTERN",
51
51
  EntitySelectorPart = "ENTITY_SELECTOR_PART",
52
52
  SavedTableName = "SAVED_TABLE_NAME",
53
+ TabularFileName = "TABULAR_FILE_NAME",
53
54
  ParameterModifier = "PARAMETER_MODIFIER",
54
55
  FieldModifier = "FIELD_MODIFIER",
55
56
  EntityType = "ENTITY_TYPE",
56
57
  EntityAttribute = "ENTITY_ATTRIBUTE",
57
- SmartscapeIdValue = "SMARTSCAPE_ID_VALUE"
58
+ SmartscapeIdValue = "SMARTSCAPE_ID_VALUE",
59
+ EnumString = "ENUM_STRING",
60
+ FieldPrefix = "FIELD_PREFIX",
61
+ Bucket = "BUCKET",
62
+ SmartscapeNodePattern = "SMARTSCAPE_NODE_PATTERN",
63
+ SmartscapeEdgePattern = "SMARTSCAPE_EDGE_PATTERN",
64
+ SmartscapeNodeType = "SMARTSCAPE_NODE_TYPE",
65
+ SmartscapeEdgeType = "SMARTSCAPE_EDGE_TYPE"
58
66
  }
@@ -36,4 +36,4 @@ export declare class ClientRequestError<DTO = ErrorResponseBody> extends ApiClie
36
36
  * }
37
37
  * }
38
38
  */
39
- export declare function isClientRequestError(e: any): e is ClientRequestError;
39
+ export declare function isClientRequestError<T = ErrorResponseBody>(e: any): e is ClientRequestError<T>;
@@ -16,7 +16,7 @@ export interface ErrorResponseBody<T = CommonApiError> {
16
16
  /**
17
17
  * Common API error structure, established by Dynatrace API guidelines.
18
18
  * */
19
- export interface CommonApiError<T extends Record<string, any> = Record<string, any>> {
19
+ export interface CommonApiError<T extends CommonErrorDetails & Record<string, any> = CommonErrorDetails & Record<string, any>> {
20
20
  /** The error code should be set to the HTTP error code by default.<br>
21
21
  * The error code may be set to an API-specific error code which must be properly documented.*/
22
22
  code: number;