Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for geomap widget using response_type event_list #1534

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.4",
"regenerated": "2023-06-28 13:29:53.237675",
"spec_repo_commit": "042157e1"
"regenerated": "2023-06-28 20:35:54.929673",
"spec_repo_commit": "e0f0af3f"
},
"v2": {
"apigentools_version": "1.6.4",
"regenerated": "2023-06-28 13:29:53.250399",
"spec_repo_commit": "042157e1"
"regenerated": "2023-06-28 20:35:54.954768",
"spec_repo_commit": "e0f0af3f"
}
}
}
17 changes: 16 additions & 1 deletion .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2731,15 +2731,18 @@ components:
- $ref: '#/components/schemas/FormulaAndFunctionSLOQueryDefinition'
type: object
FormulaAndFunctionResponseFormat:
description: Timeseries or Scalar response.
description: Timeseries, scalar, or event list response. Event list response
formats are supported by Geomap widgets.
enum:
- timeseries
- scalar
- event_list
example: timeseries
type: string
x-enum-varnames:
- TIMESERIES
- SCALAR
- EVENT_LIST
FormulaAndFunctionSLODataSource:
description: Data source for SLO measures queries.
enum:
Expand Down Expand Up @@ -3127,6 +3130,16 @@ components:
GeomapWidgetRequest:
description: An updated geomap widget.
properties:
columns:
description: Widget columns.
example:
- field: timestamp
width: auto
- field: content
width: full
items:
$ref: '#/components/schemas/ListStreamColumn'
type: array
formulas:
description: List of formulas that operate on queries.
items:
Expand All @@ -3142,6 +3155,8 @@ components:
items:
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
query:
$ref: '#/components/schemas/ListStreamQuery'
response_format:
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
Expand Down
98 changes: 98 additions & 0 deletions examples/v1/dashboards/CreateDashboard_3513586382.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
"""
Create a geomap widget using an event_list request
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.dashboard_reflow_type import DashboardReflowType
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
from datadog_api_client.v1.model.geomap_widget_definition import GeomapWidgetDefinition
from datadog_api_client.v1.model.geomap_widget_definition_style import GeomapWidgetDefinitionStyle
from datadog_api_client.v1.model.geomap_widget_definition_type import GeomapWidgetDefinitionType
from datadog_api_client.v1.model.geomap_widget_definition_view import GeomapWidgetDefinitionView
from datadog_api_client.v1.model.geomap_widget_request import GeomapWidgetRequest
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
from datadog_api_client.v1.model.list_stream_column_width import ListStreamColumnWidth
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
from datadog_api_client.v1.model.list_stream_source import ListStreamSource
from datadog_api_client.v1.model.widget import Widget
from datadog_api_client.v1.model.widget_layout import WidgetLayout
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign

body = Dashboard(
title="Example-Dashboard",
description="Example-Dashboard",
widgets=[
Widget(
definition=GeomapWidgetDefinition(
title="",
title_size="16",
title_align=WidgetTextAlign.LEFT,
type=GeomapWidgetDefinitionType.GEOMAP,
requests=[
GeomapWidgetRequest(
response_format=FormulaAndFunctionResponseFormat.EVENT_LIST,
query=ListStreamQuery(
data_source=ListStreamSource.LOGS_STREAM,
query_string="",
indexes=[],
),
columns=[
ListStreamColumn(
field="@network.client.geoip.location.latitude",
width=ListStreamColumnWidth.AUTO,
),
ListStreamColumn(
field="@network.client.geoip.location.longitude",
width=ListStreamColumnWidth.AUTO,
),
ListStreamColumn(
field="@network.client.geoip.country.iso_code",
width=ListStreamColumnWidth.AUTO,
),
ListStreamColumn(
field="@network.client.geoip.subdivision.name",
width=ListStreamColumnWidth.AUTO,
),
ListStreamColumn(
field="classic",
width=ListStreamColumnWidth.AUTO,
),
ListStreamColumn(
field="",
width=ListStreamColumnWidth.AUTO,
),
],
),
],
style=GeomapWidgetDefinitionStyle(
palette="hostmap_blues",
palette_flip=False,
),
view=GeomapWidgetDefinitionView(
focus="WORLD",
),
),
layout=WidgetLayout(
x=0,
y=0,
width=12,
height=6,
),
),
],
template_variables=[],
layout_type=DashboardLayoutType.ORDERED,
notify_list=[],
reflow_type=DashboardReflowType.FIXED,
tags=[],
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.create_dashboard(body=body)

print(response)
2 changes: 1 addition & 1 deletion src/datadog_api_client/v1/model/change_widget_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ def __init__(
:param queries: List of queries that can be returned directly or used in formulas.
:type queries: [FormulaAndFunctionQueryDefinition], optional

:param response_format: Timeseries or Scalar response.
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
:type response_format: FormulaAndFunctionResponseFormat, optional

:param rum_query: The log query.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,20 @@

class FormulaAndFunctionResponseFormat(ModelSimple):
"""
Timeseries or Scalar response.
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.

:param value: Must be one of ["timeseries", "scalar"].
:param value: Must be one of ["timeseries", "scalar", "event_list"].
:type value: str
"""

allowed_values = {
"timeseries",
"scalar",
"event_list",
}
TIMESERIES: ClassVar["FormulaAndFunctionResponseFormat"]
SCALAR: ClassVar["FormulaAndFunctionResponseFormat"]
EVENT_LIST: ClassVar["FormulaAndFunctionResponseFormat"]

@cached_property
def openapi_types(_):
Expand All @@ -36,3 +38,4 @@ def openapi_types(_):

FormulaAndFunctionResponseFormat.TIMESERIES = FormulaAndFunctionResponseFormat("timeseries")
FormulaAndFunctionResponseFormat.SCALAR = FormulaAndFunctionResponseFormat("scalar")
FormulaAndFunctionResponseFormat.EVENT_LIST = FormulaAndFunctionResponseFormat("event_list")
22 changes: 21 additions & 1 deletion src/datadog_api_client/v1/model/geomap_widget_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@


if TYPE_CHECKING:
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
from datadog_api_client.v1.model.widget_formula import WidgetFormula
from datadog_api_client.v1.model.log_query_definition import LogQueryDefinition
from datadog_api_client.v1.model.formula_and_function_query_definition import FormulaAndFunctionQueryDefinition
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
from datadog_api_client.v1.model.formula_and_function_metric_query_definition import (
FormulaAndFunctionMetricQueryDefinition,
Expand All @@ -41,33 +43,40 @@
class GeomapWidgetRequest(ModelNormal):
@cached_property
def openapi_types(_):
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
from datadog_api_client.v1.model.widget_formula import WidgetFormula
from datadog_api_client.v1.model.log_query_definition import LogQueryDefinition
from datadog_api_client.v1.model.formula_and_function_query_definition import FormulaAndFunctionQueryDefinition
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat

return {
"columns": ([ListStreamColumn],),
"formulas": ([WidgetFormula],),
"log_query": (LogQueryDefinition,),
"q": (str,),
"queries": ([FormulaAndFunctionQueryDefinition],),
"query": (ListStreamQuery,),
"response_format": (FormulaAndFunctionResponseFormat,),
"rum_query": (LogQueryDefinition,),
"security_query": (LogQueryDefinition,),
}

attribute_map = {
"columns": "columns",
"formulas": "formulas",
"log_query": "log_query",
"q": "q",
"queries": "queries",
"query": "query",
"response_format": "response_format",
"rum_query": "rum_query",
"security_query": "security_query",
}

def __init__(
self_,
columns: Union[List[ListStreamColumn], UnsetType] = unset,
formulas: Union[List[WidgetFormula], UnsetType] = unset,
log_query: Union[LogQueryDefinition, UnsetType] = unset,
q: Union[str, UnsetType] = unset,
Expand All @@ -85,6 +94,7 @@ def __init__(
],
UnsetType,
] = unset,
query: Union[ListStreamQuery, UnsetType] = unset,
response_format: Union[FormulaAndFunctionResponseFormat, UnsetType] = unset,
rum_query: Union[LogQueryDefinition, UnsetType] = unset,
security_query: Union[LogQueryDefinition, UnsetType] = unset,
Expand All @@ -93,6 +103,9 @@ def __init__(
"""
An updated geomap widget.

:param columns: Widget columns.
:type columns: [ListStreamColumn], optional

:param formulas: List of formulas that operate on queries.
:type formulas: [WidgetFormula], optional

Expand All @@ -105,7 +118,10 @@ def __init__(
:param queries: List of queries that can be returned directly or used in formulas.
:type queries: [FormulaAndFunctionQueryDefinition], optional

:param response_format: Timeseries or Scalar response.
:param query: Updated list stream widget.
:type query: ListStreamQuery, optional

:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
:type response_format: FormulaAndFunctionResponseFormat, optional

:param rum_query: The log query.
Expand All @@ -114,6 +130,8 @@ def __init__(
:param security_query: The log query.
:type security_query: LogQueryDefinition, optional
"""
if columns is not unset:
kwargs["columns"] = columns
if formulas is not unset:
kwargs["formulas"] = formulas
if log_query is not unset:
Expand All @@ -122,6 +140,8 @@ def __init__(
kwargs["q"] = q
if queries is not unset:
kwargs["queries"] = queries
if query is not unset:
kwargs["query"] = query
if response_format is not unset:
kwargs["response_format"] = response_format
if rum_query is not unset:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ def __init__(
:param queries: List of queries that can be returned directly or used in formulas.
:type queries: [FormulaAndFunctionQueryDefinition], optional

:param response_format: Timeseries or Scalar response.
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
:type response_format: FormulaAndFunctionResponseFormat, optional

:param rum_query: The log query.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def __init__(
:param queries: List of queries that can be returned directly or used in formulas.
:type queries: [FormulaAndFunctionQueryDefinition], optional

:param response_format: Timeseries or Scalar response.
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
:type response_format: FormulaAndFunctionResponseFormat, optional
"""
if formulas is not unset:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ def __init__(
:param queries: List of queries that can be returned directly or used in formulas.
:type queries: [FormulaAndFunctionQueryDefinition], optional

:param response_format: Timeseries or Scalar response.
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
:type response_format: FormulaAndFunctionResponseFormat, optional

:param rum_query: The log query.
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v1/model/table_widget_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ def __init__(
:param queries: List of queries that can be returned directly or used in formulas.
:type queries: [FormulaAndFunctionQueryDefinition], optional

:param response_format: Timeseries or Scalar response.
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
:type response_format: FormulaAndFunctionResponseFormat, optional

:param rum_query: The log query.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ def __init__(
:param queries: List of queries that can be returned directly or used in formulas.
:type queries: [FormulaAndFunctionQueryDefinition], optional

:param response_format: Timeseries or Scalar response.
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
:type response_format: FormulaAndFunctionResponseFormat, optional

:param rum_query: The log query.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ def __init__(
:param queries: List of queries that can be returned directly or used in formulas.
:type queries: [FormulaAndFunctionQueryDefinition], optional

:param response_format: Timeseries or Scalar response.
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
:type response_format: FormulaAndFunctionResponseFormat, optional

:param rum_query: The log query.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def __init__(
:param queries: List of queries that can be returned directly or used in formulas.
:type queries: [FormulaAndFunctionQueryDefinition], optional

:param response_format: Timeseries or Scalar response.
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
:type response_format: FormulaAndFunctionResponseFormat, optional
"""
if formulas is not unset:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2023-06-21T19:29:03.584Z
Loading