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.
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}
Generated from protobuf field string table = 1;
string
setTable
The name of the table to which to write data, of the form {projectId}:{datasetId}.{tableId}
Generated from protobuf field string table = 1;
var
string
$this
getUseTopicSchema
When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
Generated from protobuf field bool use_topic_schema = 2;
bool
setUseTopicSchema
When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
Generated from protobuf field bool use_topic_schema = 2;
var
bool
$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.
Generated from protobuf field bool write_metadata = 3;
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.
Generated from protobuf field bool write_metadata = 3;
var
bool
$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.
Generated from protobuf field bool drop_unknown_fields = 4;
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.
Generated from protobuf field bool drop_unknown_fields = 4;
var
bool
$this
getState
Output only. An output-only field that indicates whether or not the subscription can receive messages.
Generated from protobuf field .google.pubsub.v1.BigQueryConfig.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
setState
Output only. An output-only field that indicates whether or not the subscription can receive messages.
Generated from protobuf field .google.pubsub.v1.BigQueryConfig.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
int
$this
