Skip to content

Commit d67e441

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit a8278b6 of spec repo
1 parent 9a09c58 commit d67e441

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
@@ -13325,6 +13325,88 @@ components:
1332513325
type: string
1332613326
x-enum-varnames:
1332713327
- SCATTERPLOT
13328+
ScatterplotDataProjectionDimension:
13329+
description: A single dimension mapping for a scatterplot data projection.
13330+
properties:
13331+
alias:
13332+
description: Display alias for the dimension.
13333+
type: string
13334+
column:
13335+
description: The column name from the data source.
13336+
example: duration
13337+
type: string
13338+
dimension:
13339+
$ref: "#/components/schemas/ScatterplotDimension"
13340+
number_format:
13341+
$ref: "#/components/schemas/WidgetNumberFormat"
13342+
required:
13343+
- column
13344+
- dimension
13345+
type: object
13346+
ScatterplotDataProjectionProjection:
13347+
description: The projection configuration for a scatterplot data projection request.
13348+
properties:
13349+
dimensions:
13350+
description: Dimension mappings for the scatterplot axes.
13351+
items:
13352+
$ref: "#/components/schemas/ScatterplotDataProjectionDimension"
13353+
type: array
13354+
type:
13355+
$ref: "#/components/schemas/ScatterplotDataProjectionProjectionType"
13356+
required:
13357+
- type
13358+
- dimensions
13359+
type: object
13360+
ScatterplotDataProjectionProjectionType:
13361+
description: The type of the scatterplot data projection.
13362+
enum:
13363+
- scatterplot
13364+
example: scatterplot
13365+
type: string
13366+
x-enum-varnames:
13367+
- SCATTERPLOT
13368+
ScatterplotDataProjectionQuery:
13369+
description: The query for a scatterplot data projection request.
13370+
properties:
13371+
data_source:
13372+
$ref: "#/components/schemas/FormulaAndFunctionEventsDataSource"
13373+
indexes:
13374+
description: Indexes to search.
13375+
items:
13376+
type: string
13377+
type: array
13378+
query_string:
13379+
description: The search query string.
13380+
example: "@service:web-store"
13381+
type: string
13382+
storage:
13383+
$ref: "#/components/schemas/ScatterplotDataProjectionQueryStorage"
13384+
required:
13385+
- query_string
13386+
- data_source
13387+
type: object
13388+
ScatterplotDataProjectionQueryStorage:
13389+
description: Storage tier to query.
13390+
enum:
13391+
- live
13392+
- hot
13393+
- habanero
13394+
- online_archives
13395+
- driveline
13396+
- flex_tier
13397+
- case_insensitive
13398+
- cloud_prem
13399+
example: hot
13400+
type: string
13401+
x-enum-varnames:
13402+
- LIVE
13403+
- HOT
13404+
- HABANERO
13405+
- ONLINE_ARCHIVES
13406+
- DRIVELINE
13407+
- FLEX_TIER
13408+
- CASE_INSENSITIVE
13409+
- CLOUD_PREM
1332813410
ScatterplotDimension:
1332913411
description: Dimension of the Scatterplot.
1333013412
enum:
@@ -13340,21 +13422,47 @@ components:
1334013422
- RADIUS
1334113423
- COLOR
1334213424
ScatterplotTableRequest:
13343-
description: Scatterplot request containing formulas and functions.
13425+
description: |-
13426+
Scatterplot table request. Supports two modes:
13427+
- **Formulas and functions** (default): `request_type` is absent or `"table"`. Uses `queries` and `formulas`.
13428+
- **Data projection**: `request_type` is `"data_projection"`. Uses `query`, `projection`, and optionally `limit`.
1334413429
properties:
1334513430
formulas:
1334613431
description: List of Scatterplot formulas that operate on queries.
1334713432
items:
1334813433
$ref: "#/components/schemas/ScatterplotWidgetFormula"
1334913434
type: array
13435+
limit:
13436+
description: Maximum number of rows to return. Used when `request_type` is `"data_projection"`.
13437+
format: int64
13438+
type: integer
13439+
projection:
13440+
$ref: "#/components/schemas/ScatterplotDataProjectionProjection"
13441+
description: Projection configuration for data projection mode. Used when `request_type` is `"data_projection"`.
1335013442
queries:
1335113443
description: List of queries that can be returned directly or used in formulas.
1335213444
items:
1335313445
$ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
1335413446
type: array
13447+
query:
13448+
$ref: "#/components/schemas/ScatterplotDataProjectionQuery"
13449+
description: Query for data projection mode. Used when `request_type` is `"data_projection"`.
13450+
request_type:
13451+
$ref: "#/components/schemas/ScatterplotTableRequestType"
13452+
description: The type of the scatterplot table request. Use `"data_projection"` for unaggregated raw data.
1335513453
response_format:
1335613454
$ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
1335713455
type: object
13456+
ScatterplotTableRequestType:
13457+
description: The type of the scatterplot table request.
13458+
enum:
13459+
- table
13460+
- data_projection
13461+
example: data_projection
13462+
type: string
13463+
x-enum-varnames:
13464+
- TABLE
13465+
- DATA_PROJECTION
1335813466
ScatterplotWidgetAggregator:
1335913467
description: Aggregator used for the request.
1336013468
enum:

docs/datadog_api_client.v1.model.rst

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

3626+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_dimension module
3627+
-----------------------------------------------------------------------------
3628+
3629+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_dimension
3630+
:members:
3631+
:show-inheritance:
3632+
3633+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_projection module
3634+
------------------------------------------------------------------------------
3635+
3636+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_projection
3637+
:members:
3638+
:show-inheritance:
3639+
3640+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_projection\_type module
3641+
------------------------------------------------------------------------------------
3642+
3643+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_projection_type
3644+
:members:
3645+
:show-inheritance:
3646+
3647+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_query module
3648+
-------------------------------------------------------------------------
3649+
3650+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_query
3651+
:members:
3652+
:show-inheritance:
3653+
3654+
datadog\_api\_client.v1.model.scatterplot\_data\_projection\_query\_storage module
3655+
----------------------------------------------------------------------------------
3656+
3657+
.. automodule:: datadog_api_client.v1.model.scatterplot_data_projection_query_storage
3658+
:members:
3659+
:show-inheritance:
3660+
36263661
datadog\_api\_client.v1.model.scatterplot\_dimension module
36273662
-----------------------------------------------------------
36283663

@@ -3637,6 +3672,13 @@ datadog\_api\_client.v1.model.scatterplot\_table\_request module
36373672
:members:
36383673
:show-inheritance:
36393674

3675+
datadog\_api\_client.v1.model.scatterplot\_table\_request\_type module
3676+
----------------------------------------------------------------------
3677+
3678+
.. automodule:: datadog_api_client.v1.model.scatterplot_table_request_type
3679+
:members:
3680+
:show-inheritance:
3681+
36403682
datadog\_api\_client.v1.model.scatterplot\_widget\_aggregator module
36413683
--------------------------------------------------------------------
36423684

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)