BigQueryConfig

import type { BigQueryConfig } from "https://googleapis.deno.dev/v1/pubsub:v1.ts";

Configuration for a BigQuery subscription.

interface BigQueryConfig {

dropUnknownFields?: boolean;

serviceAccountEmail?: string;

readonly state?:

| "STATE_UNSPECIFIED"

| "ACTIVE"

| "PERMISSION_DENIED"

| "NOT_FOUND"

| "SCHEMA_MISMATCH"

| "IN_TRANSIT_LOCATION_RESTRICTION";

table?: string;

useTableSchema?: boolean;

useTopicSchema?: boolean;

writeMetadata?: boolean;

}

§Properties

dropUnknownFields?: boolean

[src]

Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.

serviceAccountEmail?: string

[src]

Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

[src]

Output only. An output-only field that indicates whether or not the subscription can receive messages.

table?: string

[src]

Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}

useTableSchema?: boolean

[src]

Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery. use_table_schema and use_topic_schema cannot be enabled at the same time.

useTopicSchema?: boolean

[src]

Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. use_topic_schema and use_table_schema cannot be enabled at the same time.

writeMetadata?: boolean

[src]

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.