@dynatrace-sdk/client-query 1.21.2 → 1.22.0

package/types/packages/client/query/src/lib/models/execute-request.d.ts

@@ -2,67 +2,71 @@ import { FilterSegments } from './filter-segments';
 import { QueryOptions } from './query-options';
 export interface ExecuteRequest {
     /**
-     * The full query string.
+     * Default sampling ratio. By default no sampling is applied. No upper limit but will be normalized to a power of 10 less than or equal to 100000.
      */
-    query: string;
+    defaultSamplingRatio?: number;
     /**
-     * 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>
+     * Default scan limit. Can be overridden in DQL. Default value is configured on application level (see documentation of FETCH command). No upper limit. Use -1 for no limit.
      */
-    defaultTimeframeStart?: string;
+    defaultScanLimitGbytes?: number;
     /**
-     * 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>
+     * The query timeframe 'end' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. *Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.*
      */
     defaultTimeframeEnd?: 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'
+     * The query timeframe 'start' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. *Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.*
      */
-    timezone?: string;
+    defaultTimeframeStart?: 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'.
+     * Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response.
      */
-    locale?: string;
+    enablePreview?: boolean;
     /**
-     * The maximum number of result records that this query will return.
+     * Boolean to indicate if the query consumption limit should be enforced
      */
-    maxResultRecords?: number;
+    enforceQueryConsumptionLimit?: boolean;
     /**
-     * The maximum number of result bytes that this query will return.
+     * The time limit for fetching data. Soft limit as further data processing can happen. No upper limit in API but application level default and maximum fetch timeout also applies.
      */
-    maxResultBytes?: number;
+    fetchTimeoutSeconds?: 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.
+     * Represents a collection of filter segments.
      */
-    fetchTimeoutSeconds?: number;
+    filterSegments?: FilterSegments;
     /**
-     * The maximum time the response will be delayed to wait for a result. (This excludes the sending time and time spent in any services between the query-frontend and the client.) If the query finishes within the specified timeout, the query result is returned. Otherwise, the requestToken is returned, allowing polling for the result.
+     * Indicates whether bucket contribution information should be included in the query response metadata. When set to true, the response will contain details about how each bucket contributed to the query result.
      */
-    requestTimeoutMilliseconds?: number;
+    includeContributions?: boolean;
     /**
-     * Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response.
+     * Parameter to exclude the type information from the query result. In case not specified, the type information will be included.
      */
-    enablePreview?: boolean;
+    includeTypes?: boolean;
     /**
-     * In case not specified in the DQL string, the sampling ratio defined here is applied. Note that this is only applicable to log queries.
+     * 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'.
      */
-    defaultSamplingRatio?: number;
+    locale?: string;
     /**
-     * Limit in gigabytes for the amount data that will be scanned during read.
+     * The maximum number of serialized result bytes. Applies to records only and is a soft limit, i.e. the last record that exceeds the limit will be included in the response completely. No upper limit, no default value.
      */
-    defaultScanLimitGbytes?: number;
+    maxResultBytes?: number;
     /**
-     * Query options enhance query functionality for Dynatrace internal services.
+     * The maximum number of returned query result records. No upper limit.
      */
-    queryOptions?: QueryOptions;
+    maxResultRecords?: number;
     /**
-     * Represents a collection of filter segments.
+     * The full query string.
      */
-    filterSegments?: FilterSegments;
+    query: string;
     /**
-     * Parameter to exclude the type information from the query result. In case not specified, the type information will be included.
+     * Query options enhance query functionality for Dynatrace internal services.
      */
-    includeTypes?: boolean;
+    queryOptions?: QueryOptions;
     /**
-     * Boolean to indicate if the query consumption limit should be enforced
+     * The maximum time the response will be delayed to wait for a result. (This excludes the sending time and time spent in any services between the query-frontend and the client.) If the query finishes within the specified timeout, the query result is returned. Otherwise, the requestToken is returned, allowing polling for the result.
      */
-    enforceQueryConsumptionLimit?: boolean;
+    requestTimeoutMilliseconds?: number;
+    /**
+     * 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'
+     */
+    timezone?: string;
 }

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

@@ -1,3 +1,4 @@
+import { Contributions } from './contributions';
 import { MetadataNotification } from './metadata-notification';
 import { Timeframe } from './timeframe';
 /**
@@ -5,46 +6,34 @@ import { Timeframe } from './timeframe';
  */
 export interface GrailMetadata {
     /**
-     * The canonical form of the query. It has normalized spaces and canonical constructs.
-     */
-    canonicalQuery?: string;
-    /**
-     * Effective timezone for the query.
-     */
-    timezone?: string;
-    /**
-     * The submitted query.
+     * DQL data type timeframe.
      */
-    query?: string;
+    analysisTimeframe?: Timeframe;
     /**
-     * Number of scanned records during the query execution.
+     * The canonical form of the query. It has normalized spaces and canonical constructs.
      */
-    scannedRecords?: number;
+    canonicalQuery?: string;
+    contributions?: Contributions;
     /**
      * The version of DQL that was used to process the query request.
      */
     dqlVersion?: string;
     /**
-     * Number of scanned bytes during the query execution.
-     */
-    scannedBytes?: number;
-    scannedDataPoints?: number;
-    /**
-     * DQL data type timeframe.
+     * The time it took to execute the query.
      */
-    analysisTimeframe?: Timeframe;
+    executionTimeMilliseconds?: number;
     /**
      * Effective locale for the query.
      */
     locale?: string;
-    /**
-     * The time it took to execute the query.
-     */
-    executionTimeMilliseconds?: number;
     /**
      * Collected messages during the execution of the query.
      */
     notifications?: MetadataNotification[];
+    /**
+     * The submitted query.
+     */
+    query?: string;
     /**
      * The id of the query
      */
@@ -53,4 +42,17 @@ export interface GrailMetadata {
      * True if sampling was used for at least one segment.
      */
     sampled?: boolean;
+    /**
+     * Number of scanned bytes during the query execution.
+     */
+    scannedBytes?: number;
+    scannedDataPoints?: number;
+    /**
+     * Number of scanned records during the query execution.
+     */
+    scannedRecords?: number;
+    /**
+     * Effective timezone for the query.
+     */
+    timezone?: string;
 }

package/types/packages/client/query/src/lib/models/index.d.ts

@@ -2,6 +2,8 @@ export * from './autocomplete-request';
 export * from './autocomplete-response';
 export * from './autocomplete-suggestion';
 export * from './autocomplete-suggestion-part';
+export * from './bucket-contribution';
+export * from './contributions';
 export * from './dql-alternative-node';
 export * from './dql-container-node';
 export * from './dql-node';

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

@@ -4,31 +4,31 @@ import { TokenPosition } from './token-position';
  */
 export interface MetadataNotification {
     /**
-     * The severity of the notification, currently: INFO, WARN, ERROR.
+     * The arguments for the message format.
      */
-    severity?: string;
+    arguments?: string[];
     /**
-     * The message format of the notification, string.format based
+     * The complete message of the notification.
      */
-    messageFormat?: string;
+    message?: string;
     /**
-     * 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.
+     * The message format of the notification, string.format based
      */
-    syntaxPosition?: TokenPosition;
+    messageFormat?: string;
     /**
      * The corresponding DQL format specifier types for each format specifier used in the error message format.
      */
     messageFormatSpecifierTypes?: string[];
-    /**
-     * The arguments for the message format.
-     */
-    arguments?: string[];
     /**
      * The notification type, e.g. LIMIT_ADDED.
      */
     notificationType?: string;
     /**
-     * The complete message of the notification.
+     * The severity of the notification, currently: INFO, WARN, ERROR.
      */
-    message?: string;
+    severity?: string;
+    /**
+     * 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.
+     */
+    syntaxPosition?: TokenPosition;
 }

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

@@ -3,39 +3,39 @@
  */
 export interface MetricMetadata {
     /**
-     * The metric key.
+     * The description of the metadata.
      */
-    'metric.key'?: string;
+    description?: string;
     /**
      * The display name of the metadata.
      */
     displayName?: string;
     /**
-     * The description of the metadata.
+     * The name of the associated field used in the query.
      */
-    description?: string;
+    fieldName?: string;
     /**
-     * The unit used.
+     * The metric key.
      */
-    unit?: string;
+    'metric.key'?: string;
     /**
-     * The name of the associated field used in the query.
+     * The specified rate normalization parameter.
      */
-    fieldName?: string;
+    rate?: string;
     /**
      * Metadata about the rollup type.
      */
     rollup?: string;
     /**
-     * The specified rate normalization parameter.
+     * Indicates whether the scalar parameter was set to true in the timeseries aggregation function.
      */
-    rate?: string;
+    scalar?: boolean;
     /**
      * Indicates if the shifted parameter was used.
      */
     shifted?: boolean;
     /**
-     * Indicates whether the scalar parameter was set to true in the timeseries aggregation function.
+     * The unit used.
      */
-    scalar?: boolean;
+    unit?: string;
 }

package/types/packages/client/query/src/lib/models/parse-request.d.ts

@@ -1,19 +1,19 @@
 import { QueryOptions } from './query-options';
 export interface ParseRequest {
-    /**
-     * The full query string.
-     */
-    query: 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'
-     */
-    timezone?: 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'.
      */
     locale?: string;
+    /**
+     * The full query string.
+     */
+    query: string;
     /**
      * Query options enhance query functionality for Dynatrace internal services.
      */
     queryOptions?: QueryOptions;
+    /**
+     * 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'
+     */
+    timezone?: string;
 }

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

@@ -2,5 +2,5 @@
  * Query options enhance query functionality for Dynatrace internal services.
  */
 export interface QueryOptions {
-    [propName: string]: string | undefined;
+    [propName: string]: string;
 }

package/types/packages/client/query/src/lib/models/query-poll-response.d.ts

@@ -3,20 +3,20 @@ import { QueryResult } from './query-result';
  * The response of GET query:execute call.
  */
 export interface QueryPollResponse {
-    /**
-     * The result of the DQL query.
-     */
-    result?: QueryResult;
-    /**
-     * Time to live in seconds.
-     */
-    ttlSeconds?: number;
     /**
      * The progress of the query from 0 to 100.
      */
     progress?: number;
+    /**
+     * The result of the DQL query.
+     */
+    result?: QueryResult;
     /**
      * Possible state of the query.
      */
     state: 'NOT_STARTED' | 'RUNNING' | 'SUCCEEDED' | 'RESULT_GONE' | 'CANCELLED' | 'FAILED';
+    /**
+     * Time to live in seconds.
+     */
+    ttlSeconds?: number;
 }

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

@@ -5,14 +5,14 @@ import { ResultRecord } from './result-record';
  * The result of the DQL query.
  */
 export interface QueryResult {
-    /**
-     * List of records containing the result fields data.
-     */
-    records: (ResultRecord | null)[];
     /**
      * Collects various bits of metadata information.
      */
     metadata: Metadata;
+    /**
+     * List of records containing the result fields data.
+     */
+    records: (ResultRecord | null)[];
     /**
      * The data types for the result records.
      */

package/types/packages/client/query/src/lib/models/query-start-response.d.ts

@@ -3,14 +3,6 @@ import { QueryResult } from './query-result';
  * The response when starting a query.
  */
 export interface QueryStartResponse {
-    /**
-     * The result of the DQL query.
-     */
-    result?: QueryResult;
-    /**
-     * Time to live in seconds.
-     */
-    ttlSeconds?: number;
     /**
      * The progress of the query from 0 to 100.
      */
@@ -19,8 +11,16 @@ export interface QueryStartResponse {
      * The token returned by the POST query:execute call.
      */
     requestToken?: string;
+    /**
+     * The result of the DQL query.
+     */
+    result?: QueryResult;
     /**
      * Possible state of the query.
      */
     state: 'NOT_STARTED' | 'RUNNING' | 'SUCCEEDED' | 'RESULT_GONE' | 'CANCELLED' | 'FAILED';
+    /**
+     * Time to live in seconds.
+     */
+    ttlSeconds?: number;
 }

package/types/packages/client/query/src/lib/models/ranged-field-types-mappings.d.ts

@@ -3,5 +3,5 @@ import { FieldType } from './field-type';
  * The mapping between the field name and data type.
  */
 export interface RangedFieldTypesMappings {
-    [propName: string]: FieldType | undefined;
+    [propName: string]: FieldType;
 }

package/types/packages/client/query/src/lib/models/ranged-field-types.d.ts

@@ -3,12 +3,12 @@ import { RangedFieldTypesMappings } from './ranged-field-types-mappings';
  * The field type in range.
  */
 export interface RangedFieldTypes {
-    /**
-     * The mapping between the field name and data type.
-     */
-    mappings: RangedFieldTypesMappings;
     /**
      * The range of elements at use this type in arrays (null for records).
      */
     indexRange?: number[];
+    /**
+     * The mapping between the field name and data type.
+     */
+    mappings: RangedFieldTypesMappings;
 }

package/types/packages/client/query/src/lib/models/result-record.d.ts

@@ -3,5 +3,5 @@ import { ResultRecordValue } from './result-record-value';
  * Single record that contains the result fields.
  */
 export interface ResultRecord {
-    [propName: string]: ResultRecordValue | null | undefined;
+    [propName: string]: ResultRecordValue | null;
 }

package/types/packages/client/query/src/lib/models/timeframe.d.ts

@@ -2,12 +2,12 @@
  * DQL data type timeframe.
  */
 export interface Timeframe {
-    /**
-     * The start time of the timeframe.
-     */
-    start?: Date;
     /**
      * The end time of the timeframe.
      */
     end?: Date;
+    /**
+     * The start time of the timeframe.
+     */
+    start?: Date;
 }

package/types/packages/client/query/src/lib/models/token-position.d.ts

@@ -6,9 +6,9 @@ export interface TokenPosition {
     /**
      * The exact position in the query string.
      */
-    start: PositionInfo;
+    end: PositionInfo;
     /**
      * The exact position in the query string.
      */
-    end: PositionInfo;
+    start: PositionInfo;
 }

package/types/packages/client/query/src/lib/models/token-type.d.ts

@@ -62,5 +62,7 @@ export declare enum TokenType {
     SmartscapeNodePattern = "SMARTSCAPE_NODE_PATTERN",
     SmartscapeEdgePattern = "SMARTSCAPE_EDGE_PATTERN",
     SmartscapeNodeType = "SMARTSCAPE_NODE_TYPE",
-    SmartscapeEdgeType = "SMARTSCAPE_EDGE_TYPE"
+    SmartscapeEdgeType = "SMARTSCAPE_EDGE_TYPE",
+    JsonPath = "JSON_PATH",
+    Url = "URL"
 }

package/types/packages/client/query/src/lib/models/verify-request.d.ts

@@ -1,20 +1,20 @@
 import { QueryOptions } from './query-options';
 export interface VerifyRequest {
-    /**
-     * The full query string.
-     */
-    query: 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'
-     */
-    timezone?: string;
+    generateCanonicalQuery?: boolean;
     /**
      * 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'.
      */
     locale?: string;
+    /**
+     * The full query string.
+     */
+    query: string;
     /**
      * Query options enhance query functionality for Dynatrace internal services.
      */
     queryOptions?: QueryOptions;
-    generateCanonicalQuery?: boolean;
+    /**
+     * 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'
+     */
+    timezone?: string;
 }

package/types/packages/client/query/src/lib/models/verify-response.d.ts

@@ -3,13 +3,13 @@ import { MetadataNotification } from './metadata-notification';
  * Verify response.
  */
 export interface VerifyResponse {
-    /**
-     * True if the supplied DQL query string is valid.
-     */
-    valid: boolean;
     canonicalQuery?: string;
     /**
      * The notifications related to the supplied DQL query string.
      */
     notifications?: MetadataNotification[];
+    /**
+     * True if the supplied DQL query string is valid.
+     */
+    valid: boolean;
 }