Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class BigQueryConfig.
Configuration for a BigQuery subscription.
Generated from protobuf message google.cloud.bigquery.analyticshub.v1.BigQueryConfig
Namespace
Google \ Cloud \ BigQuery \ AnalyticsHub \ V1Methods
__construct
Constructor.
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_schema
and use_table_schema
cannot 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.
↳ use_table_schema
bool
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.
↳ service_account_email
string
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.
getTable
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
string
setTable
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
var
string
$this
getUseTopicSchema
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.
bool
setUseTopicSchema
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.
var
bool
$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.
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.
var
bool
$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.
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.
var
bool
$this
getUseTableSchema
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.
bool
setUseTableSchema
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.
var
bool
$this
getServiceAccountEmail
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.
string
setServiceAccountEmail
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.
var
string
$this
