Cloud PubSub V1 Client - Class BigQueryConfig (2.5.0)

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

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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.
↳ state int

Output only. An output-only field that indicates whether or not the subscription can receive messages.
↳ 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}

Returns
Type Description
string

setTable

Optional. 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

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
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
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.

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

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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this