datadog-api-client-typescript/packages/datadog-api-client-v1/models/SankeyRumQuery.ts at 40795a58b62d37434dd7edbecd403b56fdcefab1 · DataDog/datadog-api-client-typescript · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/**
 * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
 * This product includes software developed at Datadog (https://www.datadoghq.com/).
 * Copyright 2020-Present Datadog, Inc.
 */
import { ProductAnalyticsAudienceFilters } from "./ProductAnalyticsAudienceFilters";
import { ProductAnalyticsAudienceOccurrenceFilter } from "./ProductAnalyticsAudienceOccurrenceFilter";
import { SankeyJoinKeys } from "./SankeyJoinKeys";
import { SankeyRumDataSource } from "./SankeyRumDataSource";
import { SankeyRumQueryMode } from "./SankeyRumQueryMode";

import { AttributeTypeMap } from "../../datadog-api-client-common/util";

/**
 * Sankey widget with RUM data source query.
 */
export class SankeyRumQuery {
  /**
   * Product Analytics/RUM audience filters.
   */
  "audienceFilters"?: ProductAnalyticsAudienceFilters;
  /**
   * Sankey widget with RUM data source.
   */
  "dataSource": SankeyRumDataSource;
  /**
   * Entries per step.
   */
  "entriesPerStep"?: number;
  /**
   * Join keys.
   */
  "joinKeys"?: SankeyJoinKeys;
  /**
   * Sankey mode for RUM queries.
   */
  "mode": SankeyRumQueryMode;
  /**
   * Number of steps.
   */
  "numberOfSteps"?: number;
  /**
   * Filter applied to occurrence counts when building a Product Analytics audience.
   */
  "occurrences"?: ProductAnalyticsAudienceOccurrenceFilter;
  /**
   * Query string.
   */
  "queryString": string;
  /**
   * Source.
   */
  "source"?: string;
  /**
   * Subquery ID.
   */
  "subqueryId"?: string;
  /**
   * Target.
   */
  "target"?: string;

  /**
   * @ignore
   */
  "_unparsed"?: boolean;

  /**
   * @ignore
   */
  static readonly attributeTypeMap: AttributeTypeMap = {
    audienceFilters: {
      baseName: "audience_filters",
      type: "ProductAnalyticsAudienceFilters",
    },
    dataSource: {
      baseName: "data_source",
      type: "SankeyRumDataSource",
      required: true,
    },
    entriesPerStep: {
      baseName: "entries_per_step",
      type: "number",
      format: "int64",
    },
    joinKeys: {
      baseName: "join_keys",
      type: "SankeyJoinKeys",
    },
    mode: {
      baseName: "mode",
      type: "SankeyRumQueryMode",
      required: true,
    },
    numberOfSteps: {
      baseName: "number_of_steps",
      type: "number",
      format: "int64",
    },
    occurrences: {
      baseName: "occurrences",
      type: "ProductAnalyticsAudienceOccurrenceFilter",
    },
    queryString: {
      baseName: "query_string",
      type: "string",
      required: true,
    },
    source: {
      baseName: "source",
      type: "string",
    },
    subqueryId: {
      baseName: "subquery_id",
      type: "string",
    },
    target: {
      baseName: "target",
      type: "string",
    },
  };

  /**
   * @ignore
   */
  static getAttributeTypeMap(): AttributeTypeMap {
    return SankeyRumQuery.attributeTypeMap;
  }

  public constructor() {}
}