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 \ V1Methods
__construct
Constructor.
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
, 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>
.
string
setTable
Optional. The unique name of the table to write messages to.
Values are of the form projects/<project>/instances/<instance>/tables/<table>
.
var
string
$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.
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.
var
string
$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.
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.
var
string
$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.
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.
var
bool
$this
getState
Output only. An output-only field that indicates whether or not the subscription can receive messages.
setState
Output only. An output-only field that indicates whether or not the subscription can receive messages.
$this
