# Cloud PubSub V1 Client - Class BigQueryConfig (2.19.3)

2.19.3 (latest) 2.19.2 2.18.0 2.17.0 2.16.2 2.15.1 2.14.0 2.13.2 2.12.0 2.11.3 2.10.1 2.9.1 2.8.2 2.7.0 2.6.0 2.5.2 2.4.0 2.3.0 2.2.1 2.1.2 1.50.0 1.49.0 1.48.0 1.47.0 1.46.5 1.45.2 1.44.0 1.43.2 1.42.1 1.41.3 1.40.1 1.39.3 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](https://cloud.google.com/iam/docs/service-agents), 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` | Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.BigQueryConfig.State). |

### setState

Output only. An output-only field that indicates whether or not the
subscription can receive messages.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.BigQueryConfig.State). |

| **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](https://cloud.google.com/iam/docs/service-agents),
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](https://cloud.google.com/iam/docs/service-agents),
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |