Skip to content

Expose use_legacy_search_syntax flag in the Observability Pipelines API #3130

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.

Sign up for GitHub

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
+23 −0
Open

Expose use_legacy_search_syntax flag in the Observability Pipelines API #3130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37916,6 +37916,18 @@ components:
items:
$ref: '#/components/schemas/ObservabilityPipelineConfigSourceItem'
type: array
use_legacy_search_syntax:
description: 'Set to `true` to continue using the legacy search syntax while
migrating filter queries. After migrating all queries to the new syntax,
set to `false`.

The legacy syntax is deprecated and will eventually be removed.

Requires Observability Pipelines Worker 2.11 or later.

See [Upgrade Your Filter Queries to the New Search Syntax](https://docs.datadoghq.com/observability_pipelines/guide/upgrade_your_filter_queries_to_the_new_search_syntax/)
for more information.'
type: boolean
required:
- sources
- destinations
Expand Down
11 changes: 11 additions & 0 deletions src/datadog_api_client/v2/model/observability_pipeline_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ def openapi_types(_):
"processor_groups": ([ObservabilityPipelineConfigProcessorGroup],),
"processors": ([ObservabilityPipelineConfigProcessorGroup],),
"sources": ([ObservabilityPipelineConfigSourceItem],),
"use_legacy_search_syntax": (bool,),
}

attribute_map = {
Expand All @@ -160,6 +161,7 @@ def openapi_types(_):
"processor_groups": "processor_groups",
"processors": "processors",
"sources": "sources",
"use_legacy_search_syntax": "use_legacy_search_syntax",
}

def __init__(
Expand Down Expand Up @@ -217,6 +219,7 @@ def __init__(
pipeline_type: Union[ObservabilityPipelineConfigPipelineType, UnsetType] = unset,
processor_groups: Union[List[ObservabilityPipelineConfigProcessorGroup], UnsetType] = unset,
processors: Union[List[ObservabilityPipelineConfigProcessorGroup], UnsetType] = unset,
use_legacy_search_syntax: Union[bool, UnsetType] = unset,
**kwargs,
):
"""
Expand All @@ -238,13 +241,21 @@ def __init__(

:param sources: A list of configured data sources for the pipeline.
:type sources: [ObservabilityPipelineConfigSourceItem]

:param use_legacy_search_syntax: Set to ``true`` to continue using the legacy search syntax while migrating filter queries. After migrating all queries to the new syntax, set to ``false``.
The legacy syntax is deprecated and will eventually be removed.
Requires Observability Pipelines Worker 2.11 or later.
See `Upgrade Your Filter Queries to the New Search Syntax <https://docs.datadoghq.com/observability_pipelines/guide/upgrade_your_filter_queries_to_the_new_search_syntax/>`_ for more information.
:type use_legacy_search_syntax: bool, optional
"""
if pipeline_type is not unset:
kwargs["pipeline_type"] = pipeline_type
if processor_groups is not unset:
kwargs["processor_groups"] = processor_groups
if processors is not unset:
kwargs["processors"] = processors
if use_legacy_search_syntax is not unset:
kwargs["use_legacy_search_syntax"] = use_legacy_search_syntax
super().__init__(kwargs)

self_.destinations = destinations
Expand Down