Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::BigQueryConfig (v1.4.0)

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) — 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.

#drop_unknown_fields=

def drop_unknown_fields=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.

#service_account_email

def service_account_email() -> ::String
Returns
  • (::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.

#service_account_email=

def service_account_email=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#state

def state() -> ::Google::Cloud::PubSub::V1::BigQueryConfig::State
Returns

#table

def table() -> ::String
Returns
  • (::String) — Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}

#table=

def table=(value) -> ::String
Parameter
  • value (::String) — Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
Returns
  • (::String) — Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}

#use_table_schema

def use_table_schema() -> ::Boolean
Returns
  • (::Boolean) — 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.

#use_table_schema=

def use_table_schema=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#use_topic_schema

def use_topic_schema() -> ::Boolean
Returns
  • (::Boolean) — 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.

#use_topic_schema=

def use_topic_schema=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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

def write_metadata() -> ::Boolean
Returns
  • (::Boolean) — 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.

#write_metadata=

def write_metadata=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.