Add Reference Tables API spec

docs/datadog_api_client.v2.api.rst

@@ -389,6 +389,13 @@ datadog\_api\_client.v2.api.processes\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.reference\_tables\_api module
+---------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.reference_tables_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.restriction\_policies\_api module
 -------------------------------------------------------------
 

examples/v1/logs-pipelines/CreateLogsPipeline.py

@@ -18,8 +18,8 @@
     processors=[
         LogsGrokParser(
             grok=LogsGrokParserRules(
-                match_rules="rule_name_1 foo\nrule_name_2 bar\n",
-                support_rules="rule_name_1 foo\nrule_name_2 bar\n",
+                match_rules="rule_name_1 foo\nrule_name_2 bar",
+                support_rules="rule_name_1 foo\nrule_name_2 bar",
             ),
             is_enabled=False,
             samples=[],

examples/v1/logs-pipelines/UpdateLogsPipeline.py

@@ -18,8 +18,8 @@
     processors=[
         LogsGrokParser(
             grok=LogsGrokParserRules(
-                match_rules="rule_name_1 foo\nrule_name_2 bar\n",
-                support_rules="rule_name_1 foo\nrule_name_2 bar\n",
+                match_rules="rule_name_1 foo\nrule_name_2 bar",
+                support_rules="rule_name_1 foo\nrule_name_2 bar",
             ),
             is_enabled=False,
             samples=[],

examples/v2/reference-tables/CreateReferenceTable.py

@@ -0,0 +1,73 @@
+"""
+Create reference table returns "Created" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
+from datadog_api_client.v2.model.create_table_request import CreateTableRequest
+from datadog_api_client.v2.model.create_table_request_data import CreateTableRequestData
+from datadog_api_client.v2.model.create_table_request_data_attributes import CreateTableRequestDataAttributes
+from datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_cloud_storage import (
+    CreateTableRequestDataAttributesFileMetadataCloudStorage,
+)
+from datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_one_of_access_details import (
+    CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails,
+)
+from datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail import (
+    CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail,
+)
+from datadog_api_client.v2.model.create_table_request_data_attributes_schema import (
+    CreateTableRequestDataAttributesSchema,
+)
+from datadog_api_client.v2.model.create_table_request_data_attributes_schema_fields_items import (
+    CreateTableRequestDataAttributesSchemaFieldsItems,
+)
+from datadog_api_client.v2.model.create_table_request_data_type import CreateTableRequestDataType
+from datadog_api_client.v2.model.reference_table_create_source_type import ReferenceTableCreateSourceType
+from datadog_api_client.v2.model.reference_table_schema_field_type import ReferenceTableSchemaFieldType
+
+body = CreateTableRequest(
+    data=CreateTableRequestData(
+        attributes=CreateTableRequestDataAttributes(
+            description="this is a cloud table generated via a cloud bucket sync",
+            file_metadata=CreateTableRequestDataAttributesFileMetadataCloudStorage(
+                access_details=CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails(
+                    aws_detail=CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail(
+                        aws_account_id="test-account-id",
+                        aws_bucket_name="test-bucket",
+                        file_path="test_rt.csv",
+                    ),
+                ),
+                sync_enabled=True,
+            ),
+            schema=CreateTableRequestDataAttributesSchema(
+                fields=[
+                    CreateTableRequestDataAttributesSchemaFieldsItems(
+                        name="name",
+                        type=ReferenceTableSchemaFieldType.STRING,
+                    ),
+                    CreateTableRequestDataAttributesSchemaFieldsItems(
+                        name="account_id",
+                        type=ReferenceTableSchemaFieldType.STRING,
+                    ),
+                ],
+                primary_keys=[
+                    "account_id",
+                ],
+            ),
+            source=ReferenceTableCreateSourceType.S3,
+            table_name="test_reference_table",
+            tags=[
+                "test_tag",
+            ],
+        ),
+        type=CreateTableRequestDataType.REFERENCE_TABLE,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ReferenceTablesApi(api_client)
+    response = api_instance.create_reference_table(body=body)
+
+    print(response)

examples/v2/reference-tables/CreateReferenceTableUpload.py

@@ -0,0 +1,33 @@
+"""
+Create reference table upload returns "Created" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
+from datadog_api_client.v2.model.create_upload_request import CreateUploadRequest
+from datadog_api_client.v2.model.create_upload_request_data import CreateUploadRequestData
+from datadog_api_client.v2.model.create_upload_request_data_attributes import CreateUploadRequestDataAttributes
+from datadog_api_client.v2.model.create_upload_request_data_type import CreateUploadRequestDataType
+
+body = CreateUploadRequest(
+    data=CreateUploadRequestData(
+        attributes=CreateUploadRequestDataAttributes(
+            headers=[
+                "id",
+                "name",
+                "value",
+            ],
+            table_name="test_upload_table_Example-Reference-Table",
+            part_count=1,
+            part_size=1024,
+        ),
+        type=CreateUploadRequestDataType.UPLOAD,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ReferenceTablesApi(api_client)
+    response = api_instance.create_reference_table_upload(body=body)
+
+    print(response)

examples/v2/reference-tables/CreateReferenceTable_3196130987.py

@@ -0,0 +1,64 @@
+"""
+Create reference table with upload returns "Created" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
+from datadog_api_client.v2.model.create_table_request import CreateTableRequest
+from datadog_api_client.v2.model.create_table_request_data import CreateTableRequestData
+from datadog_api_client.v2.model.create_table_request_data_attributes import CreateTableRequestDataAttributes
+from datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_local_file import (
+    CreateTableRequestDataAttributesFileMetadataLocalFile,
+)
+from datadog_api_client.v2.model.create_table_request_data_attributes_schema import (
+    CreateTableRequestDataAttributesSchema,
+)
+from datadog_api_client.v2.model.create_table_request_data_attributes_schema_fields_items import (
+    CreateTableRequestDataAttributesSchemaFieldsItems,
+)
+from datadog_api_client.v2.model.create_table_request_data_type import CreateTableRequestDataType
+from datadog_api_client.v2.model.reference_table_create_source_type import ReferenceTableCreateSourceType
+from datadog_api_client.v2.model.reference_table_schema_field_type import ReferenceTableSchemaFieldType
+
+body = CreateTableRequest(
+    data=CreateTableRequestData(
+        attributes=CreateTableRequestDataAttributes(
+            description="Test reference table created via BDD test Example-Reference-Table",
+            source=ReferenceTableCreateSourceType.LOCAL_FILE,
+            file_metadata=CreateTableRequestDataAttributesFileMetadataLocalFile(
+                upload_id="test-upload-id-Example-Reference-Table",
+            ),
+            schema=CreateTableRequestDataAttributesSchema(
+                fields=[
+                    CreateTableRequestDataAttributesSchemaFieldsItems(
+                        name="id",
+                        type=ReferenceTableSchemaFieldType.STRING,
+                    ),
+                    CreateTableRequestDataAttributesSchemaFieldsItems(
+                        name="name",
+                        type=ReferenceTableSchemaFieldType.STRING,
+                    ),
+                    CreateTableRequestDataAttributesSchemaFieldsItems(
+                        name="value",
+                        type=ReferenceTableSchemaFieldType.INT32,
+                    ),
+                ],
+                primary_keys=[
+                    "id",
+                ],
+            ),
+            table_name="test_reference_table_Example-Reference-Table",
+            tags=[
+                "test_tag",
+            ],
+        ),
+        type=CreateTableRequestDataType.REFERENCE_TABLE,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ReferenceTablesApi(api_client)
+    response = api_instance.create_reference_table(body=body)
+
+    print(response)

examples/v2/reference-tables/DeleteTable.py

@@ -0,0 +1,13 @@
+"""
+Delete table returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ReferenceTablesApi(api_client)
+    api_instance.delete_table(
+        id="id",
+    )

examples/v2/reference-tables/GetRowsByID.py

@@ -0,0 +1,16 @@
+"""
+Get rows by id returns "Some or all requested rows were found." response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ReferenceTablesApi(api_client)
+    response = api_instance.get_rows_by_id(
+        row_id=[],
+        id="id",
+    )
+
+    print(response)

examples/v2/reference-tables/GetTable.py

@@ -0,0 +1,15 @@
+"""
+Get table returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ReferenceTablesApi(api_client)
+    response = api_instance.get_table(
+        id="id",
+    )
+
+    print(response)

examples/v2/reference-tables/ListTables.py

@@ -0,0 +1,13 @@
+"""
+List tables returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ReferenceTablesApi(api_client)
+    response = api_instance.list_tables()
+
+    print(response)

examples/v2/reference-tables/UpdateReferenceTable.py

@@ -0,0 +1,68 @@
+"""
+Update reference table returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
+from datadog_api_client.v2.model.patch_table_request import PatchTableRequest
+from datadog_api_client.v2.model.patch_table_request_data import PatchTableRequestData
+from datadog_api_client.v2.model.patch_table_request_data_attributes import PatchTableRequestDataAttributes
+from datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata_cloud_storage import (
+    PatchTableRequestDataAttributesFileMetadataCloudStorage,
+)
+from datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata_one_of_access_details import (
+    PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails,
+)
+from datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail import (
+    PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail,
+)
+from datadog_api_client.v2.model.patch_table_request_data_attributes_schema import PatchTableRequestDataAttributesSchema
+from datadog_api_client.v2.model.patch_table_request_data_attributes_schema_fields_items import (
+    PatchTableRequestDataAttributesSchemaFieldsItems,
+)
+from datadog_api_client.v2.model.patch_table_request_data_type import PatchTableRequestDataType
+from datadog_api_client.v2.model.reference_table_schema_field_type import ReferenceTableSchemaFieldType
+
+body = PatchTableRequest(
+    data=PatchTableRequestData(
+        attributes=PatchTableRequestDataAttributes(
+            description="this is a cloud table generated via a cloud bucket sync",
+            file_metadata=PatchTableRequestDataAttributesFileMetadataCloudStorage(
+                access_details=PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails(
+                    aws_detail=PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail(
+                        aws_account_id="test-account-id",
+                        aws_bucket_name="test-bucket",
+                        file_path="test_rt.csv",
+                    ),
+                ),
+                sync_enabled=True,
+            ),
+            schema=PatchTableRequestDataAttributesSchema(
+                fields=[
+                    PatchTableRequestDataAttributesSchemaFieldsItems(
+                        name="id",
+                        type=ReferenceTableSchemaFieldType.INT32,
+                    ),
+                    PatchTableRequestDataAttributesSchemaFieldsItems(
+                        name="name",
+                        type=ReferenceTableSchemaFieldType.STRING,
+                    ),
+                ],
+                primary_keys=[
+                    "id",
+                ],
+            ),
+            sync_enabled=False,
+            tags=[
+                "test_tag",
+            ],
+        ),
+        id="00000000-0000-0000-0000-000000000000",
+        type=PatchTableRequestDataType.REFERENCE_TABLE,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ReferenceTablesApi(api_client)
+    api_instance.update_reference_table(id="id", body=body)