Skip to content

Commit 165b1b5

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 9aaf22c of spec repo
1 parent 8647bf8 commit 165b1b5

18 files changed

Lines changed: 756 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48923,6 +48923,51 @@ components:
4892348923
example: "/api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0"
4892448924
type: string
4892548925
type: object
48926+
ListRowsResponse:
48927+
description: Paginated list of reference table rows.
48928+
example:
48929+
data:
48930+
- attributes:
48931+
values:
48932+
category: tor
48933+
intention: suspicious
48934+
ip_address: 102.130.113.9
48935+
id: 102.130.113.9
48936+
type: row
48937+
links:
48938+
first: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Blimit%5D=100"
48939+
self: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Bcontinuation_token%5D=eyJzaWQiOjEyMzQ1LCJwayI6ImV4YW1wbGVfcGsifQ%3D%3D&page%5Blimit%5D=100"
48940+
properties:
48941+
data:
48942+
description: The rows.
48943+
items:
48944+
$ref: "#/components/schemas/TableRowResourceData"
48945+
type: array
48946+
links:
48947+
$ref: "#/components/schemas/ListRowsResponseLinks"
48948+
required:
48949+
- data
48950+
- links
48951+
type: object
48952+
ListRowsResponseLinks:
48953+
description: Pagination links for the list rows response.
48954+
properties:
48955+
first:
48956+
description: Link to the first page of results.
48957+
example: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Blimit%5D=100"
48958+
type: string
48959+
next:
48960+
description: Link to the next page of results. Only present when more rows are available.
48961+
example: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Bcontinuation_token%5D=eyJzaWQiOjEyMzQ1LCJwayI6ImV4YW1wbGVfcGsifQ%3D%3D&page%5Blimit%5D=100"
48962+
type: string
48963+
self:
48964+
description: Link to the current page of results.
48965+
example: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Bcontinuation_token%5D=eyJzaWQiOjEyMzQ1LCJwayI6ImV4YW1wbGVfcGsifQ%3D%3D&page%5Blimit%5D=100"
48966+
type: string
48967+
required:
48968+
- self
48969+
- first
48970+
type: object
4892648971
ListRulesResponse:
4892748972
description: Scorecard rules response.
4892848973
properties:
@@ -55624,6 +55669,7 @@ components:
5562455669
- $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestination"
5562555670
- $ref: "#/components/schemas/ObservabilityPipelineDatabricksZerobusDestination"
5562655671
- $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestination"
55672+
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestination"
5562755673
ObservabilityPipelineConfigPipelineType:
5562855674
default: logs
5562955675
description: The type of data being ingested. Defaults to `logs` if not specified.
@@ -59745,6 +59791,81 @@ components:
5974559791
type: string
5974659792
x-enum-varnames:
5974759793
- SPLUNK_HEC
59794+
ObservabilityPipelineSplunkHecMetricsDestination:
59795+
description: |-
59796+
The `splunk_hec_metrics` destination forwards metrics to Splunk using the HTTP Event Collector (HEC).
59797+
59798+
**Supported pipeline types:** metrics
59799+
properties:
59800+
buffer:
59801+
$ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
59802+
compression:
59803+
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationCompression"
59804+
default_namespace:
59805+
description: Optional default namespace for metrics sent to Splunk HEC.
59806+
example: "custom_namespace"
59807+
type: string
59808+
endpoint_url_key:
59809+
description: Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
59810+
example: SPLUNK_HEC_ENDPOINT_URL
59811+
type: string
59812+
id:
59813+
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).
59814+
example: splunk-hec-metrics-destination
59815+
type: string
59816+
index:
59817+
description: Optional name of the Splunk index where metrics are written.
59818+
example: "metrics"
59819+
type: string
59820+
inputs:
59821+
description: A list of component IDs whose output is used as the `input` for this component.
59822+
example: ["metrics-filter-processor"]
59823+
items:
59824+
description: The ID of a component whose output is used as input for this destination.
59825+
type: string
59826+
type: array
59827+
source:
59828+
description: The Splunk source field value for metric events.
59829+
example: "observability_pipelines"
59830+
type: string
59831+
sourcetype:
59832+
description: The Splunk sourcetype to assign to metric events.
59833+
example: "custom_sourcetype"
59834+
type: string
59835+
tls:
59836+
$ref: "#/components/schemas/ObservabilityPipelineTls"
59837+
token_key:
59838+
description: Name of the environment variable or secret that holds the Splunk HEC token.
59839+
example: SPLUNK_HEC_TOKEN
59840+
type: string
59841+
type:
59842+
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationType"
59843+
required:
59844+
- id
59845+
- type
59846+
- inputs
59847+
type: object
59848+
x-pipeline-types: [metrics]
59849+
ObservabilityPipelineSplunkHecMetricsDestinationCompression:
59850+
default: none
59851+
description: Compression algorithm applied when sending metrics to Splunk HEC.
59852+
enum:
59853+
- none
59854+
- gzip
59855+
example: none
59856+
type: string
59857+
x-enum-varnames:
59858+
- NONE
59859+
- GZIP
59860+
ObservabilityPipelineSplunkHecMetricsDestinationType:
59861+
default: splunk_hec_metrics
59862+
description: The destination type. Always `splunk_hec_metrics`.
59863+
enum:
59864+
- splunk_hec_metrics
59865+
example: splunk_hec_metrics
59866+
type: string
59867+
x-enum-varnames:
59868+
- SPLUNK_HEC_METRICS
5974859869
ObservabilityPipelineSplunkHecSource:
5974959870
description: |-
5975059871
The `splunk_hec` source implements the Splunk HTTP Event Collector (HEC) API.
@@ -140770,6 +140891,73 @@ paths:
140770140891
summary: Upsert rows
140771140892
tags:
140772140893
- Reference Tables
140894+
/api/v2/reference-tables/tables/{id}/rows/list:
140895+
get:
140896+
description: List all rows in a reference table using cursor-based pagination. Pass the `page[continuation_token]` from the previous response to fetch the next page on the same consistent snapshot. Returns 400 for tables with more than 10,000,000 rows.
140897+
operationId: ListReferenceTableRows
140898+
parameters:
140899+
- description: Unique identifier of the reference table to list rows from.
140900+
example: "00000000-0000-0000-0000-000000000000"
140901+
in: path
140902+
name: id
140903+
required: true
140904+
schema:
140905+
type: string
140906+
- description: Number of rows to return per page. Defaults to 100, maximum is 1000.
140907+
example: 100
140908+
in: query
140909+
name: page[limit]
140910+
required: false
140911+
schema:
140912+
default: 100
140913+
format: int64
140914+
maximum: 1000
140915+
minimum: 1
140916+
type: integer
140917+
- description: Opaque cursor from the previous response's next link. Pass this to retrieve the next page on the same consistent snapshot.
140918+
example: "eyJzaWQiOjEyMzQ1LCJwayI6ImV4YW1wbGVfcGsifQ=="
140919+
in: query
140920+
name: page[continuation_token]
140921+
required: false
140922+
schema:
140923+
type: string
140924+
responses:
140925+
"200":
140926+
content:
140927+
application/json:
140928+
examples:
140929+
default:
140930+
value:
140931+
data:
140932+
- attributes:
140933+
values:
140934+
category: tor
140935+
intention: suspicious
140936+
ip_address: 102.130.113.9
140937+
id: 102.130.113.9
140938+
type: row
140939+
links:
140940+
first: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Blimit%5D=100"
140941+
next: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Bcontinuation_token%5D=eyJzaWQiOjY5NzA0ODkwNDE4ODA3MTAzOTgsInBrIjoiMTAyLjEzMC4xMjcuMTE3In0%3D&page%5Blimit%5D=100"
140942+
self: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Bcontinuation_token%5D=eyJzaWQiOjEyMzQ1LCJwayI6ImV4YW1wbGVfcGsifQ%3D%3D&page%5Blimit%5D=100"
140943+
schema:
140944+
$ref: "#/components/schemas/ListRowsResponse"
140945+
description: OK
140946+
"400":
140947+
$ref: "#/components/responses/BadRequestResponse"
140948+
"403":
140949+
$ref: "#/components/responses/ForbiddenResponse"
140950+
"404":
140951+
$ref: "#/components/responses/NotFoundResponse"
140952+
"429":
140953+
$ref: "#/components/responses/TooManyRequestsResponse"
140954+
security:
140955+
- apiKeyAuth: []
140956+
appKeyAuth: []
140957+
- AuthZ: []
140958+
summary: List rows
140959+
tags:
140960+
- Reference Tables
140773140961
/api/v2/reference-tables/uploads:
140774140962
post:
140775140963
description: Create a reference table upload for bulk data ingestion

docs/datadog_api_client.v2.model.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18813,6 +18813,20 @@ datadog\_api\_client.v2.model.list\_relation\_catalog\_response\_links module
1881318813
:members:
1881418814
:show-inheritance:
1881518815

18816+
datadog\_api\_client.v2.model.list\_rows\_response module
18817+
---------------------------------------------------------
18818+
18819+
.. automodule:: datadog_api_client.v2.model.list_rows_response
18820+
:members:
18821+
:show-inheritance:
18822+
18823+
datadog\_api\_client.v2.model.list\_rows\_response\_links module
18824+
----------------------------------------------------------------
18825+
18826+
.. automodule:: datadog_api_client.v2.model.list_rows_response_links
18827+
:members:
18828+
:show-inheritance:
18829+
1881618830
datadog\_api\_client.v2.model.list\_rules\_response module
1881718831
----------------------------------------------------------
1881818832

@@ -25470,6 +25484,27 @@ datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_destination\
2547025484
:members:
2547125485
:show-inheritance:
2547225486

25487+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination module
25488+
-----------------------------------------------------------------------------------------------
25489+
25490+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination
25491+
:members:
25492+
:show-inheritance:
25493+
25494+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_compression module
25495+
------------------------------------------------------------------------------------------------------------
25496+
25497+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression
25498+
:members:
25499+
:show-inheritance:
25500+
25501+
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_type module
25502+
-----------------------------------------------------------------------------------------------------
25503+
25504+
.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type
25505+
:members:
25506+
:show-inheritance:
25507+
2547325508
datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_source module
2547425509
---------------------------------------------------------------------------------
2547525510

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
List rows returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = ReferenceTablesApi(api_client)
11+
response = api_instance.list_reference_table_rows(
12+
id="id",
13+
)
14+
15+
print(response)

src/datadog_api_client/v2/api/reference_tables_api.py

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
from datadog_api_client.v2.model.batch_delete_rows_request_array import BatchDeleteRowsRequestArray
2222
from datadog_api_client.v2.model.table_row_resource_array import TableRowResourceArray
2323
from datadog_api_client.v2.model.batch_upsert_rows_request_array import BatchUpsertRowsRequestArray
24+
from datadog_api_client.v2.model.list_rows_response import ListRowsResponse
2425
from datadog_api_client.v2.model.create_upload_response import CreateUploadResponse
2526
from datadog_api_client.v2.model.create_upload_request import CreateUploadRequest
2627

@@ -197,6 +198,43 @@ def __init__(self, api_client=None):
197198
api_client=api_client,
198199
)
199200

201+
self._list_reference_table_rows_endpoint = _Endpoint(
202+
settings={
203+
"response_type": (ListRowsResponse,),
204+
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
205+
"endpoint_path": "/api/v2/reference-tables/tables/{id}/rows/list",
206+
"operation_id": "list_reference_table_rows",
207+
"http_method": "GET",
208+
"version": "v2",
209+
},
210+
params_map={
211+
"id": {
212+
"required": True,
213+
"openapi_types": (str,),
214+
"attribute": "id",
215+
"location": "path",
216+
},
217+
"page_limit": {
218+
"validation": {
219+
"inclusive_maximum": 1000,
220+
"inclusive_minimum": 1,
221+
},
222+
"openapi_types": (int,),
223+
"attribute": "page[limit]",
224+
"location": "query",
225+
},
226+
"page_continuation_token": {
227+
"openapi_types": (str,),
228+
"attribute": "page[continuation_token]",
229+
"location": "query",
230+
},
231+
},
232+
headers_map={
233+
"accept": ["application/json"],
234+
},
235+
api_client=api_client,
236+
)
237+
200238
self._list_tables_endpoint = _Endpoint(
201239
settings={
202240
"response_type": (TableResultV2Array,),
@@ -433,6 +471,36 @@ def get_table(
433471

434472
return self._get_table_endpoint.call_with_http_info(**kwargs)
435473

474+
def list_reference_table_rows(
475+
self,
476+
id: str,
477+
*,
478+
page_limit: Union[int, UnsetType] = unset,
479+
page_continuation_token: Union[str, UnsetType] = unset,
480+
) -> ListRowsResponse:
481+
"""List rows.
482+
483+
List all rows in a reference table using cursor-based pagination. Pass the ``page[continuation_token]`` from the previous response to fetch the next page on the same consistent snapshot. Returns 400 for tables with more than 10,000,000 rows.
484+
485+
:param id: Unique identifier of the reference table to list rows from.
486+
:type id: str
487+
:param page_limit: Number of rows to return per page. Defaults to 100, maximum is 1000.
488+
:type page_limit: int, optional
489+
:param page_continuation_token: Opaque cursor from the previous response's next link. Pass this to retrieve the next page on the same consistent snapshot.
490+
:type page_continuation_token: str, optional
491+
:rtype: ListRowsResponse
492+
"""
493+
kwargs: Dict[str, Any] = {}
494+
kwargs["id"] = id
495+
496+
if page_limit is not unset:
497+
kwargs["page_limit"] = page_limit
498+
499+
if page_continuation_token is not unset:
500+
kwargs["page_continuation_token"] = page_continuation_token
501+
502+
return self._list_reference_table_rows_endpoint.call_with_http_info(**kwargs)
503+
436504
def list_tables(
437505
self,
438506
*,

0 commit comments

Comments
 (0)