Cloud Pub/Sub v1 API - Class BigtableConfig.Types.ColumnFamilyMapping (3.39.0)

Reference documentation and code samples for the Cloud Pub/Sub v1 API class BigtableConfig.Types.ColumnFamilyMapping.

Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families.

If this field is set:

• The subscription messages must be formatted as JSON.
• The row key mapping is configured in the key_definition section.
• The top-level fields will be written either:
  • By default, they will be written to the data column family with the field name as the column qualifier.
  • But if the field name matches an existing column family (except for the default data column), then that field will be written to that column family, either as a scalar or its next level nested fields if it's a JSON object.
• The cell timestamp will be the message publish timestamp.

If the field is not set, the default behavior is to write:

• row key: subscription name, message ID hash, and message ID delimited by #.
• columns: message bytes written to a single column family data with an empty-string column qualifier.
• cell timestamp: the message publish timestamp.

Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog.

Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead.