com.google.cloud.bigquery.analyticshub.v1

Class BigQueryConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

com.google.cloud.bigquery.analyticshub.v1.BigQueryConfig.Builder

All Implemented Interfaces:

BigQueryConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

BigQueryConfig

public static final class BigQueryConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>
implements BigQueryConfigOrBuilder

 Configuration for a BigQuery subscription.
 

Protobuf type google.cloud.bigquery.analyticshub.v1.BigQueryConfig

Method Summary

Modifier and Type	Method and Description
BigQueryConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BigQueryConfig	build()
BigQueryConfig	buildPartial()
BigQueryConfig.Builder	clear()
BigQueryConfig.Builder	clearDropUnknownFields() Optional.
BigQueryConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
BigQueryConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
BigQueryConfig.Builder	clearServiceAccountEmail() Optional.
BigQueryConfig.Builder	clearTable() Optional.
BigQueryConfig.Builder	clearUseTableSchema() Optional.
BigQueryConfig.Builder	clearUseTopicSchema() Optional.
BigQueryConfig.Builder	clearWriteMetadata() Optional.
BigQueryConfig.Builder	clone()
BigQueryConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getDropUnknownFields() Optional.
String	getServiceAccountEmail() Optional.
com.google.protobuf.ByteString	getServiceAccountEmailBytes() Optional.
String	getTable() Optional.
com.google.protobuf.ByteString	getTableBytes() Optional.
boolean	getUseTableSchema() Optional.
boolean	getUseTopicSchema() Optional.
boolean	getWriteMetadata() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
BigQueryConfig.Builder	mergeFrom(BigQueryConfig other)
BigQueryConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
BigQueryConfig.Builder	mergeFrom(com.google.protobuf.Message other)
BigQueryConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
BigQueryConfig.Builder	setDropUnknownFields(boolean value) Optional.
BigQueryConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BigQueryConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
BigQueryConfig.Builder	setServiceAccountEmail(String value) Optional.
BigQueryConfig.Builder	setServiceAccountEmailBytes(com.google.protobuf.ByteString value) Optional.
BigQueryConfig.Builder	setTable(String value) Optional.
BigQueryConfig.Builder	setTableBytes(com.google.protobuf.ByteString value) Optional.
BigQueryConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
BigQueryConfig.Builder	setUseTableSchema(boolean value) Optional.
BigQueryConfig.Builder	setUseTopicSchema(boolean value) Optional.
BigQueryConfig.Builder	setWriteMetadata(boolean value) Optional.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

clear

public BigQueryConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

getDefaultInstanceForType

public BigQueryConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public BigQueryConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public BigQueryConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public BigQueryConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

setField

public BigQueryConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

clearField

public BigQueryConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

clearOneof

public BigQueryConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

setRepeatedField

public BigQueryConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

addRepeatedField

public BigQueryConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

mergeFrom

public BigQueryConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BigQueryConfig.Builder>

mergeFrom

public BigQueryConfig.Builder mergeFrom(BigQueryConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

mergeFrom

public BigQueryConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BigQueryConfig.Builder>

Throws:

IOException

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];

Specified by:

getTable in interface BigQueryConfigOrBuilder

Returns:

The table.

getTableBytes

public com.google.protobuf.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];

Specified by:

getTableBytes in interface BigQueryConfigOrBuilder

Returns:

The bytes for table.

setTable

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];

Parameters:

value - The table to set.

Returns:

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:

This builder for chaining.

setTableBytes

public BigQueryConfig.Builder setTableBytes(com.google.protobuf.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];

Parameters:

value - The bytes for table to set.

Returns:

This builder for chaining.

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];

Specified by:

getUseTopicSchema in interface BigQueryConfigOrBuilder

Returns:

The useTopicSchema.

setUseTopicSchema

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];

Parameters:

value - The useTopicSchema to set.

Returns:

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:

This builder for chaining.

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];

Specified by:

getWriteMetadata in interface BigQueryConfigOrBuilder

Returns:

The writeMetadata.

setWriteMetadata

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];

Parameters:

value - The writeMetadata to set.

Returns:

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:

This builder for chaining.

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];

Specified by:

getDropUnknownFields in interface BigQueryConfigOrBuilder

Returns:

The dropUnknownFields.

setDropUnknownFields

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];

Parameters:

value - The dropUnknownFields to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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];

Specified by:

getUseTableSchema in interface BigQueryConfigOrBuilder

Returns:

The useTableSchema.

setUseTableSchema

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];

Parameters:

value - The useTableSchema to set.

Returns:

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:

This builder for chaining.

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](https://cloud.google.com/iam/docs/service-agents),
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
 

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

Specified by:

getServiceAccountEmail in interface BigQueryConfigOrBuilder

Returns:

The serviceAccountEmail.

getServiceAccountEmailBytes

public com.google.protobuf.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](https://cloud.google.com/iam/docs/service-agents),
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
 

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

Specified by:

getServiceAccountEmailBytes in interface BigQueryConfigOrBuilder

Returns:

The bytes for serviceAccountEmail.

setServiceAccountEmail

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](https://cloud.google.com/iam/docs/service-agents),
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
 

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

Parameters:

value - The serviceAccountEmail to set.

Returns:

This builder for chaining.

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](https://cloud.google.com/iam/docs/service-agents),
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
 

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

Returns:

This builder for chaining.

setServiceAccountEmailBytes

public BigQueryConfig.Builder setServiceAccountEmailBytes(com.google.protobuf.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](https://cloud.google.com/iam/docs/service-agents),
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
 

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

Parameters:

value - The bytes for serviceAccountEmail to set.

Returns:

This builder for chaining.

setUnknownFields

public final BigQueryConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>

mergeUnknownFields

public final BigQueryConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BigQueryConfig.Builder>