@dynatrace-sdk/client-query 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 @dynatrace-sdk/client-query
 
+## 1.2.0
+
+### Minor Changes
+
+- 88696f56: Add `sampled` property to GrailMetadata
+
 ## 1.1.0
 
 ### Minor Changes

package/README.md

@@ -1,5 +1,5 @@
 # Storage – Query Service
-API version: `1.0.0`.
+API version: `1.1.0`.
 
 
 

package/cjs/index.js

@@ -2037,7 +2037,8 @@ function isGrailMetadata(value) {
     "locale",
     "executionTimeMilliseconds",
     "notifications",
-    "queryId"
+    "queryId",
+    "sampled"
   ]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
@@ -2052,7 +2053,8 @@ function isGrailMetadata(value) {
     "locale",
     "executionTimeMilliseconds",
     "notifications",
-    "queryId"
+    "queryId",
+    "sampled"
   ];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
@@ -2080,7 +2082,8 @@ function isJson22(value) {
     "locale",
     "executionTimeMilliseconds",
     "notifications",
-    "queryId"
+    "queryId",
+    "sampled"
   ]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
@@ -2095,7 +2098,8 @@ function isJson22(value) {
     "locale",
     "executionTimeMilliseconds",
     "notifications",
-    "queryId"
+    "queryId",
+    "sampled"
   ];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
@@ -2114,7 +2118,8 @@ function fromJson22($model) {
     locale,
     executionTimeMilliseconds,
     notifications,
-    queryId
+    queryId,
+    sampled
   } = $model;
   return {
     canonicalQuery,
@@ -2127,7 +2132,8 @@ function fromJson22($model) {
     locale,
     executionTimeMilliseconds,
     notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0,
-    queryId
+    queryId,
+    sampled
   };
 }
 function toJson22($model) {
@@ -2142,7 +2148,8 @@ function toJson22($model) {
     locale,
     executionTimeMilliseconds,
     notifications,
-    queryId
+    queryId,
+    sampled
   } = $model;
   return {
     canonicalQuery,
@@ -2155,7 +2162,8 @@ function toJson22($model) {
     locale,
     executionTimeMilliseconds,
     notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => toJson18(innerValue)) : void 0,
-    queryId
+    queryId,
+    sampled
   };
 }
 

package/docs/DOCS.md

@@ -1,6 +1,6 @@
 # Storage – Query Service
 
-SDK package version **1.1.0**
+SDK package version **1.2.0**
 
 ```bash
 npm install @dynatrace-sdk/client-query
@@ -24,6 +24,8 @@ import { queryAssistanceClient } from '@dynatrace-sdk/client-query';
 
 Get a structured list of suggestions for the query at the given position.
 
+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).
+
 ## Overview
 
 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.
 
 Get a structured tree of the canonical form of the query.
 
+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).
+
 ## Overview
 
 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
 
 Verifies a query without executing it.
 
+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).
+
 ## Overview
 
 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';
 
 Cancels the query and returns the result if the query was already finished, otherwise discards it.
 
+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).
+
 ### Overview:
 
 Cancels a running Grail query and returns a list of records if the query already finished.
@@ -603,6 +611,8 @@ The query already finished.
 
 Starts a Grail query.
 
+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).
+
 ### Overview:
 
 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
 
 Retrieves query status and final result from Grail.
 
+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).
+
 ### Overview:
 
 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
 
 
 
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>sampled</strong>: boolean
+<div class="padding-left--md">
+
+True if sampling was used for at least one segment.
+
+</div>
+
+
+
 </div>
 
 <div class="padding-left--md padding-bottom--md">

package/dynatrace-metadata.json

@@ -1,6 +1,6 @@
 {
   "dynagen": {
-    "version": "0.10.7",
+    "version": "0.10.8",
     "generatedAt": "",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
@@ -12,7 +12,7 @@
   },
   "spec": {
     "title": "Storage – Query Service",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "baseUrl": "/platform/storage/query/v1"
   },
   "docs": {

package/esm/index.js

@@ -1972,7 +1972,8 @@ function isGrailMetadata(value) {
     "locale",
     "executionTimeMilliseconds",
     "notifications",
-    "queryId"
+    "queryId",
+    "sampled"
   ]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
@@ -1987,7 +1988,8 @@ function isGrailMetadata(value) {
     "locale",
     "executionTimeMilliseconds",
     "notifications",
-    "queryId"
+    "queryId",
+    "sampled"
   ];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
@@ -2015,7 +2017,8 @@ function isJson22(value) {
     "locale",
     "executionTimeMilliseconds",
     "notifications",
-    "queryId"
+    "queryId",
+    "sampled"
   ]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
@@ -2030,7 +2033,8 @@ function isJson22(value) {
     "locale",
     "executionTimeMilliseconds",
     "notifications",
-    "queryId"
+    "queryId",
+    "sampled"
   ];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
@@ -2049,7 +2053,8 @@ function fromJson22($model) {
     locale,
     executionTimeMilliseconds,
     notifications,
-    queryId
+    queryId,
+    sampled
   } = $model;
   return {
     canonicalQuery,
@@ -2062,7 +2067,8 @@ function fromJson22($model) {
     locale,
     executionTimeMilliseconds,
     notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0,
-    queryId
+    queryId,
+    sampled
   };
 }
 function toJson22($model) {
@@ -2077,7 +2083,8 @@ function toJson22($model) {
     locale,
     executionTimeMilliseconds,
     notifications,
-    queryId
+    queryId,
+    sampled
   } = $model;
   return {
     canonicalQuery,
@@ -2090,7 +2097,8 @@ function toJson22($model) {
     locale,
     executionTimeMilliseconds,
     notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => toJson18(innerValue)) : void 0,
-    queryId
+    queryId,
+    sampled
   };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "dependencies": {
     "@dynatrace-sdk/http-client": "^1.0.3"
   },

package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts

@@ -19,6 +19,8 @@ export declare class QueryAssistanceClient {
     /**
      * Verifies a query without executing it.
      *
+     * 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).
+     *
      * ## Overview
      *
      * Verifies the supplied query string and other query parameters for lack of any errors, but without actually
@@ -33,6 +35,8 @@ export declare class QueryAssistanceClient {
     /**
      * Get a structured tree of the canonical form of the query.
      *
+     * 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).
+     *
      * ## Overview
      *
      * Returns the parsed query as a tree, containing the structure of the canonical query. Tree-nodes can contain references to
@@ -232,6 +236,8 @@ export declare class QueryAssistanceClient {
     /**
      * Get a structured list of suggestions for the query at the given position.
      *
+     * 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).
+     *
      * ## Overview
      *
      * We provide a list of suggestions that may be used after the cursor position. The following queries will all provide the

package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts

@@ -16,6 +16,8 @@ export declare class QueryExecutionClient {
     /**
      * Retrieves query status and final result from Grail.
      *
+     * 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).
+     *
      * ### Overview:
      *
      * Polls the status of a Grail query. Returns the status of the query, including the result if the query finished.
@@ -57,6 +59,8 @@ export declare class QueryExecutionClient {
     /**
      * Starts a Grail query.
      *
+     * 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).
+     *
      * ### Overview:
      *
      * Executes a query and returns a list of records.
@@ -101,6 +105,8 @@ export declare class QueryExecutionClient {
     /**
      * Cancels the query and returns the result if the query was already finished, otherwise discards it.
      *
+     * 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).
+     *
      * ### Overview:
      *
      * Cancels a running Grail query and returns a list of records if the query already finished.

package/types/packages/client/query/src/lib/models/grail-metadata.d.ts

@@ -45,4 +45,8 @@ export interface GrailMetadata {
      * The id of the query
      */
     queryId?: string;
+    /**
+     * True if sampling was used for at least one segment.
+     */
+    sampled?: boolean;
 }

package/types/packages/client/query/src/lib/models/grail-metadata.transformation.d.ts

@@ -13,6 +13,7 @@ export interface AsJson {
     executionTimeMilliseconds?: number;
     notifications?: _MetadataNotificationTransformation.AsJson[];
     queryId?: string;
+    sampled?: boolean;
 }
 export declare function isGrailMetadata(value: any): value is GrailMetadata;
 export declare function isJson(value: any): value is AsJson;