Reference documentation and code samples for the Cloud PubSub V1 Client class BigQueryConfig.
Configuration for a BigQuery subscription.
Generated from protobuf messagegoogle.pubsub.v1.BigQueryConfig
Namespace
Google \ Cloud \ PubSub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ table
string
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
↳ use_topic_schema
bool
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.use_topic_schemaanduse_table_schemacannot be enabled at the same time.
↳ write_metadata
bool
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.
↳ drop_unknown_fields
bool
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.
↳ state
int
Output only. An output-only field that indicates whether or not the subscription can receive messages.
↳ use_table_schema
bool
Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery.use_table_schemaanduse_topic_schemacannot be enabled at the same time.
↳ service_account_email
string
Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must haveiam.serviceAccounts.actAspermission on the service account. If not specified, the Pub/Subservice agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
getTable
Optional. The name of the table to which to write data, of the form
{projectId}.{datasetId}.{tableId}
Returns
Type
Description
string
setTable
Optional. The name of the table to which to write data, of the form
{projectId}.{datasetId}.{tableId}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getUseTopicSchema
Optional. When true, use the topic's schema as the columns to write to in
BigQuery, if it exists.use_topic_schemaanduse_table_schemacannot be
enabled at the same time.
Returns
Type
Description
bool
setUseTopicSchema
Optional. When true, use the topic's schema as the columns to write to in
BigQuery, if it exists.use_topic_schemaanduse_table_schemacannot be
enabled at the same time.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getWriteMetadata
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.
Returns
Type
Description
bool
setWriteMetadata
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getDropUnknownFields
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.
Returns
Type
Description
bool
setDropUnknownFields
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getState
Output only. An output-only field that indicates whether or not the
subscription can receive messages.
Returns
Type
Description
int
setState
Output only. An output-only field that indicates whether or not the
subscription can receive messages.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getUseTableSchema
Optional. When true, use the BigQuery table's schema as the columns to
write to in BigQuery.use_table_schemaanduse_topic_schemacannot be
enabled at the same time.
Returns
Type
Description
bool
setUseTableSchema
Optional. When true, use the BigQuery table's schema as the columns to
write to in BigQuery.use_table_schemaanduse_topic_schemacannot be
enabled at the same time.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getServiceAccountEmail
Optional. The service account to use to write to BigQuery. The subscription
creator or updater that specifies this field must haveiam.serviceAccounts.actAspermission on the service account. If not
specified, the Pub/Subservice
agent,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
Returns
Type
Description
string
setServiceAccountEmail
Optional. The service account to use to write to BigQuery. The subscription
creator or updater that specifies this field must haveiam.serviceAccounts.actAspermission on the service account. If not
specified, the Pub/Subservice
agent,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class BigQueryConfig (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.BigQueryConfig)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.BigQueryConfig)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.BigQueryConfig)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.BigQueryConfig)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.BigQueryConfig)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.BigQueryConfig)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.BigQueryConfig)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.BigQueryConfig)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.BigQueryConfig)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.BigQueryConfig)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.BigQueryConfig)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.BigQueryConfig)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.BigQueryConfig)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.BigQueryConfig)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.BigQueryConfig)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.BigQueryConfig)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.BigQueryConfig)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.BigQueryConfig)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.BigQueryConfig)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.BigQueryConfig)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.BigQueryConfig)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.BigQueryConfig)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.BigQueryConfig)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.BigQueryConfig)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.BigQueryConfig)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.BigQueryConfig) \nReference documentation and code samples for the Cloud PubSub V1 Client class BigQueryConfig.\n\nConfiguration for a BigQuery subscription.\n\nGenerated from protobuf message `google.pubsub.v1.BigQueryConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTable\n\nOptional. The name of the table to which to write data, of the form\n{projectId}.{datasetId}.{tableId}\n\n### setTable\n\nOptional. The name of the table to which to write data, of the form\n{projectId}.{datasetId}.{tableId}\n\n### getUseTopicSchema\n\nOptional. When true, use the topic's schema as the columns to write to in\nBigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be\nenabled at the same time.\n\n### setUseTopicSchema\n\nOptional. When true, use the topic's schema as the columns to write to in\nBigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be\nenabled at the same time.\n\n### getWriteMetadata\n\nOptional. When true, write the subscription name, message_id, publish_time,\nattributes, and ordering_key to additional columns in the table. The\nsubscription name, message_id, and publish_time fields are put in their own\ncolumns while all other message properties (other than data) are written to\na JSON object in the attributes column.\n\n### setWriteMetadata\n\nOptional. When true, write the subscription name, message_id, publish_time,\nattributes, and ordering_key to additional columns in the table. The\nsubscription name, message_id, and publish_time fields are put in their own\ncolumns while all other message properties (other than data) are written to\na JSON object in the attributes column.\n\n### getDropUnknownFields\n\nOptional. When true and use_topic_schema is true, any fields that are a\npart of the topic schema that are not part of the BigQuery table schema are\ndropped when writing to BigQuery. Otherwise, the schemas must be kept in\nsync and any messages with extra fields are not written and remain in the\nsubscription's backlog.\n\n### setDropUnknownFields\n\nOptional. When true and use_topic_schema is true, any fields that are a\npart of the topic schema that are not part of the BigQuery table schema are\ndropped when writing to BigQuery. Otherwise, the schemas must be kept in\nsync and any messages with extra fields are not written and remain in the\nsubscription's backlog.\n\n### getState\n\nOutput only. An output-only field that indicates whether or not the\nsubscription can receive messages.\n\n### setState\n\nOutput only. An output-only field that indicates whether or not the\nsubscription can receive messages.\n\n### getUseTableSchema\n\nOptional. When true, use the BigQuery table's schema as the columns to\nwrite to in BigQuery. `use_table_schema` and `use_topic_schema` cannot be\nenabled at the same time.\n\n### setUseTableSchema\n\nOptional. When true, use the BigQuery table's schema as the columns to\nwrite to in BigQuery. `use_table_schema` and `use_topic_schema` cannot be\nenabled at the same time.\n\n### getServiceAccountEmail\n\nOptional. The service account to use to write to BigQuery. The subscription\ncreator or updater that specifies this field must have\n`iam.serviceAccounts.actAs` permission on the service account. If not\nspecified, the Pub/Sub [service\nagent](https://cloud.google.com/iam/docs/service-agents),\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.\n\n### setServiceAccountEmail\n\nOptional. The service account to use to write to BigQuery. The subscription\ncreator or updater that specifies this field must have\n`iam.serviceAccounts.actAs` permission on the service account. If not\nspecified, the Pub/Sub [service\nagent](https://cloud.google.com/iam/docs/service-agents),\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used."]]
