Skip to content

Commit 8e0e1f7

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Flatten file_metadata response schema to avoid OneOf unmarshaling issues (#3255)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 38a04fd commit 8e0e1f7

File tree

7 files changed

+278
-687
lines changed

7 files changed

+278
-687
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 79 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -13142,30 +13142,6 @@ components:
1314213142
CreateTableRequest:
1314313143
description: Request body for creating a new reference table from a local file
1314413144
or cloud storage.
13145-
example:
13146-
data:
13147-
attributes:
13148-
description: this is a cloud table generated via a cloud bucket sync
13149-
file_metadata:
13150-
access_details:
13151-
aws_detail:
13152-
aws_account_id: test-account-id
13153-
aws_bucket_name: test-bucket
13154-
file_path: test_rt.csv
13155-
sync_enabled: true
13156-
schema:
13157-
fields:
13158-
- name: name
13159-
type: STRING
13160-
- name: account_id
13161-
type: STRING
13162-
primary_keys:
13163-
- account_id
13164-
source: S3
13165-
table_name: test_reference_table
13166-
tags:
13167-
- test_tag
13168-
type: reference_table
1316913145
properties:
1317013146
data:
1317113147
$ref: '#/components/schemas/CreateTableRequestData'
@@ -13387,6 +13363,17 @@ components:
1338713363
CreateUploadRequest:
1338813364
description: Request to create an upload for a file to be ingested into a reference
1338913365
table.
13366+
example:
13367+
data:
13368+
attributes:
13369+
headers:
13370+
- product_id
13371+
- product_name
13372+
- price
13373+
part_count: 3
13374+
part_size: 10000000
13375+
table_name: my_products_table
13376+
type: upload
1339013377
properties:
1339113378
data:
1339213379
$ref: '#/components/schemas/CreateUploadRequestData'
@@ -51089,32 +51076,35 @@ components:
5108951076
type: string
5109051077
type: object
5109151078
TableResultV2DataAttributesFileMetadata:
51092-
description: Metadata specifying where and how to access the reference table's
51093-
data file.
51094-
oneOf:
51095-
- $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataCloudStorage'
51096-
- $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataLocalFile'
51097-
TableResultV2DataAttributesFileMetadataCloudStorage:
5109851079
additionalProperties: false
51099-
description: File metadata for reference tables created by cloud storage.
51080+
description: "Metadata specifying where and how to access the reference table's
51081+
data file.\n\nFor cloud storage tables (S3/GCS/Azure):\n - sync_enabled and
51082+
access_details will always be present\n - error fields (error_message, error_row_count,
51083+
error_type) are present only when errors occur\n\nFor local file tables:\n
51084+
\ - error fields (error_message, error_row_count) are present only when errors
51085+
occur\n - sync_enabled, access_details are never present"
5110051086
properties:
5110151087
access_details:
5110251088
$ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetails'
51089+
description: Cloud storage access configuration. Only present for cloud
51090+
storage sources (S3, GCS, Azure).
5110351091
error_message:
51104-
description: The error message returned from the sync.
51092+
description: The error message returned from the last operation (sync for
51093+
cloud storage, upload for local file).
5110551094
type: string
5110651095
error_row_count:
51107-
description: The number of rows that failed to sync.
51096+
description: The number of rows that failed to process.
5110851097
format: int64
5110951098
type: integer
5111051099
error_type:
5111151100
$ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataCloudStorageErrorType'
51101+
description: The type of error that occurred during file processing. Only
51102+
applicable for cloud storage sources.
5111251103
sync_enabled:
51113-
description: Whether this table is synced automatically.
51104+
description: Whether this table is synced automatically from cloud storage.
51105+
Only applicable for cloud storage sources.
5111451106
type: boolean
51115-
required:
51116-
- access_details
51117-
title: CloudFileMetadataV2
51107+
title: FileMetadataV2
5111851108
type: object
5111951109
TableResultV2DataAttributesFileMetadataCloudStorageErrorType:
5112051110
description: The type of error that occurred during file processing. This field
@@ -51141,21 +51131,6 @@ components:
5114151131
- STATE_ERROR
5114251132
- OPERATION_ERROR
5114351133
- SYSTEM_ERROR
51144-
TableResultV2DataAttributesFileMetadataLocalFile:
51145-
additionalProperties: false
51146-
description: File metadata for reference tables created by upload. Note that
51147-
upload_id is only returned in the immediate create/replace response and is
51148-
not available in subsequent GET requests.
51149-
properties:
51150-
error_message:
51151-
description: The error message returned from the creation/update.
51152-
type: string
51153-
error_row_count:
51154-
description: The number of rows that failed to create/update.
51155-
format: int64
51156-
type: integer
51157-
title: LocalFileMetadataV2
51158-
type: object
5115951134
TableResultV2DataAttributesFileMetadataOneOfAccessDetails:
5116051135
description: Cloud storage access configuration for the reference table data
5116151136
file.
@@ -73511,6 +73486,58 @@ paths:
7351173486
requestBody:
7351273487
content:
7351373488
application/json:
73489+
examples:
73490+
cloud_storage:
73491+
summary: Create table from cloud storage (S3)
73492+
value:
73493+
data:
73494+
attributes:
73495+
description: Customer reference data synced from S3
73496+
file_metadata:
73497+
access_details:
73498+
aws_detail:
73499+
aws_account_id: '924305315327'
73500+
aws_bucket_name: my-data-bucket
73501+
file_path: customers.csv
73502+
sync_enabled: true
73503+
schema:
73504+
fields:
73505+
- name: customer_id
73506+
type: STRING
73507+
- name: customer_name
73508+
type: STRING
73509+
- name: email
73510+
type: STRING
73511+
primary_keys:
73512+
- customer_id
73513+
source: S3
73514+
table_name: customer_reference_data
73515+
tags:
73516+
- team:data-platform
73517+
type: reference_table
73518+
local_file:
73519+
summary: Create table from local file upload
73520+
value:
73521+
data:
73522+
attributes:
73523+
description: Product catalog uploaded via local file
73524+
file_metadata:
73525+
upload_id: 00000000-0000-0000-0000-000000000000
73526+
schema:
73527+
fields:
73528+
- name: product_id
73529+
type: STRING
73530+
- name: product_name
73531+
type: STRING
73532+
- name: price
73533+
type: DOUBLE
73534+
primary_keys:
73535+
- product_id
73536+
source: LOCAL_FILE
73537+
table_name: product_catalog
73538+
tags:
73539+
- team:ecommerce
73540+
type: reference_table
7351473541
schema:
7351573542
$ref: '#/components/schemas/CreateTableRequest'
7351673543
required: true

‎examples/v2/reference-tables/CreateReferenceTable.java‎

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
import com.datadog.api.client.v2.model.CreateTableRequestDataAttributesFileMetadataCloudStorage;
1111
import com.datadog.api.client.v2.model.CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails;
1212
import com.datadog.api.client.v2.model.CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail;
13+
import com.datadog.api.client.v2.model.CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail;
14+
import com.datadog.api.client.v2.model.CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail;
1315
import com.datadog.api.client.v2.model.CreateTableRequestDataAttributesSchema;
1416
import com.datadog.api.client.v2.model.CreateTableRequestDataAttributesSchemaFieldsItems;
1517
import com.datadog.api.client.v2.model.CreateTableRequestDataType;
@@ -30,32 +32,45 @@ public static void main(String[] args) {
3032
new CreateTableRequestData()
3133
.attributes(
3234
new CreateTableRequestDataAttributes()
33-
.description("this is a cloud table generated via a cloud bucket sync")
3435
.fileMetadata(
3536
new CreateTableRequestDataAttributesFileMetadata(
3637
new CreateTableRequestDataAttributesFileMetadataCloudStorage()
3738
.accessDetails(
3839
new CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails()
3940
.awsDetail(
4041
new CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail()
41-
.awsAccountId("test-account-id")
42-
.awsBucketName("test-bucket")
43-
.filePath("test_rt.csv")))
44-
.syncEnabled(true)))
42+
.awsAccountId("123456789000")
43+
.awsBucketName("example-data-bucket")
44+
.filePath("reference-tables/users.csv"))
45+
.azureDetail(
46+
new CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail()
47+
.azureClientId(
48+
"aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb")
49+
.azureContainerName("reference-data")
50+
.azureStorageAccountName(
51+
"examplestorageaccount")
52+
.azureTenantId(
53+
"cccccccc-4444-5555-6666-dddddddddddd")
54+
.filePath("tables/users.csv"))
55+
.gcpDetail(
56+
new CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail()
57+
.filePath("data/reference_tables/users.csv")
58+
.gcpBucketName("example-data-bucket")
59+
.gcpProjectId("example-gcp-project-12345")
60+
.gcpServiceAccountEmail(
61+
"example-service@example-gcp-project-12345.iam.gserviceaccount.com")))
62+
.syncEnabled(false)))
4563
.schema(
4664
new CreateTableRequestDataAttributesSchema()
4765
.fields(
48-
Arrays.asList(
66+
Collections.singletonList(
4967
new CreateTableRequestDataAttributesSchemaFieldsItems()
50-
.name("name")
51-
.type(ReferenceTableSchemaFieldType.STRING),
52-
new CreateTableRequestDataAttributesSchemaFieldsItems()
53-
.name("account_id")
68+
.name("field_1")
5469
.type(ReferenceTableSchemaFieldType.STRING)))
55-
.primaryKeys(Collections.singletonList("account_id")))
56-
.source(ReferenceTableCreateSourceType.S3)
57-
.tableName("test_reference_table")
58-
.tags(Collections.singletonList("test_tag")))
70+
.primaryKeys(Collections.singletonList("field_1")))
71+
.source(ReferenceTableCreateSourceType.LOCAL_FILE)
72+
.tableName("table_1")
73+
.tags(Arrays.asList("tag_1", "tag_2")))
5974
.type(CreateTableRequestDataType.REFERENCE_TABLE));
6075

6176
try {

‎src/main/java/com/datadog/api/client/v2/model/TableResultV2DataAttributes.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,13 @@ public TableResultV2DataAttributes fileMetadata(
121121
/**
122122
* Metadata specifying where and how to access the reference table's data file.
123123
*
124+
* <p>For cloud storage tables (S3/GCS/Azure): - sync_enabled and access_details will always be
125+
* present - error fields (error_message, error_row_count, error_type) are present only when
126+
* errors occur
127+
*
128+
* <p>For local file tables: - error fields (error_message, error_row_count) are present only when
129+
* errors occur - sync_enabled, access_details are never present
130+
*
124131
* @return fileMetadata
125132
*/
126133
@jakarta.annotation.Nullable

0 commit comments

Comments
 (0)