Reference documentation and code samples for the Cloud PubSub V1 Client class BigtableConfig.
Configuration for a Bigtable subscription, which will write a Pub/Sub message to a Bigtable row. See the ColumnFamilyMapping documentation below for details on how the row keys and columns will be written.
Generated from protobuf message google.pubsub.v1.BigtableConfig
Namespace
Google \ Cloud \ PubSub \ V1Methods
__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 |
↳ 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 |
↳ 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. |
↳ column_family_mapping |
BigtableConfig\ColumnFamilyMapping
Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set. |
↳ 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,
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,
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 |
|
getColumnFamilyMapping
Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.
| Returns | |
|---|---|
| Type | Description |
BigtableConfig\ColumnFamilyMapping|null |
|
hasColumnFamilyMapping
setColumnFamilyMapping
Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.
| Parameter | |
|---|---|
| Name | Description |
var |
BigtableConfig\ColumnFamilyMapping
|
| 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. |
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. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMessageMapping
| Returns | |
|---|---|
| Type | Description |
string |
|