Skip to content

Commit b82c044

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 8cd544c of spec repo (#3595)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 8647bf8 commit b82c044

12 files changed

Lines changed: 477 additions & 2 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,14 @@ components:
296296
schema:
297297
format: int64
298298
type: integer
299+
CloudInventorySyncConfigID:
300+
description: Unique identifier of the Storage Management configuration.
301+
example: abc123
302+
in: path
303+
name: id
304+
required: true
305+
schema:
306+
type: string
299307
CloudWorkloadSecurityAgentRuleID:
300308
description: "The ID of the Agent rule"
301309
example: 3b5-v82-ns6
@@ -55624,6 +55632,7 @@ components:
5562455632
- $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestination"
5562555633
- $ref: "#/components/schemas/ObservabilityPipelineDatabricksZerobusDestination"
5562655634
- $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestination"
55635+
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestination"
5562755636
ObservabilityPipelineConfigPipelineType:
5562855637
default: logs
5562955638
description: The type of data being ingested. Defaults to `logs` if not specified.
@@ -59745,6 +59754,81 @@ components:
5974559754
type: string
5974659755
x-enum-varnames:
5974759756
- SPLUNK_HEC
59757+
ObservabilityPipelineSplunkHecMetricsDestination:
59758+
description: |-
59759+
The `splunk_hec_metrics` destination forwards metrics to Splunk using the HTTP Event Collector (HEC).
59760+
59761+
**Supported pipeline types:** metrics
59762+
properties:
59763+
buffer:
59764+
$ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
59765+
compression:
59766+
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationCompression"
59767+
default_namespace:
59768+
description: Optional default namespace for metrics sent to Splunk HEC.
59769+
example: "custom_namespace"
59770+
type: string
59771+
endpoint_url_key:
59772+
description: Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
59773+
example: SPLUNK_HEC_ENDPOINT_URL
59774+
type: string
59775+
id:
59776+
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
59777+
example: splunk-hec-metrics-destination
59778+
type: string
59779+
index:
59780+
description: Optional name of the Splunk index where metrics are written.
59781+
example: "metrics"
59782+
type: string
59783+
inputs:
59784+
description: A list of component IDs whose output is used as the `input` for this component.
59785+
example: ["metrics-filter-processor"]
59786+
items:
59787+
description: The ID of a component whose output is used as input for this destination.
59788+
type: string
59789+
type: array
59790+
source:
59791+
description: The Splunk source field value for metric events.
59792+
example: "observability_pipelines"
59793+
type: string
59794+
sourcetype:
59795+
description: The Splunk sourcetype to assign to metric events.
59796+
example: "custom_sourcetype"
59797+
type: string
59798+
tls:
59799+
$ref: "#/components/schemas/ObservabilityPipelineTls"
59800+
token_key:
59801+
description: Name of the environment variable or secret that holds the Splunk HEC token.
59802+
example: SPLUNK_HEC_TOKEN
59803+
type: string
59804+
type:
59805+
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationType"
59806+
required:
59807+
- id
59808+
- type
59809+
- inputs
59810+
type: object
59811+
x-pipeline-types: [metrics]
59812+
ObservabilityPipelineSplunkHecMetricsDestinationCompression:
59813+
default: none
59814+
description: Compression algorithm applied when sending metrics to Splunk HEC.
59815+
enum:
59816+
- none
59817+
- gzip
59818+
example: none
59819+
type: string
59820+
x-enum-varnames:
59821+
- NONE
59822+
- GZIP
59823+
ObservabilityPipelineSplunkHecMetricsDestinationType:
59824+
default: splunk_hec_metrics
59825+
description: The destination type. Always `splunk_hec_metrics`.
59826+
enum:
59827+
- splunk_hec_metrics
59828+
example: splunk_hec_metrics
59829+
type: string
59830+
x-enum-varnames:
59831+
- SPLUNK_HEC_METRICS
5974859832
ObservabilityPipelineSplunkHecSource:
5974959833
description: |-
5975059834
The `splunk_hec` source implements the Splunk HTTP Event Collector (HEC) API.
@@ -107705,6 +107789,33 @@ paths:
107705107789
operator: OR
107706107790
permissions:
107707107791
- aws_configurations_manage
107792+
/api/v2/cloudinventoryservice/syncconfigs/{id}:
107793+
delete:
107794+
description: |-
107795+
Delete a Storage Management configuration by its unique identifier. Deleting a configuration stops inventory file synchronization for the associated cloud account.
107796+
operationId: DeleteSyncConfig
107797+
parameters:
107798+
- $ref: "#/components/parameters/CloudInventorySyncConfigID"
107799+
responses:
107800+
"204":
107801+
description: No Content
107802+
"403":
107803+
$ref: "#/components/responses/ForbiddenResponse"
107804+
"404":
107805+
content:
107806+
application/json:
107807+
schema:
107808+
$ref: "#/components/schemas/JSONAPIErrorResponse"
107809+
description: Not Found
107810+
"429":
107811+
$ref: "#/components/responses/TooManyRequestsResponse"
107812+
summary: Delete a Storage Management configuration
107813+
tags:
107814+
- Storage Management
107815+
"x-permission":
107816+
operator: OR
107817+
permissions:
107818+
- aws_configurations_manage
107708107819
/api/v2/code-coverage/branch/summary:
107709107820
post:
107710107821
description: |-

docs/datadog_api_client.v2.model.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25470,6 +25470,27 @@ datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_destination\
2547025470
:members:
2547125471
:show-inheritance:
2547225472

25473+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination module
25474+
-----------------------------------------------------------------------------------------------
25475+
25476+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination
25477+
:members:
25478+
:show-inheritance:
25479+
25480+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_compression module
25481+
------------------------------------------------------------------------------------------------------------
25482+
25483+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression
25484+
:members:
25485+
:show-inheritance:
25486+
25487+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_type module
25488+
-----------------------------------------------------------------------------------------------------
25489+
25490+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type
25491+
:members:
25492+
:show-inheritance:
25493+
2547325494
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_source module
2547425495
---------------------------------------------------------------------------------
2547525496

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
Delete a Storage Management configuration returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.storage_management_api import StorageManagementApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = StorageManagementApi(api_client)
11+
api_instance.delete_sync_config(
12+
id="id",
13+
)

src/datadog_api_client/v2/api/storage_management_api.py

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,29 @@ def __init__(self, api_client=None):
2121
api_client = ApiClient(Configuration())
2222
self.api_client = api_client
2323

24+
self._delete_sync_config_endpoint = _Endpoint(
25+
settings={
26+
"response_type": None,
27+
"auth": ["apiKeyAuth", "appKeyAuth"],
28+
"endpoint_path": "/api/v2/cloudinventoryservice/syncconfigs/{id}",
29+
"operation_id": "delete_sync_config",
30+
"http_method": "DELETE",
31+
"version": "v2",
32+
},
33+
params_map={
34+
"id": {
35+
"required": True,
36+
"openapi_types": (str,),
37+
"attribute": "id",
38+
"location": "path",
39+
},
40+
},
41+
headers_map={
42+
"accept": ["*/*"],
43+
},
44+
api_client=api_client,
45+
)
46+
2447
self._upsert_sync_config_endpoint = _Endpoint(
2548
settings={
2649
"response_type": (CloudInventorySyncConfigResponse,),
@@ -41,6 +64,23 @@ def __init__(self, api_client=None):
4164
api_client=api_client,
4265
)
4366

67+
def delete_sync_config(
68+
self,
69+
id: str,
70+
) -> None:
71+
"""Delete a Storage Management configuration.
72+
73+
Delete a Storage Management configuration by its unique identifier. Deleting a configuration stops inventory file synchronization for the associated cloud account.
74+
75+
:param id: Unique identifier of the Storage Management configuration.
76+
:type id: str
77+
:rtype: None
78+
"""
79+
kwargs: Dict[str, Any] = {}
80+
kwargs["id"] = id
81+
82+
return self._delete_sync_config_endpoint.call_with_http_info(**kwargs)
83+
4484
def upsert_sync_config(
4585
self,
4686
body: UpsertCloudInventorySyncConfigRequest,

src/datadog_api_client/v2/model/observability_pipeline_config.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@
9797
from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination import (
9898
ObservabilityPipelineDatadogMetricsDestination,
9999
)
100+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination import (
101+
ObservabilityPipelineSplunkHecMetricsDestination,
102+
)
100103
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source import (
101104
ObservabilityPipelineDatadogAgentSource,
102105
)
@@ -200,6 +203,7 @@ def __init__(
200203
ObservabilityPipelineSyslogNgDestination,
201204
ObservabilityPipelineDatabricksZerobusDestination,
202205
ObservabilityPipelineDatadogMetricsDestination,
206+
ObservabilityPipelineSplunkHecMetricsDestination,
203207
]
204208
],
205209
sources: List[

src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,12 @@ def __init__(self, **kwargs):
226226
227227
:param unity_catalog_endpoint_key: Name of the environment variable or the secret identifier that references your Databricks workspace URL, which is used to communicate with the Unity Catalog API.
228228
:type unity_catalog_endpoint_key: str, optional
229+
230+
:param default_namespace: Optional default namespace for metrics sent to Splunk HEC.
231+
:type default_namespace: str, optional
232+
233+
:param source: The Splunk source field value for metric events.
234+
:type source: str, optional
229235
"""
230236
super().__init__(kwargs)
231237

@@ -309,6 +315,9 @@ def _composed_schemas(_):
309315
from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination import (
310316
ObservabilityPipelineDatadogMetricsDestination,
311317
)
318+
from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination import (
319+
ObservabilityPipelineSplunkHecMetricsDestination,
320+
)
312321

313322
return {
314323
"oneOf": [
@@ -337,5 +346,6 @@ def _composed_schemas(_):
337346
ObservabilityPipelineSyslogNgDestination,
338347
ObservabilityPipelineDatabricksZerobusDestination,
339348
ObservabilityPipelineDatadogMetricsDestination,
349+
ObservabilityPipelineSplunkHecMetricsDestination,
340350
],
341351
}

0 commit comments

Comments
 (0)