@dynatrace-sdk/client-query 1.12.1 → 1.15.0

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 @dynatrace-sdk/client-query
 
+## 1.15.0
+
+### Minor Changes
+- Add new token type to the `TokenType` enum and new field type to the `FieldType` enum.
+
+## 1.14.0
+
+### Minor Changes
+
+- Introduced @dynatrace-sdk/shared-errors package and improved response errors handling.
+
+## 1.13.0
+
+### Features
+
+- Add `filterSegments` property to `ExecuteRequest`
+
 ## 1.12.1
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.12.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.12.1)
+[![npm](https://img.shields.io/badge/npm-v1.15.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.15.0)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 Exposes an API to fetch records stored in Grail
@@ -729,7 +729,7 @@ Single suggestion for completion of the query.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|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. |
+|alreadyTypedCharacters<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of characters that the user already typed for this suggestion. |
 |parts<sup>*required</sup>|Array&lt;<a href="#autocompletesuggestionpart">AutocompleteSuggestionPart</a>&gt;|List of suggestion parts. |
 |suggestion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The suggested continuation of the query. |
 
@@ -879,11 +879,12 @@ Detailed information about the error.
 |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> |
 |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. |
 |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. |
+|filterSegments|<a href="#filtersegments">FilterSegments</a>| |
 |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'. |
 |maxResultBytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result bytes that this query will return. |
 |maxResultRecords|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result records that this query will return. |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|<a href="#queryoptions">QueryOptions</a>| |
+|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>| |
 |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 requestToken is returned, allowing polling for the result. |
 |timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
 
@@ -897,7 +898,43 @@ The possible type of a field in DQL.
 | Name | Type |
 | --- | --- |
 |type<sup>*required</sup>|FieldTypeType| 
-|types|Array&lt;<a href="#rangedfieldtypes" target="_blank" rel="noopener noreferrer">RangedFieldTypes</a>&gt;|
+|types|Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;|
+
+### FilterSegment
+
+
+
+
+A filter segment is identified by an ID. Each segment includes a list of variable definitions.
+
+| Name | Type |
+| --- | --- |
+|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| 
+|variables|Array&lt;<a href="#filtersegmentvariabledefinition" target="_blank" rel="noopener noreferrer">FilterSegmentVariableDefinition</a>&gt;|
+
+### FilterSegmentVariableDefinition
+
+
+
+
+Defines a variable with a name and a list of values.
+
+| Name | Type |
+| --- | --- |
+|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| 
+|values<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|
+
+### FilterSegments
+
+
+extends `Array<FilterSegment>`
+
+Represents a collection of filter segments.
+
+| Name | Type | Description |
+| --- | --- | --- |
+|[unscopables]<sup>*required</sup>|Object|<p>Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.</p>  |
+|length<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Gets or sets the length of the array. This is a number one higher than the highest index in the array. |
 
 ### GeoPoint
 
@@ -1013,7 +1050,7 @@ The exact position in the query string.
 
 
 
-Query options.
+Query options enhance query functionality for Dynatrace internal services.
 
 ### QueryPollResponse
 
@@ -1166,7 +1203,7 @@ The type of the node.
 
 <div class="padding-left--md">
 
-`Array` | `Binary` | `Boolean` | `Double` | `Duration` | `GeoPoint` | `IpAddress` | `Long` | `Record` | `String` | `Timeframe` | `Timestamp` | `Uid` | `Undefined`
+`Array` | `Binary` | `Boolean` | `Double` | `Duration` | `GeoPoint` | `IpAddress` | `Long` | `Record` | `SmartscapeId` | `String` | `Timeframe` | `Timestamp` | `Uid` | `Undefined`
 
 </div>
 
@@ -1202,7 +1239,7 @@ The type of the autocomplete token.
 
 <div class="padding-left--md">
 
-`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` | `ParameterValueScope` | `ParenthesisClose` | `ParenthesisOpen` | `ParsePattern` | `Pipe` | `Quote` | `SimpleIdentifier` | `SingleQuote` | `Slash` | `Space` | `String` | `TimeUnit` | `TimeseriesAggregation` | `TimeseriesAggregationExpression` | `TimestampValue` | `TraversalHopCount` | `TraversalOperator` | `TraversalRelationName` | `UidValue` | `Variable`
+`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` | `ParameterValueScope` | `ParenthesisClose` | `ParenthesisOpen` | `ParsePattern` | `Pipe` | `Quote` | `SimpleIdentifier` | `SingleQuote` | `Slash` | `SmartscapeIdValue` | `Space` | `String` | `TimeUnit` | `TimeseriesAggregation` | `TimeseriesAggregationExpression` | `TimestampValue` | `TraversalHopCount` | `TraversalOperator` | `TraversalRelationName` | `UidValue` | `Variable`
 
 </div>