Cloud Pub/Sub v1 API - Class BigtableConfig (3.39.0) 

public sealed class BigtableConfig : IMessage<BigtableConfig>, IEquatable<BigtableConfig>, IDeepCloneable<BigtableConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Pub/Sub v1 API 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.

Inheritance

object > BigtableConfig

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

BigtableConfig()

public BigtableConfig()

BigtableConfig(BigtableConfig)

public BigtableConfig(BigtableConfig other)
Parameter
Name Description
other BigtableConfig

Properties

AppProfileId

public string AppProfileId { get; set; }

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.

Property Value
Type Description
string

ColumnFamilyMapping

public BigtableConfig.Types.ColumnFamilyMapping ColumnFamilyMapping { get; set; }

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.

Property Value
Type Description
BigtableConfigTypesColumnFamilyMapping

MessageMappingCase

public BigtableConfig.MessageMappingOneofCase MessageMappingCase { get; }
Property Value
Type Description
BigtableConfigMessageMappingOneofCase

ServiceAccountEmail

public string ServiceAccountEmail { get; set; }

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.

Property Value
Type Description
string

State

public BigtableConfig.Types.State State { get; set; }

Output only. An output-only field that indicates whether or not the subscription can receive messages.

Property Value
Type Description
BigtableConfigTypesState

Table

public string Table { get; set; }

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

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

Property Value
Type Description
string

WriteMetadata

public bool WriteMetadata { get; set; }

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.

Property Value
Type Description
bool