Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::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.
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.
#column_family_mapping
def column_family_mapping() -> ::Google::Cloud::PubSub::V1::BigtableConfig::ColumnFamilyMapping
Returns
- (::Google::Cloud::PubSub::V1::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.
#column_family_mapping=
def column_family_mapping=(value) -> ::Google::Cloud::PubSub::V1::BigtableConfig::ColumnFamilyMapping
Parameter
- value (::Google::Cloud::PubSub::V1::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.
Returns
- (::Google::Cloud::PubSub::V1::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.
#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.actAspermission 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.actAspermission 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.actAspermission 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
- (::Google::Cloud::PubSub::V1::BigtableConfig::State) — Output only. An output-only field that indicates whether or not the subscription can receive messages.
#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.