Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::BigQueryConfig.
Configuration for a BigQuery subscription.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#drop_unknown_fields
def drop_unknown_fields() -> ::Boolean
Returns
- (::Boolean) — 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.
#drop_unknown_fields=
def drop_unknown_fields=(value) -> ::Boolean
Parameter
- value (::Boolean) — 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
- (::Boolean) — 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
def state() -> ::Google::Cloud::PubSub::V1::BigQueryConfig::State
Returns
- (::Google::Cloud::PubSub::V1::BigQueryConfig::State) — Output only. An output-only field that indicates whether or not the subscription can receive messages.
#table
def table() -> ::String
Returns
- (::String) — The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
#table=
def table=(value) -> ::String
Parameter
- value (::String) — The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
Returns
- (::String) — The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
#use_topic_schema
def use_topic_schema() -> ::Boolean
Returns
- (::Boolean) — When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
#use_topic_schema=
def use_topic_schema=(value) -> ::Boolean
Parameter
- value (::Boolean) — When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
Returns
- (::Boolean) — When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
#write_metadata
def write_metadata() -> ::Boolean
Returns
- (::Boolean) — 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.
#write_metadata=
def write_metadata=(value) -> ::Boolean
Parameter
- value (::Boolean) — 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
- (::Boolean) — 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.