Interface BigQueryConfigOrBuilder (1.157.0)

1.157.0 (latest) 1.153.0 1.152.0 1.151.0 1.150.1 1.149.0 1.148.0 1.147.0 1.145.0 1.143.1 1.142.0 1.141.5 1.140.2 1.139.4 1.138.0 1.137.1 1.136.1 1.135.0 1.134.2 1.133.1 1.132.2 1.131.0 1.130.0 1.129.6 1.127.3 1.126.6 1.125.13 1.123.18 1.122.2 1.121.1 1.120.24 1.119.1 1.118.0 1.117.0 1.116.4 1.115.5

public interface BigQueryConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDropUnknownFields()

public abstract boolean getDropUnknownFields()

Optional. If true and use_topic_schema is true, drops any fields that are part of the topic schema that are not part of the BigQuery table schema 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. If true and use_table_schema is true, drops any fields in the message that are not part of the BigQuery table schema when writing to BigQuery. Otherwise, the write to BigQuery will fail.

bool drop_unknown_fields = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The dropUnknownFields.

getServiceAccountEmail()

public abstract String getServiceAccountEmail()

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.

string service_account_email = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The serviceAccountEmail.

getServiceAccountEmailBytes()

public abstract ByteString getServiceAccountEmailBytes()

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.

string service_account_email = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for serviceAccountEmail.

getState()

public abstract BigQueryConfig.State getState()

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

.google.pubsub.v1.BigQueryConfig.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BigQueryConfig.State	The state.

getStateValue()

public abstract int getStateValue()

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

.google.pubsub.v1.BigQueryConfig.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getTable()

public abstract String getTable()

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

string table = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The table.

getTableBytes()

public abstract ByteString getTableBytes()

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

string table = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for table.

getUseTableSchema()

public abstract boolean getUseTableSchema()

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.

bool use_table_schema = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The useTableSchema.

getUseTopicSchema()

public abstract boolean getUseTopicSchema()

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.

bool use_topic_schema = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The useTopicSchema.

getWriteMetadata()

public abstract boolean getWriteMetadata()

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.

bool write_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The writeMetadata.