public static final class BigQueryConfig.Builder extends GeneratedMessageV3.Builder<BigQueryConfig.Builder> implements BigQueryConfigOrBuilderConfiguration for a BigQuery subscription.
Protobuf type google.pubsub.v1.BigQueryConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BigQueryConfig.BuilderImplements
BigQueryConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BigQueryConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
build()
public BigQueryConfig build()| Returns | |
|---|---|
| Type | Description |
BigQueryConfig |
|
buildPartial()
public BigQueryConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
BigQueryConfig |
|
clear()
public BigQueryConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
clearDropUnknownFields()
public BigQueryConfig.Builder clearDropUnknownFields()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.
bool drop_unknown_fields = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public BigQueryConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public BigQueryConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
clearServiceAccountEmail()
public BigQueryConfig.Builder clearServiceAccountEmail() 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 |
BigQueryConfig.Builder |
This builder for chaining. |
clearState()
public BigQueryConfig.Builder clearState()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.Builder |
This builder for chaining. |
clearTable()
public BigQueryConfig.Builder clearTable()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 |
BigQueryConfig.Builder |
This builder for chaining. |
clearUseTableSchema()
public BigQueryConfig.Builder clearUseTableSchema() 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 |
BigQueryConfig.Builder |
This builder for chaining. |
clearUseTopicSchema()
public BigQueryConfig.Builder clearUseTopicSchema() 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 |
BigQueryConfig.Builder |
This builder for chaining. |
clearWriteMetadata()
public BigQueryConfig.Builder clearWriteMetadata()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 |
BigQueryConfig.Builder |
This builder for chaining. |
clone()
public BigQueryConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
getDefaultInstanceForType()
public BigQueryConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BigQueryConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDropUnknownFields()
public boolean getDropUnknownFields()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.
bool drop_unknown_fields = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The dropUnknownFields. |
getServiceAccountEmail()
public 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 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public BigQueryConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public BigQueryConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
mergeFrom(BigQueryConfig other)
public BigQueryConfig.Builder mergeFrom(BigQueryConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
BigQueryConfig |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BigQueryConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
setDropUnknownFields(boolean value)
public BigQueryConfig.Builder setDropUnknownFields(boolean value)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.
bool drop_unknown_fields = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe dropUnknownFields to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public BigQueryConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BigQueryConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
setServiceAccountEmail(String value)
public BigQueryConfig.Builder setServiceAccountEmail(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe serviceAccountEmail to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
setServiceAccountEmailBytes(ByteString value)
public BigQueryConfig.Builder setServiceAccountEmailBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for serviceAccountEmail to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
setState(BigQueryConfig.State value)
public BigQueryConfig.Builder setState(BigQueryConfig.State value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
BigQueryConfig.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
setStateValue(int value)
public BigQueryConfig.Builder setStateValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
setTable(String value)
public BigQueryConfig.Builder setTable(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe table to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
setTableBytes(ByteString value)
public BigQueryConfig.Builder setTableBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for table to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final BigQueryConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
|
setUseTableSchema(boolean value)
public BigQueryConfig.Builder setUseTableSchema(boolean value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe useTableSchema to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
setUseTopicSchema(boolean value)
public BigQueryConfig.Builder setUseTopicSchema(boolean value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe useTopicSchema to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |
setWriteMetadata(boolean value)
public BigQueryConfig.Builder setWriteMetadata(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe writeMetadata to set. |
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder |
This builder for chaining. |