# Cloud PubSub V1 Client - Class BigtableConfig (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 BigtableConfig.

Configuration for a Bigtable subscription. The Pub/Sub message will be
written to a Bigtable row as follows:

- row key: subscription name and message ID delimited by #.

- columns: message bytes written to a single column family "data" with an
  empty-string column qualifier.

- cell timestamp: the message publish timestamp.

Generated from protobuf message `google.pubsub.v1.BigtableConfig`

## Namespace

Google \\ Cloud \\ PubSub \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ table` | `string` Optional. The unique name of the table to write messages to. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`. |
| `↳ app_profile_id` | `string` Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing. |
| `↳ service_account_email` | `string` Optional. The service account to use to write to Bigtable. 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. |
| `↳ write_metadata` | `bool` Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table under the pubsub_metadata column family. 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. |
| `↳ state` | `int` Output only. An output-only field that indicates whether or not the subscription can receive messages. |

### getTable

Optional. The unique name of the table to write messages to.

Values are of the form
`projects/<project>/instances/<instance>/tables/<table>`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setTable

Optional. The unique name of the table to write messages to.

Values are of the form
`projects/<project>/instances/<instance>/tables/<table>`.

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

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

### getAppProfileId

Optional. The app profile to use for the Bigtable writes. If not specified,
the "default" application profile will be used. The app profile must use
single-cluster routing.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setAppProfileId

Optional. The app profile to use for the Bigtable writes. If not specified,
the "default" application profile will be used. The app profile must use
single-cluster routing.

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

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

### getServiceAccountEmail

Optional. The service account to use to write to Bigtable. 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 Bigtable. 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` |   |

### getWriteMetadata

Optional. When true, write the subscription name, message_id, publish_time,
attributes, and ordering_key to additional columns in the table under the
pubsub_metadata column family. 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 under the
pubsub_metadata column family. 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` |   |

### 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.BigtableConfig.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.BigtableConfig.State). |

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