datadog-api-client-typescript/packages/datadog-api-client-v1/models/SLOWidgetDefinition.ts at 97875a0958225149bf726dfb55316f64240cc0a3 · 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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/**
 * 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 { SLOWidgetDefinitionType } from "./SLOWidgetDefinitionType";
import { WidgetTextAlign } from "./WidgetTextAlign";
import { WidgetTimeWindows } from "./WidgetTimeWindows";
import { WidgetViewMode } from "./WidgetViewMode";

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

/**
 * Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
 */
export class SLOWidgetDefinition {
  /**
   * Additional filters applied to the SLO query.
   */
  "additionalQueryFilters"?: string;
  /**
   * The description of the widget.
   */
  "description"?: string;
  /**
   * Defined global time target.
   */
  "globalTimeTarget"?: string;
  /**
   * Defined error budget.
   */
  "showErrorBudget"?: boolean;
  /**
   * ID of the SLO displayed.
   */
  "sloId"?: string;
  /**
   * Times being monitored.
   */
  "timeWindows"?: Array<WidgetTimeWindows>;
  /**
   * Title of the widget.
   */
  "title"?: string;
  /**
   * How to align the text on the widget.
   */
  "titleAlign"?: WidgetTextAlign;
  /**
   * Size of the title.
   */
  "titleSize"?: string;
  /**
   * Type of the SLO widget.
   */
  "type": SLOWidgetDefinitionType;
  /**
   * Define how you want the SLO to be displayed.
   */
  "viewMode"?: WidgetViewMode;
  /**
   * Type of view displayed by the widget.
   */
  "viewType": string;

  /**
   * A container for additional, undeclared properties.
   * This is a holder for any undeclared properties as specified with
   * the 'additionalProperties' keyword in the OAS document.
   */
  "additionalProperties"?: { [key: string]: any };

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

  /**
   * @ignore
   */
  static readonly attributeTypeMap: AttributeTypeMap = {
    additionalQueryFilters: {
      baseName: "additional_query_filters",
      type: "string",
    },
    description: {
      baseName: "description",
      type: "string",
    },
    globalTimeTarget: {
      baseName: "global_time_target",
      type: "string",
    },
    showErrorBudget: {
      baseName: "show_error_budget",
      type: "boolean",
    },
    sloId: {
      baseName: "slo_id",
      type: "string",
    },
    timeWindows: {
      baseName: "time_windows",
      type: "Array<WidgetTimeWindows>",
    },
    title: {
      baseName: "title",
      type: "string",
    },
    titleAlign: {
      baseName: "title_align",
      type: "WidgetTextAlign",
    },
    titleSize: {
      baseName: "title_size",
      type: "string",
    },
    type: {
      baseName: "type",
      type: "SLOWidgetDefinitionType",
      required: true,
    },
    viewMode: {
      baseName: "view_mode",
      type: "WidgetViewMode",
    },
    viewType: {
      baseName: "view_type",
      type: "string",
      required: true,
    },
    additionalProperties: {
      baseName: "additionalProperties",
      type: "{ [key: string]: any; }",
    },
  };

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

  public constructor() {}
}