Reference documentation and code samples for the Cloud PubSub V1 Client class BigQueryConfig.
Configuration for a BigQuery subscription.
Generated from protobuf message google.pubsub.v1.BigQueryConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ table |
string
The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId} |
↳ use_topic_schema |
bool
When true, use the topic's schema as the columns to write to in BigQuery, if it exists. |
↳ write_metadata |
bool
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
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. |
getTable
The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
| Returns | |
|---|---|
| Type | Description |
string | |
setTable
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
When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
| Returns | |
|---|---|
| Type | Description |
bool | |
setUseTopicSchema
When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWriteMetadata
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
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
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
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 | |