Skip to content

Commit 4a1f620

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit c9aabc1 of spec repo (#3745)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 4368099 commit 4a1f620

14 files changed

Lines changed: 631 additions & 4 deletions

.generator/schemas/v1/openapi.yaml

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11287,6 +11287,12 @@ components:
1128711287
type: string
1128811288
status:
1128911289
$ref: "#/components/schemas/NotebookStatus"
11290+
template_variables:
11291+
description: List of template variables for this notebook.
11292+
items:
11293+
$ref: "#/components/schemas/NotebookTemplateVariable"
11294+
nullable: true
11295+
type: array
1129011296
time:
1129111297
$ref: "#/components/schemas/NotebookGlobalTime"
1129211298
required:
@@ -11506,6 +11512,12 @@ components:
1150611512
type: string
1150711513
status:
1150811514
$ref: "#/components/schemas/NotebookStatus"
11515+
template_variables:
11516+
description: List of template variables for this notebook.
11517+
items:
11518+
$ref: "#/components/schemas/NotebookTemplateVariable"
11519+
nullable: true
11520+
type: array
1150911521
time:
1151011522
$ref: "#/components/schemas/NotebookGlobalTime"
1151111523
required:
@@ -11548,6 +11560,128 @@ components:
1154811560
type: string
1154911561
x-enum-varnames:
1155011562
- PUBLISHED
11563+
NotebookTemplateVariable:
11564+
additionalProperties: false
11565+
description: Notebook template variable.
11566+
properties:
11567+
available_values:
11568+
description: The list of values that the template variable drop-down is limited to.
11569+
example: ["my-host", "host1", "host2"]
11570+
items:
11571+
description: Template variable value.
11572+
minLength: 1
11573+
type: string
11574+
nullable: true
11575+
type: array
11576+
uniqueItems: true
11577+
available_values_query:
11578+
$ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQuery"
11579+
data_source_mappings:
11580+
additionalProperties:
11581+
description: The value for the given data source.
11582+
type: string
11583+
description: Mapping of data source names to template variable values.
11584+
type: object
11585+
default:
11586+
deprecated: true
11587+
description: |-
11588+
(deprecated) The default value for the template variable on notebook load.
11589+
Cannot be used in conjunction with `defaults`.
11590+
example: my-host
11591+
nullable: true
11592+
type: string
11593+
defaults:
11594+
description: One or many default values for the template variable. Cannot be used in conjunction with `default`.
11595+
example: ["my-host-1", "my-host-2"]
11596+
items:
11597+
description: A default value for the template variable.
11598+
minLength: 1
11599+
type: string
11600+
type: array
11601+
uniqueItems: true
11602+
name:
11603+
description: The name of the variable.
11604+
example: host1
11605+
type: string
11606+
placement:
11607+
description: The placement of the template variable in the notebook.
11608+
example: global
11609+
type: string
11610+
prefix:
11611+
description: The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
11612+
example: host
11613+
nullable: true
11614+
type: string
11615+
type:
11616+
description: The type of the template variable.
11617+
example: tag
11618+
type: string
11619+
required:
11620+
- name
11621+
type: object
11622+
NotebookTemplateVariableAvailableValuesQuery:
11623+
description: Query used to dynamically populate the list of available values for the template variable.
11624+
oneOf:
11625+
- $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQueryLogRumSpans"
11626+
- $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQueryMetrics"
11627+
NotebookTemplateVariableAvailableValuesQueryGroupBy:
11628+
additionalProperties: false
11629+
description: A group-by facet for an available values query.
11630+
properties:
11631+
facet:
11632+
description: The facet name to group by.
11633+
example: host
11634+
type: string
11635+
required:
11636+
- facet
11637+
type: object
11638+
NotebookTemplateVariableAvailableValuesQueryLogRumSpans:
11639+
additionalProperties: false
11640+
description: Available values query for logs, RUM, or spans data sources.
11641+
properties:
11642+
data_source:
11643+
description: The data source for the query. Must be one of `logs`, `rum`, or `spans`.
11644+
example: logs
11645+
type: string
11646+
group_by:
11647+
description: Group-by fields for the query.
11648+
items:
11649+
$ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQueryGroupBy"
11650+
type: array
11651+
search:
11652+
$ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQuerySearch"
11653+
required:
11654+
- data_source
11655+
- search
11656+
- group_by
11657+
type: object
11658+
NotebookTemplateVariableAvailableValuesQueryMetrics:
11659+
additionalProperties: false
11660+
description: Available values query for the metrics data source.
11661+
properties:
11662+
data_source:
11663+
description: The data source for the query. Must be `metrics`.
11664+
example: metrics
11665+
type: string
11666+
query:
11667+
description: The metrics query string.
11668+
example: "avg:system.cpu.user{*} by {host}"
11669+
type: string
11670+
required:
11671+
- data_source
11672+
- query
11673+
type: object
11674+
NotebookTemplateVariableAvailableValuesQuerySearch:
11675+
additionalProperties: false
11676+
description: Search parameters for an available values query.
11677+
properties:
11678+
query:
11679+
description: The search query string.
11680+
example: "service:web"
11681+
type: string
11682+
required:
11683+
- query
11684+
type: object
1155111685
NotebookTimeseriesCellAttributes:
1155211686
description: The attributes of a notebook `timeseries` cell.
1155311687
properties:
@@ -11613,6 +11747,12 @@ components:
1161311747
type: string
1161411748
status:
1161511749
$ref: "#/components/schemas/NotebookStatus"
11750+
template_variables:
11751+
description: List of template variables for this notebook.
11752+
items:
11753+
$ref: "#/components/schemas/NotebookTemplateVariable"
11754+
nullable: true
11755+
type: array
1161611756
time:
1161711757
$ref: "#/components/schemas/NotebookGlobalTime"
1161811758
required:
@@ -11689,6 +11829,12 @@ components:
1168911829
type: string
1169011830
status:
1169111831
$ref: "#/components/schemas/NotebookStatus"
11832+
template_variables:
11833+
description: List of template variables for this notebook.
11834+
items:
11835+
$ref: "#/components/schemas/NotebookTemplateVariable"
11836+
nullable: true
11837+
type: array
1169211838
time:
1169311839
$ref: "#/components/schemas/NotebookGlobalTime"
1169411840
required:

docs/datadog_api_client.v1.model.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3364,6 +3364,48 @@ datadog\_api\_client.v1.model.notebook\_status module
33643364
:members:
33653365
:show-inheritance:
33663366

3367+
datadog\_api\_client.v1.model.notebook\_template\_variable module
3368+
-----------------------------------------------------------------
3369+
3370+
.. automodule:: datadog_api_client.v1.model.notebook_template_variable
3371+
:members:
3372+
:show-inheritance:
3373+
3374+
datadog\_api\_client.v1.model.notebook\_template\_variable\_available\_values\_query module
3375+
-------------------------------------------------------------------------------------------
3376+
3377+
.. automodule:: datadog_api_client.v1.model.notebook_template_variable_available_values_query
3378+
:members:
3379+
:show-inheritance:
3380+
3381+
datadog\_api\_client.v1.model.notebook\_template\_variable\_available\_values\_query\_group\_by module
3382+
------------------------------------------------------------------------------------------------------
3383+
3384+
.. automodule:: datadog_api_client.v1.model.notebook_template_variable_available_values_query_group_by
3385+
:members:
3386+
:show-inheritance:
3387+
3388+
datadog\_api\_client.v1.model.notebook\_template\_variable\_available\_values\_query\_log\_rum\_spans module
3389+
------------------------------------------------------------------------------------------------------------
3390+
3391+
.. automodule:: datadog_api_client.v1.model.notebook_template_variable_available_values_query_log_rum_spans
3392+
:members:
3393+
:show-inheritance:
3394+
3395+
datadog\_api\_client.v1.model.notebook\_template\_variable\_available\_values\_query\_metrics module
3396+
----------------------------------------------------------------------------------------------------
3397+
3398+
.. automodule:: datadog_api_client.v1.model.notebook_template_variable_available_values_query_metrics
3399+
:members:
3400+
:show-inheritance:
3401+
3402+
datadog\_api\_client.v1.model.notebook\_template\_variable\_available\_values\_query\_search module
3403+
---------------------------------------------------------------------------------------------------
3404+
3405+
.. automodule:: datadog_api_client.v1.model.notebook_template_variable_available_values_query_search
3406+
:members:
3407+
:show-inheritance:
3408+
33673409
datadog\_api\_client.v1.model.notebook\_timeseries\_cell\_attributes module
33683410
---------------------------------------------------------------------------
33693411

src/datadog_api_client/v1/model/notebook_create_data_attributes.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
from datadog_api_client.model_utils import (
99
ModelNormal,
1010
cached_property,
11+
none_type,
1112
unset,
1213
UnsetType,
1314
)
@@ -17,6 +18,7 @@
1718
from datadog_api_client.v1.model.notebook_cell_create_request import NotebookCellCreateRequest
1819
from datadog_api_client.v1.model.notebook_metadata import NotebookMetadata
1920
from datadog_api_client.v1.model.notebook_status import NotebookStatus
21+
from datadog_api_client.v1.model.notebook_template_variable import NotebookTemplateVariable
2022
from datadog_api_client.v1.model.notebook_global_time import NotebookGlobalTime
2123
from datadog_api_client.v1.model.notebook_relative_time import NotebookRelativeTime
2224
from datadog_api_client.v1.model.notebook_absolute_time import NotebookAbsoluteTime
@@ -35,13 +37,15 @@ def openapi_types(_):
3537
from datadog_api_client.v1.model.notebook_cell_create_request import NotebookCellCreateRequest
3638
from datadog_api_client.v1.model.notebook_metadata import NotebookMetadata
3739
from datadog_api_client.v1.model.notebook_status import NotebookStatus
40+
from datadog_api_client.v1.model.notebook_template_variable import NotebookTemplateVariable
3841
from datadog_api_client.v1.model.notebook_global_time import NotebookGlobalTime
3942

4043
return {
4144
"cells": ([NotebookCellCreateRequest],),
4245
"metadata": (NotebookMetadata,),
4346
"name": (str,),
4447
"status": (NotebookStatus,),
48+
"template_variables": ([NotebookTemplateVariable], none_type),
4549
"time": (NotebookGlobalTime,),
4650
}
4751

@@ -50,6 +54,7 @@ def openapi_types(_):
5054
"metadata": "metadata",
5155
"name": "name",
5256
"status": "status",
57+
"template_variables": "template_variables",
5358
"time": "time",
5459
}
5560

@@ -60,6 +65,7 @@ def __init__(
6065
time: Union[NotebookGlobalTime, NotebookRelativeTime, NotebookAbsoluteTime],
6166
metadata: Union[NotebookMetadata, UnsetType] = unset,
6267
status: Union[NotebookStatus, UnsetType] = unset,
68+
template_variables: Union[List[NotebookTemplateVariable], none_type, UnsetType] = unset,
6369
**kwargs,
6470
):
6571
"""
@@ -77,13 +83,18 @@ def __init__(
7783
:param status: Publication status of the notebook. For now, always "published".
7884
:type status: NotebookStatus, optional
7985
86+
:param template_variables: List of template variables for this notebook.
87+
:type template_variables: [NotebookTemplateVariable], none_type, optional
88+
8089
:param time: Notebook global timeframe.
8190
:type time: NotebookGlobalTime
8291
"""
8392
if metadata is not unset:
8493
kwargs["metadata"] = metadata
8594
if status is not unset:
8695
kwargs["status"] = status
96+
if template_variables is not unset:
97+
kwargs["template_variables"] = template_variables
8798
super().__init__(kwargs)
8899

89100
self_.cells = cells

src/datadog_api_client/v1/model/notebook_response_data_attributes.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
ModelNormal,
1010
cached_property,
1111
datetime,
12+
none_type,
1213
unset,
1314
UnsetType,
1415
)
@@ -19,6 +20,7 @@
1920
from datadog_api_client.v1.model.notebook_cell_response import NotebookCellResponse
2021
from datadog_api_client.v1.model.notebook_metadata import NotebookMetadata
2122
from datadog_api_client.v1.model.notebook_status import NotebookStatus
23+
from datadog_api_client.v1.model.notebook_template_variable import NotebookTemplateVariable
2224
from datadog_api_client.v1.model.notebook_global_time import NotebookGlobalTime
2325
from datadog_api_client.v1.model.notebook_relative_time import NotebookRelativeTime
2426
from datadog_api_client.v1.model.notebook_absolute_time import NotebookAbsoluteTime
@@ -38,6 +40,7 @@ def openapi_types(_):
3840
from datadog_api_client.v1.model.notebook_cell_response import NotebookCellResponse
3941
from datadog_api_client.v1.model.notebook_metadata import NotebookMetadata
4042
from datadog_api_client.v1.model.notebook_status import NotebookStatus
43+
from datadog_api_client.v1.model.notebook_template_variable import NotebookTemplateVariable
4144
from datadog_api_client.v1.model.notebook_global_time import NotebookGlobalTime
4245

4346
return {
@@ -48,6 +51,7 @@ def openapi_types(_):
4851
"modified": (datetime,),
4952
"name": (str,),
5053
"status": (NotebookStatus,),
54+
"template_variables": ([NotebookTemplateVariable], none_type),
5155
"time": (NotebookGlobalTime,),
5256
}
5357

@@ -59,6 +63,7 @@ def openapi_types(_):
5963
"modified": "modified",
6064
"name": "name",
6165
"status": "status",
66+
"template_variables": "template_variables",
6267
"time": "time",
6368
}
6469
read_only_vars = {
@@ -76,6 +81,7 @@ def __init__(
7681
metadata: Union[NotebookMetadata, UnsetType] = unset,
7782
modified: Union[datetime, UnsetType] = unset,
7883
status: Union[NotebookStatus, UnsetType] = unset,
84+
template_variables: Union[List[NotebookTemplateVariable], none_type, UnsetType] = unset,
7985
**kwargs,
8086
):
8187
"""
@@ -102,6 +108,9 @@ def __init__(
102108
:param status: Publication status of the notebook. For now, always "published".
103109
:type status: NotebookStatus, optional
104110
111+
:param template_variables: List of template variables for this notebook.
112+
:type template_variables: [NotebookTemplateVariable], none_type, optional
113+
105114
:param time: Notebook global timeframe.
106115
:type time: NotebookGlobalTime
107116
"""
@@ -115,6 +124,8 @@ def __init__(
115124
kwargs["modified"] = modified
116125
if status is not unset:
117126
kwargs["status"] = status
127+
if template_variables is not unset:
128+
kwargs["template_variables"] = template_variables
118129
super().__init__(kwargs)
119130

120131
self_.cells = cells

0 commit comments

Comments
 (0)