Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::BigtableConfig (v1.15.0)

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#app_profile_id

def app_profile_id() -> ::String
Returns
  • (::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.

#app_profile_id=

def app_profile_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def service_account_email() -> ::String
Returns
  • (::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.

#service_account_email=

def service_account_email=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#state

def state() -> ::Google::Cloud::PubSub::V1::BigtableConfig::State
Returns

#table

def table() -> ::String
Returns
  • (::String) — Optional. The unique name of the table to write messages to.

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

#table=

def table=(value) -> ::String
Parameter
  • value (::String) — Optional. The unique name of the table to write messages to.

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

Returns
  • (::String) — Optional. The unique name of the table to write messages to.

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

#write_metadata

def write_metadata() -> ::Boolean
Returns
  • (::Boolean) — 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.

#write_metadata=

def write_metadata=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.