@dynatrace-sdk/client-query 1.1.0 → 1.2.2

package/dynatrace-metadata.json

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

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.2",
   "dependencies": {
     "@dynatrace-sdk/http-client": "^1.0.3"
   },

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

@@ -19,11 +19,22 @@ 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
      * submitting the query for execution.
+     *
      * @returns Supplied query and parameters were verified.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryAssistanceClient.queryVerify({
+     *   authorization: "...",
+     *   body: {} as VerifyRequest,
+     * });
      */
     queryVerify(config: {
         body: VerifyRequest;
@@ -33,6 +44,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
@@ -222,7 +235,16 @@ export declare class QueryAssistanceClient {
      * * `INFO` is present: usually if `CANONICAL` is not present (e.g. the parameter key for `FILTER a == 1`), there is an info node
      *   for `FILTER condition:a == 1`. This `condition:` was neither written by the user nor is it canonical; but it might be
      *   used to help the user understand what this parameter means.
+     *
      * @returns 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.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryAssistanceClient.queryParse({
+     *   authorization: "...",
+     *   body: {} as ParseRequest,
+     * });
      */
     queryParse(config: {
         body: ParseRequest;
@@ -232,6 +254,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
@@ -265,7 +289,16 @@ export declare class QueryAssistanceClient {
      *
      * The `type` helps to treat specific parts of the suggestion different to others; either by a different visualization,
      * a link to docs, etc.
+     *
      * @returns A list of structured autocomplete suggestions.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryAssistanceClient.queryAutocomplete({
+     *   authorization: "...",
+     *   body: {} as AutocompleteRequest,
+     * });
      */
     queryAutocomplete(config: {
         body: AutocompleteRequest;

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.
@@ -46,7 +48,17 @@ export declare class QueryExecutionClient {
      * the new record field types will be placed.
      * It is guaranteed that every field of every record will have a corresponding type.
      * **Clients should always take the included types into account when consuming records!**
+     *
      * @returns The current status and results of the supplied query.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryExecutionClient.queryPoll({
+     *   requestToken: "...",
+     *   requestTimeoutMilliseconds: 60,
+     *   enrich: "metric-metadata",
+     * });
      */
     queryPoll(config: {
         /** The request-token of the query. */ requestToken: string;
@@ -57,6 +69,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.
@@ -90,7 +104,17 @@ export declare class QueryExecutionClient {
      * the new record field types will be placed.
      * It is guaranteed that every field of every record will have a corresponding type.
      * **Clients should always take the included types into account when consuming records!**
+     *
      * @returns The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. | The status of the query to start.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryExecutionClient.queryExecute({
+     *   enrich: "metric-metadata",
+     *   authorization: "...",
+     *   body: {} as ExecuteRequest,
+     * });
      */
     queryExecute(config: {
         body: ExecuteRequest;
@@ -101,6 +125,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.
@@ -133,7 +159,15 @@ export declare class QueryExecutionClient {
      * the new record field types will be placed.
      * It is guaranteed that every field of every record will have a corresponding type.
      * **Clients should always take the included types into account when consuming records!**
+     *
      * @returns The query already finished.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryExecutionClient.queryCancel({
+     *   requestToken: "...",
+     * });
      */
     queryCancel(config: {
         /** The request-token of the query. */ requestToken: string;

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;