Skip to content

Commit 5bed3f1

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit e1b11a7 of spec repo
1 parent 262a675 commit 5bed3f1

9 files changed

+291
-0
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50581,6 +50581,69 @@ components:
5058150581
type: string
5058250582
x-enum-varnames:
5058350583
- RULESET
50584+
RumCrossProductSampling:
50585+
description: 'Configuration for additional APM trace data retention for sessions
50586+
that match this retention filter.
50587+
50588+
When a session matches the filter and is retained (based on `sample_rate`),
50589+
you can configure
50590+
50591+
the percentage of retained sessions with ingested traces whose traces are
50592+
indexed.'
50593+
properties:
50594+
trace_enabled:
50595+
description: Indicates whether trace cross-product sampling is enabled.
50596+
If `false`, no traces are indexed regardless of `trace_sample_rate`.
50597+
example: true
50598+
type: boolean
50599+
trace_sample_rate:
50600+
description: 'The percentage (0-100) of retained sessions with ingested
50601+
traces whose traces are indexed.
50602+
50603+
For example, 25.0 means 25% of retained sessions with ingested traces
50604+
have their traces indexed.'
50605+
example: 25.0
50606+
format: double
50607+
maximum: 100
50608+
minimum: 0
50609+
type: number
50610+
type: object
50611+
RumCrossProductSamplingCreate:
50612+
description: Configuration for cross-product sampling when creating a retention
50613+
filter.
50614+
properties:
50615+
trace_enabled:
50616+
description: Indicates whether trace cross-product sampling is enabled.
50617+
example: true
50618+
type: boolean
50619+
trace_sample_rate:
50620+
description: The percentage (0-100) of retained sessions with ingested traces
50621+
whose traces are indexed.
50622+
example: 25.0
50623+
format: double
50624+
maximum: 100
50625+
minimum: 0
50626+
type: number
50627+
required:
50628+
- trace_sample_rate
50629+
type: object
50630+
RumCrossProductSamplingUpdate:
50631+
description: Configuration for cross-product sampling when updating a retention
50632+
filter. All fields are optional for partial updates.
50633+
properties:
50634+
trace_enabled:
50635+
description: Indicates whether trace cross-product sampling is enabled.
50636+
example: true
50637+
type: boolean
50638+
trace_sample_rate:
50639+
description: The percentage (0-100) of retained sessions with ingested traces
50640+
whose traces are indexed.
50641+
example: 25.0
50642+
format: double
50643+
maximum: 100
50644+
minimum: 0
50645+
type: number
50646+
type: object
5058450647
RumMetricCompute:
5058550648
description: The compute rule to compute the rum-based metric.
5058650649
properties:
@@ -50868,6 +50931,8 @@ components:
5086850931
RumRetentionFilterAttributes:
5086950932
description: The object describing attributes of a RUM retention filter.
5087050933
properties:
50934+
cross_product_sampling:
50935+
$ref: '#/components/schemas/RumCrossProductSampling'
5087150936
enabled:
5087250937
$ref: '#/components/schemas/RumRetentionFilterEnabled'
5087350938
event_type:
@@ -50882,6 +50947,8 @@ components:
5088250947
RumRetentionFilterCreateAttributes:
5088350948
description: The object describing attributes of a RUM retention filter to create.
5088450949
properties:
50950+
cross_product_sampling:
50951+
$ref: '#/components/schemas/RumCrossProductSamplingCreate'
5088550952
enabled:
5088650953
$ref: '#/components/schemas/RumRetentionFilterEnabled'
5088750954
event_type:
@@ -50983,6 +51050,8 @@ components:
5098351050
RumRetentionFilterUpdateAttributes:
5098451051
description: The object describing attributes of a RUM retention filter to update.
5098551052
properties:
51053+
cross_product_sampling:
51054+
$ref: '#/components/schemas/RumCrossProductSamplingUpdate'
5098651055
enabled:
5098751056
$ref: '#/components/schemas/RumRetentionFilterEnabled'
5098851057
event_type:

docs/datadog_api_client.v2.model.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22110,6 +22110,27 @@ datadog\_api\_client.v2.model.rum\_compute\_type module
2211022110
:members:
2211122111
:show-inheritance:
2211222112

22113+
datadog\_api\_client.v2.model.rum\_cross\_product\_sampling module
22114+
------------------------------------------------------------------
22115+
22116+
.. automodule:: datadog_api_client.v2.model.rum_cross_product_sampling
22117+
:members:
22118+
:show-inheritance:
22119+
22120+
datadog\_api\_client.v2.model.rum\_cross\_product\_sampling\_create module
22121+
--------------------------------------------------------------------------
22122+
22123+
.. automodule:: datadog_api_client.v2.model.rum_cross_product_sampling_create
22124+
:members:
22125+
:show-inheritance:
22126+
22127+
datadog\_api\_client.v2.model.rum\_cross\_product\_sampling\_update module
22128+
--------------------------------------------------------------------------
22129+
22130+
.. automodule:: datadog_api_client.v2.model.rum_cross_product_sampling_update
22131+
:members:
22132+
:show-inheritance:
22133+
2211322134
datadog\_api\_client.v2.model.rum\_event module
2211422135
-----------------------------------------------
2211522136

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
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
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
unset,
12+
UnsetType,
13+
)
14+
15+
16+
class RumCrossProductSampling(ModelNormal):
17+
validations = {
18+
"trace_sample_rate": {
19+
"inclusive_maximum": 100,
20+
"inclusive_minimum": 0,
21+
},
22+
}
23+
24+
@cached_property
25+
def openapi_types(_):
26+
return {
27+
"trace_enabled": (bool,),
28+
"trace_sample_rate": (float,),
29+
}
30+
31+
attribute_map = {
32+
"trace_enabled": "trace_enabled",
33+
"trace_sample_rate": "trace_sample_rate",
34+
}
35+
36+
def __init__(
37+
self_,
38+
trace_enabled: Union[bool, UnsetType] = unset,
39+
trace_sample_rate: Union[float, UnsetType] = unset,
40+
**kwargs,
41+
):
42+
"""
43+
Configuration for additional APM trace data retention for sessions that match this retention filter.
44+
When a session matches the filter and is retained (based on ``sample_rate`` ), you can configure
45+
the percentage of retained sessions with ingested traces whose traces are indexed.
46+
47+
:param trace_enabled: Indicates whether trace cross-product sampling is enabled. If ``false`` , no traces are indexed regardless of ``trace_sample_rate``.
48+
:type trace_enabled: bool, optional
49+
50+
:param trace_sample_rate: The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
51+
For example, 25.0 means 25% of retained sessions with ingested traces have their traces indexed.
52+
:type trace_sample_rate: float, optional
53+
"""
54+
if trace_enabled is not unset:
55+
kwargs["trace_enabled"] = trace_enabled
56+
if trace_sample_rate is not unset:
57+
kwargs["trace_sample_rate"] = trace_sample_rate
58+
super().__init__(kwargs)
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
unset,
12+
UnsetType,
13+
)
14+
15+
16+
class RumCrossProductSamplingCreate(ModelNormal):
17+
validations = {
18+
"trace_sample_rate": {
19+
"inclusive_maximum": 100,
20+
"inclusive_minimum": 0,
21+
},
22+
}
23+
24+
@cached_property
25+
def openapi_types(_):
26+
return {
27+
"trace_enabled": (bool,),
28+
"trace_sample_rate": (float,),
29+
}
30+
31+
attribute_map = {
32+
"trace_enabled": "trace_enabled",
33+
"trace_sample_rate": "trace_sample_rate",
34+
}
35+
36+
def __init__(self_, trace_sample_rate: float, trace_enabled: Union[bool, UnsetType] = unset, **kwargs):
37+
"""
38+
Configuration for cross-product sampling when creating a retention filter.
39+
40+
:param trace_enabled: Indicates whether trace cross-product sampling is enabled.
41+
:type trace_enabled: bool, optional
42+
43+
:param trace_sample_rate: The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
44+
:type trace_sample_rate: float
45+
"""
46+
if trace_enabled is not unset:
47+
kwargs["trace_enabled"] = trace_enabled
48+
super().__init__(kwargs)
49+
50+
self_.trace_sample_rate = trace_sample_rate
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
unset,
12+
UnsetType,
13+
)
14+
15+
16+
class RumCrossProductSamplingUpdate(ModelNormal):
17+
validations = {
18+
"trace_sample_rate": {
19+
"inclusive_maximum": 100,
20+
"inclusive_minimum": 0,
21+
},
22+
}
23+
24+
@cached_property
25+
def openapi_types(_):
26+
return {
27+
"trace_enabled": (bool,),
28+
"trace_sample_rate": (float,),
29+
}
30+
31+
attribute_map = {
32+
"trace_enabled": "trace_enabled",
33+
"trace_sample_rate": "trace_sample_rate",
34+
}
35+
36+
def __init__(
37+
self_,
38+
trace_enabled: Union[bool, UnsetType] = unset,
39+
trace_sample_rate: Union[float, UnsetType] = unset,
40+
**kwargs,
41+
):
42+
"""
43+
Configuration for cross-product sampling when updating a retention filter. All fields are optional for partial updates.
44+
45+
:param trace_enabled: Indicates whether trace cross-product sampling is enabled.
46+
:type trace_enabled: bool, optional
47+
48+
:param trace_sample_rate: The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
49+
:type trace_sample_rate: float, optional
50+
"""
51+
if trace_enabled is not unset:
52+
kwargs["trace_enabled"] = trace_enabled
53+
if trace_sample_rate is not unset:
54+
kwargs["trace_sample_rate"] = trace_sample_rate
55+
super().__init__(kwargs)

src/datadog_api_client/v2/model/rum_retention_filter_attributes.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515

1616
if TYPE_CHECKING:
17+
from datadog_api_client.v2.model.rum_cross_product_sampling import RumCrossProductSampling
1718
from datadog_api_client.v2.model.rum_retention_filter_event_type import RumRetentionFilterEventType
1819

1920

@@ -27,9 +28,11 @@ class RumRetentionFilterAttributes(ModelNormal):
2728

2829
@cached_property
2930
def openapi_types(_):
31+
from datadog_api_client.v2.model.rum_cross_product_sampling import RumCrossProductSampling
3032
from datadog_api_client.v2.model.rum_retention_filter_event_type import RumRetentionFilterEventType
3133

3234
return {
35+
"cross_product_sampling": (RumCrossProductSampling,),
3336
"enabled": (bool,),
3437
"event_type": (RumRetentionFilterEventType,),
3538
"name": (str,),
@@ -38,6 +41,7 @@ def openapi_types(_):
3841
}
3942

4043
attribute_map = {
44+
"cross_product_sampling": "cross_product_sampling",
4145
"enabled": "enabled",
4246
"event_type": "event_type",
4347
"name": "name",
@@ -47,6 +51,7 @@ def openapi_types(_):
4751

4852
def __init__(
4953
self_,
54+
cross_product_sampling: Union[RumCrossProductSampling, UnsetType] = unset,
5055
enabled: Union[bool, UnsetType] = unset,
5156
event_type: Union[RumRetentionFilterEventType, UnsetType] = unset,
5257
name: Union[str, UnsetType] = unset,
@@ -57,6 +62,11 @@ def __init__(
5762
"""
5863
The object describing attributes of a RUM retention filter.
5964
65+
:param cross_product_sampling: Configuration for additional APM trace data retention for sessions that match this retention filter.
66+
When a session matches the filter and is retained (based on ``sample_rate`` ), you can configure
67+
the percentage of retained sessions with ingested traces whose traces are indexed.
68+
:type cross_product_sampling: RumCrossProductSampling, optional
69+
6070
:param enabled: Whether the retention filter is enabled.
6171
:type enabled: bool, optional
6272
@@ -72,6 +82,8 @@ def __init__(
7282
:param sample_rate: The sample rate for a RUM retention filter, between 0.1 and 100.
7383
:type sample_rate: float, optional
7484
"""
85+
if cross_product_sampling is not unset:
86+
kwargs["cross_product_sampling"] = cross_product_sampling
7587
if enabled is not unset:
7688
kwargs["enabled"] = enabled
7789
if event_type is not unset:

0 commit comments

Comments
 (0)