Skip to content

Commit 05c531f

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 0a5bf24 of spec repo
1 parent 5d69285 commit 05c531f

16 files changed

Lines changed: 670 additions & 14 deletions

.generator/schemas/v1/openapi.yaml

Lines changed: 109 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14462,6 +14462,88 @@ components:
1446214462
type: string
1446314463
x-enum-varnames:
1446414464
- SCATTERPLOT
14465+
ScatterplotDataProjectionDimension:
14466+
description: A single dimension mapping for a scatterplot data projection.
14467+
properties:
14468+
alias:
14469+
description: Display alias for the dimension.
14470+
type: string
14471+
column:
14472+
description: The column name from the data source.
14473+
example: duration
14474+
type: string
14475+
dimension:
14476+
$ref: "#/components/schemas/ScatterplotDimension"
14477+
number_format:
14478+
$ref: "#/components/schemas/WidgetNumberFormat"
14479+
required:
14480+
- column
14481+
- dimension
14482+
type: object
14483+
ScatterplotDataProjectionProjection:
14484+
description: The projection configuration for a scatterplot data projection request.
14485+
properties:
14486+
dimensions:
14487+
description: Dimension mappings for the scatterplot axes.
14488+
items:
14489+
$ref: "#/components/schemas/ScatterplotDataProjectionDimension"
14490+
type: array
14491+
type:
14492+
$ref: "#/components/schemas/ScatterplotDataProjectionProjectionType"
14493+
required:
14494+
- type
14495+
- dimensions
14496+
type: object
14497+
ScatterplotDataProjectionProjectionType:
14498+
description: The type of the scatterplot data projection.
14499+
enum:
14500+
- scatterplot
14501+
example: scatterplot
14502+
type: string
14503+
x-enum-varnames:
14504+
- SCATTERPLOT
14505+
ScatterplotDataProjectionQuery:
14506+
description: The query for a scatterplot data projection request.
14507+
properties:
14508+
data_source:
14509+
$ref: "#/components/schemas/FormulaAndFunctionEventsDataSource"
14510+
indexes:
14511+
description: Indexes to search.
14512+
items:
14513+
type: string
14514+
type: array
14515+
query_string:
14516+
description: The search query string.
14517+
example: "@service:web-store"
14518+
type: string
14519+
storage:
14520+
$ref: "#/components/schemas/ScatterplotDataProjectionQueryStorage"
14521+
required:
14522+
- query_string
14523+
- data_source
14524+
type: object
14525+
ScatterplotDataProjectionQueryStorage:
14526+
description: Storage tier to query.
14527+
enum:
14528+
- live
14529+
- hot
14530+
- habanero
14531+
- online_archives
14532+
- driveline
14533+
- flex_tier
14534+
- case_insensitive
14535+
- cloud_prem
14536+
example: hot
14537+
type: string
14538+
x-enum-varnames:
14539+
- LIVE
14540+
- HOT
14541+
- HABANERO
14542+
- ONLINE_ARCHIVES
14543+
- DRIVELINE
14544+
- FLEX_TIER
14545+
- CASE_INSENSITIVE
14546+
- CLOUD_PREM
1446514547
ScatterplotDimension:
1446614548
description: Dimension of the Scatterplot.
1446714549
enum:
@@ -14477,21 +14559,47 @@ components:
1447714559
- RADIUS
1447814560
- COLOR
1447914561
ScatterplotTableRequest:
14480-
description: Scatterplot request containing formulas and functions.
14562+
description: |-
14563+
Scatterplot table request. Supports two modes:
14564+
- **Formulas and functions** (default): `request_type` is absent or `"table"`. Uses `queries` and `formulas`.
14565+
- **Data projection**: `request_type` is `"data_projection"`. Uses `query`, `projection`, and optionally `limit`.
1448114566
properties:
1448214567
formulas:
1448314568
description: List of Scatterplot formulas that operate on queries.
1448414569
items:
1448514570
$ref: "#/components/schemas/ScatterplotWidgetFormula"
1448614571
type: array
14572+
limit:
14573+
description: Maximum number of rows to return. Used when `request_type` is `"data_projection"`.
14574+
format: int64
14575+
type: integer
14576+
projection:
14577+
$ref: "#/components/schemas/ScatterplotDataProjectionProjection"
14578+
description: Projection configuration for data projection mode. Used when `request_type` is `"data_projection"`.
1448714579
queries:
1448814580
description: List of queries that can be returned directly or used in formulas.
1448914581
items:
1449014582
$ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
1449114583
type: array
14584+
query:
14585+
$ref: "#/components/schemas/ScatterplotDataProjectionQuery"
14586+
description: Query for data projection mode. Used when `request_type` is `"data_projection"`.
14587+
request_type:
14588+
$ref: "#/components/schemas/ScatterplotTableRequestType"
14589+
description: The type of the scatterplot table request. Use `"data_projection"` for unaggregated raw data.
1449214590
response_format:
1449314591
$ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
1449414592
type: object
14593+
ScatterplotTableRequestType:
14594+
description: The type of the scatterplot table request.
14595+
enum:
14596+
- table
14597+
- data_projection
14598+
example: data_projection
14599+
type: string
14600+
x-enum-varnames:
14601+
- TABLE
14602+
- DATA_PROJECTION
1449514603
ScatterplotWidgetAggregator:
1449614604
description: Aggregator used for the request.
1449714605
enum:

docs/datadog_api_client.v1.model.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4092,6 +4092,41 @@ datadog\_api\_client.v1.model.scatter\_plot\_widget\_definition\_type module
40924092
:members:
40934093
:show-inheritance:
40944094

4095+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_dimension module
4096+
-----------------------------------------------------------------------------
4097+
4098+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_dimension
4099+
:members:
4100+
:show-inheritance:
4101+
4102+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_projection module
4103+
------------------------------------------------------------------------------
4104+
4105+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_projection
4106+
:members:
4107+
:show-inheritance:
4108+
4109+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_projection\_type module
4110+
------------------------------------------------------------------------------------
4111+
4112+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_projection_type
4113+
:members:
4114+
:show-inheritance:
4115+
4116+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_query module
4117+
-------------------------------------------------------------------------
4118+
4119+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_query
4120+
:members:
4121+
:show-inheritance:
4122+
4123+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_query\_storage module
4124+
----------------------------------------------------------------------------------
4125+
4126+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_query_storage
4127+
:members:
4128+
:show-inheritance:
4129+
40954130
datadog\_api\_client.v1.model.scatterplot\_dimension module
40964131
-----------------------------------------------------------
40974132

@@ -4106,6 +4141,13 @@ datadog\_api\_client.v1.model.scatterplot\_table\_request module
41064141
:members:
41074142
:show-inheritance:
41084143

4144+
datadog\_api\_client.v1.model.scatterplot\_table\_request\_type module
4145+
----------------------------------------------------------------------
4146+
4147+
.. automodule:: datadog_api_client.v1.model.scatterplot_table_request_type
4148+
:members:
4149+
:show-inheritance:
4150+
41094151
datadog\_api\_client.v1.model.scatterplot\_widget\_aggregator module
41104152
--------------------------------------------------------------------
41114153

examples/v1/dashboards/CreateDashboard_2342457693.py

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
77
from datadog_api_client.v1.model.dashboard import Dashboard
88
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
9+
from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource
910
from datadog_api_client.v1.model.formula_and_function_metric_aggregation import FormulaAndFunctionMetricAggregation
1011
from datadog_api_client.v1.model.formula_and_function_metric_data_source import FormulaAndFunctionMetricDataSource
1112
from datadog_api_client.v1.model.formula_and_function_metric_query_definition import (
@@ -15,8 +16,15 @@
1516
from datadog_api_client.v1.model.scatter_plot_widget_definition import ScatterPlotWidgetDefinition
1617
from datadog_api_client.v1.model.scatter_plot_widget_definition_requests import ScatterPlotWidgetDefinitionRequests
1718
from datadog_api_client.v1.model.scatter_plot_widget_definition_type import ScatterPlotWidgetDefinitionType
19+
from datadog_api_client.v1.model.scatterplot_data_projection_dimension import ScatterplotDataProjectionDimension
20+
from datadog_api_client.v1.model.scatterplot_data_projection_projection import ScatterplotDataProjectionProjection
21+
from datadog_api_client.v1.model.scatterplot_data_projection_projection_type import (
22+
ScatterplotDataProjectionProjectionType,
23+
)
24+
from datadog_api_client.v1.model.scatterplot_data_projection_query import ScatterplotDataProjectionQuery
1825
from datadog_api_client.v1.model.scatterplot_dimension import ScatterplotDimension
1926
from datadog_api_client.v1.model.scatterplot_table_request import ScatterplotTableRequest
27+
from datadog_api_client.v1.model.scatterplot_table_request_type import ScatterplotTableRequestType
2028
from datadog_api_client.v1.model.scatterplot_widget_formula import ScatterplotWidgetFormula
2129
from datadog_api_client.v1.model.widget import Widget
2230
from datadog_api_client.v1.model.widget_axis import WidgetAxis
@@ -87,6 +95,55 @@
8795
color_by_groups=[],
8896
),
8997
),
98+
Widget(
99+
layout=WidgetLayout(
100+
x=48,
101+
y=0,
102+
width=47,
103+
height=15,
104+
),
105+
definition=ScatterPlotWidgetDefinition(
106+
title="Data Projection Scatterplot",
107+
title_size="16",
108+
title_align=WidgetTextAlign.LEFT,
109+
type=ScatterPlotWidgetDefinitionType.SCATTERPLOT,
110+
requests=ScatterPlotWidgetDefinitionRequests(
111+
table=ScatterplotTableRequest(
112+
request_type=ScatterplotTableRequestType.DATA_PROJECTION,
113+
query=ScatterplotDataProjectionQuery(
114+
query_string="@service:web-store",
115+
data_source=FormulaAndFunctionEventsDataSource.SPANS,
116+
),
117+
projection=ScatterplotDataProjectionProjection(
118+
type=ScatterplotDataProjectionProjectionType.SCATTERPLOT,
119+
dimensions=[
120+
ScatterplotDataProjectionDimension(
121+
column="duration",
122+
dimension=ScatterplotDimension.X,
123+
),
124+
ScatterplotDataProjectionDimension(
125+
column="@resource_name",
126+
dimension=ScatterplotDimension.Y,
127+
),
128+
],
129+
),
130+
limit=200,
131+
),
132+
),
133+
xaxis=WidgetAxis(
134+
scale="linear",
135+
include_zero=True,
136+
min="auto",
137+
max="auto",
138+
),
139+
yaxis=WidgetAxis(
140+
scale="linear",
141+
include_zero=True,
142+
min="auto",
143+
max="auto",
144+
),
145+
),
146+
),
90147
],
91148
template_variables=[],
92149
layout_type=DashboardLayoutType.FREE,

src/datadog_api_client/v1/model/scatter_plot_widget_definition_requests.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,10 @@ def __init__(
4646
"""
4747
Widget definition.
4848
49-
:param table: Scatterplot request containing formulas and functions.
49+
:param table: Scatterplot table request. Supports two modes:
50+
51+
* **Formulas and functions** (default): ``request_type`` is absent or ``"table"``. Uses ``queries`` and ``formulas``.
52+
* **Data projection** : ``request_type`` is ``"data_projection"``. Uses ``query`` , ``projection`` , and optionally ``limit``.
5053
:type table: ScatterplotTableRequest, optional
5154
5255
:param x: Updated scatter plot.
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
from typing import Union, TYPE_CHECKING
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
unset,
12+
UnsetType,
13+
)
14+
15+
16+
if TYPE_CHECKING:
17+
from datadog_api_client.v1.model.scatterplot_dimension import ScatterplotDimension
18+
from datadog_api_client.v1.model.widget_number_format import WidgetNumberFormat
19+
20+
21+
class ScatterplotDataProjectionDimension(ModelNormal):
22+
@cached_property
23+
def openapi_types(_):
24+
from datadog_api_client.v1.model.scatterplot_dimension import ScatterplotDimension
25+
from datadog_api_client.v1.model.widget_number_format import WidgetNumberFormat
26+
27+
return {
28+
"alias": (str,),
29+
"column": (str,),
30+
"dimension": (ScatterplotDimension,),
31+
"number_format": (WidgetNumberFormat,),
32+
}
33+
34+
attribute_map = {
35+
"alias": "alias",
36+
"column": "column",
37+
"dimension": "dimension",
38+
"number_format": "number_format",
39+
}
40+
41+
def __init__(
42+
self_,
43+
column: str,
44+
dimension: ScatterplotDimension,
45+
alias: Union[str, UnsetType] = unset,
46+
number_format: Union[WidgetNumberFormat, UnsetType] = unset,
47+
**kwargs,
48+
):
49+
"""
50+
A single dimension mapping for a scatterplot data projection.
51+
52+
:param alias: Display alias for the dimension.
53+
:type alias: str, optional
54+
55+
:param column: The column name from the data source.
56+
:type column: str
57+
58+
:param dimension: Dimension of the Scatterplot.
59+
:type dimension: ScatterplotDimension
60+
61+
:param number_format: Number format options for the widget.
62+
:type number_format: WidgetNumberFormat, optional
63+
"""
64+
if alias is not unset:
65+
kwargs["alias"] = alias
66+
if number_format is not unset:
67+
kwargs["number_format"] = number_format
68+
super().__init__(kwargs)
69+
70+
self_.column = column
71+
self_.dimension = dimension

0 commit comments

Comments
 (0)