GetDataTap 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 (GetDataTap) to the modern Chronicle API (GetDataTap).

Protocol and mapping overview

Feature Legacy API (GetDataTap) Modern Chronicle API (GetDataTap)
HTTP Method GET GET
Permissions Partner token or legacy API keys chronicle.googleapis.com/dataTaps.get

Request payload field-by-field parity

The modern Chronicle API GetDataTapRequest targets resources using Google Cloud resource name paths.

Legacy Field (GetDataTapRequest) Modern Field (GetDataTapRequest) Field type Parity & Migration Notes
name name (in HTTP path) string Google Cloud Scoping Context: The legacy request used path format dataTaps/<tap_id>. The modern API routes this using the standard Google Cloud resource tree structure: projects/{project}/locations/{region}/instances/{instance}/dataTaps/{id}.

Response payload field-by-field parity

Both responses return the retrieved DataTap representation.

Legacy Field (DataTap response) Modern Field (DataTap response) 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

  • Google Cloud Project Scoping Integration:
    • Scoped natively under parent project instance folder bindings.
  • Resource Path Renaming:
    • Legacy path formats dataTaps/<id> are migrated to standard Google Cloud path parameters projects/*/locations/*/instances/*/dataTaps/<id>.
  • Serialization Format Enums:
    • The value to request JSON formatted events outputs changed from JSON (Legacy) to JSON_OBJECT (Modern).