Cloud Pub/Sub v1 API - Class BigQueryConfig (3.19.0)

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

Reference documentation and code samples for the Cloud Pub/Sub v1 API class BigQueryConfig.

Configuration for a BigQuery subscription.

Inheritance

object > BigQueryConfig

Implements

IMessage BigQueryConfig, IEquatable BigQueryConfig, IDeepCloneable BigQueryConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

BigQueryConfig()

public BigQueryConfig()

BigQueryConfig(BigQueryConfig)

public BigQueryConfig(BigQueryConfig other)

Parameter
Name	Description
`other`	`BigQueryConfig`

Properties

DropUnknownFields

public bool DropUnknownFields { get; set; }

Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.

Property Value
Type	Description
`bool`

ServiceAccountEmail

public string ServiceAccountEmail { get; set; }

Optional. The service account to use to write to BigQuery. 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 BigQueryConfig.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
`BigQueryConfigTypesState`

Table

public string Table { get; set; }

Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}

Property Value
Type	Description
`string`

UseTableSchema

public bool UseTableSchema { get; set; }

Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery. use_table_schema and use_topic_schema cannot be enabled at the same time.

Property Value
Type	Description
`bool`

UseTopicSchema

public bool UseTopicSchema { get; set; }

Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. use_topic_schema and use_table_schema cannot be enabled at the same time.

Property Value
Type	Description
`bool`

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. 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`