diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 3bec741a12..12e9531700 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -54741,26 +54741,16 @@ components: x-enum-varnames: - RULESET RumCrossProductSampling: - description: 'Configuration for additional APM trace data retention for sessions - that match this retention filter. - - When a session matches the filter and is retained (based on `sample_rate`), - you can configure - - the percentage of retained sessions with ingested traces whose traces are - indexed.' + description: The configuration for cross-product retention filters. properties: trace_enabled: - description: Indicates whether trace cross-product sampling is enabled. - If `false`, no traces are indexed regardless of `trace_sample_rate`. + description: Whether the cross-product retention filter for APM traces is + enabled. example: true type: boolean trace_sample_rate: - description: 'The percentage (0-100) of retained sessions with ingested - traces whose traces are indexed. - - For example, 25.0 means 25% of retained sessions with ingested traces - have their traces indexed.' + description: The sample rate for the APM cross-product retention filter, + between 0 and 100. example: 25.0 format: double maximum: 100 @@ -54768,16 +54758,16 @@ components: type: number type: object RumCrossProductSamplingCreate: - description: Configuration for cross-product sampling when creating a retention - filter. + description: The configuration for cross-product retention filters. properties: trace_enabled: - description: Indicates whether trace cross-product sampling is enabled. + description: Whether the cross-product retention filter for APM traces is + enabled. example: true type: boolean trace_sample_rate: - description: The percentage (0-100) of retained sessions with ingested traces - whose traces are indexed. + description: The sample rate for the APM cross-product retention filter, + between 0 and 100. example: 25.0 format: double maximum: 100 @@ -54787,16 +54777,17 @@ components: - trace_sample_rate type: object RumCrossProductSamplingUpdate: - description: Configuration for cross-product sampling when updating a retention - filter. All fields are optional for partial updates. + description: The configuration for cross-product retention filters. All fields + are optional for partial updates. properties: trace_enabled: - description: Indicates whether trace cross-product sampling is enabled. + description: Whether the cross-product retention filter for APM traces is + enabled. example: true type: boolean trace_sample_rate: - description: The percentage (0-100) of retained sessions with ingested traces - whose traces are indexed. + description: The sample rate for the APM cross-product retention filter, + between 0 and 100. example: 25.0 format: double maximum: 100 diff --git a/src/datadog_api_client/v2/model/rum_cross_product_sampling.py b/src/datadog_api_client/v2/model/rum_cross_product_sampling.py index cab3b5a574..60dbfde5eb 100644 --- a/src/datadog_api_client/v2/model/rum_cross_product_sampling.py +++ b/src/datadog_api_client/v2/model/rum_cross_product_sampling.py @@ -40,15 +40,12 @@ def __init__( **kwargs, ): """ - Configuration for additional APM trace data retention for sessions that match this retention filter. - When a session matches the filter and is retained (based on ``sample_rate`` ), you can configure - the percentage of retained sessions with ingested traces whose traces are indexed. + The configuration for cross-product retention filters. - :param trace_enabled: Indicates whether trace cross-product sampling is enabled. If ``false`` , no traces are indexed regardless of ``trace_sample_rate``. + :param trace_enabled: Whether the cross-product retention filter for APM traces is enabled. :type trace_enabled: bool, optional - :param trace_sample_rate: The percentage (0-100) of retained sessions with ingested traces whose traces are indexed. - For example, 25.0 means 25% of retained sessions with ingested traces have their traces indexed. + :param trace_sample_rate: The sample rate for the APM cross-product retention filter, between 0 and 100. :type trace_sample_rate: float, optional """ if trace_enabled is not unset: diff --git a/src/datadog_api_client/v2/model/rum_cross_product_sampling_create.py b/src/datadog_api_client/v2/model/rum_cross_product_sampling_create.py index c3e7588af8..209e9288be 100644 --- a/src/datadog_api_client/v2/model/rum_cross_product_sampling_create.py +++ b/src/datadog_api_client/v2/model/rum_cross_product_sampling_create.py @@ -35,12 +35,12 @@ def openapi_types(_): def __init__(self_, trace_sample_rate: float, trace_enabled: Union[bool, UnsetType] = unset, **kwargs): """ - Configuration for cross-product sampling when creating a retention filter. + The configuration for cross-product retention filters. - :param trace_enabled: Indicates whether trace cross-product sampling is enabled. + :param trace_enabled: Whether the cross-product retention filter for APM traces is enabled. :type trace_enabled: bool, optional - :param trace_sample_rate: The percentage (0-100) of retained sessions with ingested traces whose traces are indexed. + :param trace_sample_rate: The sample rate for the APM cross-product retention filter, between 0 and 100. :type trace_sample_rate: float """ if trace_enabled is not unset: diff --git a/src/datadog_api_client/v2/model/rum_cross_product_sampling_update.py b/src/datadog_api_client/v2/model/rum_cross_product_sampling_update.py index b8078ece6d..336055e9a2 100644 --- a/src/datadog_api_client/v2/model/rum_cross_product_sampling_update.py +++ b/src/datadog_api_client/v2/model/rum_cross_product_sampling_update.py @@ -40,12 +40,12 @@ def __init__( **kwargs, ): """ - Configuration for cross-product sampling when updating a retention filter. All fields are optional for partial updates. + The configuration for cross-product retention filters. All fields are optional for partial updates. - :param trace_enabled: Indicates whether trace cross-product sampling is enabled. + :param trace_enabled: Whether the cross-product retention filter for APM traces is enabled. :type trace_enabled: bool, optional - :param trace_sample_rate: The percentage (0-100) of retained sessions with ingested traces whose traces are indexed. + :param trace_sample_rate: The sample rate for the APM cross-product retention filter, between 0 and 100. :type trace_sample_rate: float, optional """ if trace_enabled is not unset: diff --git a/src/datadog_api_client/v2/model/rum_retention_filter_attributes.py b/src/datadog_api_client/v2/model/rum_retention_filter_attributes.py index e0e3c1a31b..1b9260bb13 100644 --- a/src/datadog_api_client/v2/model/rum_retention_filter_attributes.py +++ b/src/datadog_api_client/v2/model/rum_retention_filter_attributes.py @@ -62,9 +62,7 @@ def __init__( """ The object describing attributes of a RUM retention filter. - :param cross_product_sampling: Configuration for additional APM trace data retention for sessions that match this retention filter. - When a session matches the filter and is retained (based on ``sample_rate`` ), you can configure - the percentage of retained sessions with ingested traces whose traces are indexed. + :param cross_product_sampling: The configuration for cross-product retention filters. :type cross_product_sampling: RumCrossProductSampling, optional :param enabled: Whether the retention filter is enabled. diff --git a/src/datadog_api_client/v2/model/rum_retention_filter_create_attributes.py b/src/datadog_api_client/v2/model/rum_retention_filter_create_attributes.py index 0dd77b60be..ff5a06f7d4 100644 --- a/src/datadog_api_client/v2/model/rum_retention_filter_create_attributes.py +++ b/src/datadog_api_client/v2/model/rum_retention_filter_create_attributes.py @@ -62,7 +62,7 @@ def __init__( """ The object describing attributes of a RUM retention filter to create. - :param cross_product_sampling: Configuration for cross-product sampling when creating a retention filter. + :param cross_product_sampling: The configuration for cross-product retention filters. :type cross_product_sampling: RumCrossProductSamplingCreate, optional :param enabled: Whether the retention filter is enabled. diff --git a/src/datadog_api_client/v2/model/rum_retention_filter_update_attributes.py b/src/datadog_api_client/v2/model/rum_retention_filter_update_attributes.py index efd7543d20..9245b021d0 100644 --- a/src/datadog_api_client/v2/model/rum_retention_filter_update_attributes.py +++ b/src/datadog_api_client/v2/model/rum_retention_filter_update_attributes.py @@ -62,7 +62,7 @@ def __init__( """ The object describing attributes of a RUM retention filter to update. - :param cross_product_sampling: Configuration for cross-product sampling when updating a retention filter. All fields are optional for partial updates. + :param cross_product_sampling: The configuration for cross-product retention filters. All fields are optional for partial updates. :type cross_product_sampling: RumCrossProductSamplingUpdate, optional :param enabled: Whether the retention filter is enabled.