CreateDataTap parity mapping
Supported in:
This guide details the request and response mapping specifications and property parity analysis for migrating from the legacy Backstory Data Tap API (CreateDataTap) to the modern Chronicle API (CreateDataTap).
Protocol and mapping overview
| Feature | Legacy API (CreateDataTap) |
Modern Chronicle API (CreateDataTap) |
|---|---|---|
| HTTP Method | POST |
POST |
| Permissions | Partner token or legacy API keys | chronicle.googleapis.com/dataTaps.create |
Request payload field-by-field parity
The modern Chronicle API CreateDataTapRequest requires parent scoping and maps legacy features to equivalent fields, with one value renaming shift.
Legacy Field (CreateDataTapRequest / DataTap) |
Modern Field (CreateDataTapRequest / DataTap) |
Field type | Parity & Migration Notes |
|---|---|---|---|
| — | parent (in HTTP path) |
string |
Google Cloud Scoping Hierarchy: Scopes the creation target using the standard resource path in the HTTP URL path. Pattern: projects/{project}/locations/{location}/instances/{instance_uuid}. |
data_tap.display_name |
data_tap.display_name |
string |
Parity Mapped: Display name of the data tap. Rename to displayName in JSON payloads. |
data_tap.cloud_pubsub_sink |
data_tap.cloud_pubsub_sink |
Message |
Parity Mapped: Sink options configuration. Rename to cloudPubsubSink in JSON payloads. Sub-field topic maps directly. |
data_tap.filter |
data_tap.filter |
enum |
Parity Mapped: Target filter type (for example, ALL_UDM_EVENTS, ALERT_UDM_EVENTS, LABELED_UDM_EVENTS). |
data_tap.serialization_format |
data_tap.serialization_format |
enum |
Value Translation: Rename to serializationFormat in JSON. Mapped as follows:• MARSHALLED_PROTO → MARSHALLED_PROTO• JSON (Legacy) → JSON_OBJECT (Modern). |
data_tap.customer_id |
— | — | Removed: Scopes are derived implicitly from request location path. |
data_tap.name / tap_id |
— | — | Removed: Identifiers are output-only during creation. |
Response payload field-by-field parity
Both responses return the created DataTap message representation.
Legacy Field (DataTap message) |
Modern Field (DataTap message) |
Field type | Parity & Migration Notes |
|---|---|---|---|
name |
name |
string |
Parity Mapped: Contains the standard canonical resource path: projects/{project}/locations/{location}/instances/{instances}/dataTaps/{id}. |
display_name |
display_name |
string |
Rename to displayName in JSON responses. |
cloud_pubsub_sink |
cloud_pubsub_sink |
Message |
Rename to cloudPubsubSink in JSON responses. Sub-field topic maps directly. |
filter |
filter |
enum |
Direct enum mappings. |
serialization_format |
serialization_format |
enum |
Mapped with value translation: JSON (Legacy) → JSON_OBJECT (Modern). Rename to serializationFormat in JSON responses. |
customer_id |
— | — | Removed: Embedded within parent path of name. |
tap_id |
— | — | Removed: Equivalent to the final resource ID segment of the name path. |
Key differences
- Serialization Format Enums:
- The value to request JSON formatted events outputs changed from
JSON(Legacy) toJSON_OBJECT(Modern).
- The value to request JSON formatted events outputs changed from
- Google Cloud Project Scoping Integration:
- Scoped natively under parent project instance folder bindings.
- Implicit customer namespaces:
- Low-level
customer_idproperties are retired from the request interfaces.
- Low-level