Class BigQuerySource.Builder (2.1.0)

public static final class BigQuerySource.Builder extends GeneratedMessageV3.Builder<BigQuerySource.Builder> implements BigQuerySourceOrBuilder

BigQuery source import data from.

Protobuf type google.cloud.retail.v2.BigQuerySource

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BigQuerySource.Builder

Implements

BigQuerySourceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BigQuerySource.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
BigQuerySource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public BigQuerySource build()

Returns

Type	Description
BigQuerySource

buildPartial()

public BigQuerySource buildPartial()

Returns

Type	Description
BigQuerySource

clear()

public BigQuerySource.Builder clear()

Returns

Type	Description
BigQuerySource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDataSchema()

public BigQuerySource.Builder clearDataSchema()

The schema to use when parsing the data from the source. Supported values for product imports:

product (default): One JSON Product per line. Each product must have a valid Product.id.
product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports:
user_event (default): One JSON UserEvent per line.
user_event_ga360: The schema is available here: https://support.google.com/analytics/answer/3437719.
user_event_ga4: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for auto-completion imports:
suggestions (default): One JSON completion suggestion per line.
denylist: One JSON deny suggestion per line.
allowlist: One JSON allow suggestion per line.

string data_schema = 4;

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

clearDatasetId()

public BigQuerySource.Builder clearDatasetId()

Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.

string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BigQuerySource.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
BigQuerySource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGcsStagingDir()

public BigQuerySource.Builder clearGcsStagingDir()

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.

string gcs_staging_dir = 3;

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BigQuerySource.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
BigQuerySource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPartition()

public BigQuerySource.Builder clearPartition()

Returns

Type	Description
BigQuerySource.Builder

clearPartitionDate()

public BigQuerySource.Builder clearPartitionDate()

BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

.google.type.Date partition_date = 6;

Returns

Type	Description
BigQuerySource.Builder

clearProjectId()

public BigQuerySource.Builder clearProjectId()

The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 5;

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

clearTableId()

public BigQuerySource.Builder clearTableId()

Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.

string table_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

clone()

public BigQuerySource.Builder clone()

Returns

Type	Description
BigQuerySource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDataSchema()

public String getDataSchema()

The schema to use when parsing the data from the source. Supported values for product imports:

product (default): One JSON Product per line. Each product must have a valid Product.id.
product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports:
user_event (default): One JSON UserEvent per line.
user_event_ga360: The schema is available here: https://support.google.com/analytics/answer/3437719.
user_event_ga4: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for auto-completion imports:
suggestions (default): One JSON completion suggestion per line.
denylist: One JSON deny suggestion per line.
allowlist: One JSON allow suggestion per line.

string data_schema = 4;

Returns

Type	Description
String	The dataSchema.

getDataSchemaBytes()

public ByteString getDataSchemaBytes()

The schema to use when parsing the data from the source. Supported values for product imports:

product (default): One JSON Product per line. Each product must have a valid Product.id.
product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports:
user_event (default): One JSON UserEvent per line.
user_event_ga360: The schema is available here: https://support.google.com/analytics/answer/3437719.
user_event_ga4: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for auto-completion imports:
suggestions (default): One JSON completion suggestion per line.
denylist: One JSON deny suggestion per line.
allowlist: One JSON allow suggestion per line.

string data_schema = 4;

Returns

Type	Description
ByteString	The bytes for dataSchema.

getDatasetId()

public String getDatasetId()

Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.

string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The datasetId.

getDatasetIdBytes()

public ByteString getDatasetIdBytes()

Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.

string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for datasetId.

getDefaultInstanceForType()

public BigQuerySource getDefaultInstanceForType()

Returns

Type	Description
BigQuerySource

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGcsStagingDir()

public String getGcsStagingDir()

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.

string gcs_staging_dir = 3;

Returns

Type	Description
String	The gcsStagingDir.

getGcsStagingDirBytes()

public ByteString getGcsStagingDirBytes()

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.

string gcs_staging_dir = 3;

Returns

Type	Description
ByteString	The bytes for gcsStagingDir.

getPartitionCase()

public BigQuerySource.PartitionCase getPartitionCase()

Returns

Type	Description
BigQuerySource.PartitionCase

getPartitionDate()

public Date getPartitionDate()

BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

.google.type.Date partition_date = 6;

Returns

Type	Description
com.google.type.Date	The partitionDate.

getPartitionDateBuilder()

public Date.Builder getPartitionDateBuilder()

BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

.google.type.Date partition_date = 6;

Returns

Type	Description
com.google.type.Date.Builder

getPartitionDateOrBuilder()

public DateOrBuilder getPartitionDateOrBuilder()

BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

.google.type.Date partition_date = 6;

Returns

Type	Description
com.google.type.DateOrBuilder

getProjectId()

public String getProjectId()

The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 5;

Returns

Type	Description
String	The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 5;

Returns

Type	Description
ByteString	The bytes for projectId.

getTableId()

public String getTableId()

Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.

string table_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The tableId.

getTableIdBytes()

public ByteString getTableIdBytes()

Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.

string table_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for tableId.

hasPartitionDate()

public boolean hasPartitionDate()

BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

.google.type.Date partition_date = 6;

Returns

Type	Description
boolean	Whether the partitionDate field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(BigQuerySource other)

public BigQuerySource.Builder mergeFrom(BigQuerySource other)

Parameter

Name	Description
other	`BigQuerySource`

Returns

Type	Description
BigQuerySource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BigQuerySource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
BigQuerySource.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public BigQuerySource.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
BigQuerySource.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergePartitionDate(Date value)

public BigQuerySource.Builder mergePartitionDate(Date value)

BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

.google.type.Date partition_date = 6;

Parameter

Name	Description
value	`com.google.type.Date`

Returns

Type	Description
BigQuerySource.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BigQuerySource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
BigQuerySource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDataSchema(String value)

public BigQuerySource.Builder setDataSchema(String value)

The schema to use when parsing the data from the source. Supported values for product imports:

product (default): One JSON Product per line. Each product must have a valid Product.id.
product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports:
user_event (default): One JSON UserEvent per line.
user_event_ga360: The schema is available here: https://support.google.com/analytics/answer/3437719.
user_event_ga4: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for auto-completion imports:
suggestions (default): One JSON completion suggestion per line.
denylist: One JSON deny suggestion per line.
allowlist: One JSON allow suggestion per line.

string data_schema = 4;

Parameter

Name	Description
value	`String` The dataSchema to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setDataSchemaBytes(ByteString value)

public BigQuerySource.Builder setDataSchemaBytes(ByteString value)

The schema to use when parsing the data from the source. Supported values for product imports:

product (default): One JSON Product per line. Each product must have a valid Product.id.
product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports:
user_event (default): One JSON UserEvent per line.
user_event_ga360: The schema is available here: https://support.google.com/analytics/answer/3437719.
user_event_ga4: This feature is in private preview. Please contact the support team for importing Google Analytics 4 events. The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for auto-completion imports:
suggestions (default): One JSON completion suggestion per line.
denylist: One JSON deny suggestion per line.
allowlist: One JSON allow suggestion per line.

string data_schema = 4;

Parameter

Name	Description
value	`ByteString` The bytes for dataSchema to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setDatasetId(String value)

public BigQuerySource.Builder setDatasetId(String value)

Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.

string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`String` The datasetId to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setDatasetIdBytes(ByteString value)

public BigQuerySource.Builder setDatasetIdBytes(ByteString value)

Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.

string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`ByteString` The bytes for datasetId to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BigQuerySource.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
BigQuerySource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGcsStagingDir(String value)

public BigQuerySource.Builder setGcsStagingDir(String value)

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.

string gcs_staging_dir = 3;

Parameter

Name	Description
value	`String` The gcsStagingDir to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setGcsStagingDirBytes(ByteString value)

public BigQuerySource.Builder setGcsStagingDirBytes(ByteString value)

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.

string gcs_staging_dir = 3;

Parameter

Name	Description
value	`ByteString` The bytes for gcsStagingDir to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setPartitionDate(Date value)

public BigQuerySource.Builder setPartitionDate(Date value)

BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

.google.type.Date partition_date = 6;

Parameter

Name	Description
value	`com.google.type.Date`

Returns

Type	Description
BigQuerySource.Builder

setPartitionDate(Date.Builder builderForValue)

public BigQuerySource.Builder setPartitionDate(Date.Builder builderForValue)

BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

.google.type.Date partition_date = 6;

Parameter

Name	Description
builderForValue	`com.google.type.Date.Builder`

Returns

Type	Description
BigQuerySource.Builder

setProjectId(String value)

public BigQuerySource.Builder setProjectId(String value)

The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 5;

Parameter

Name	Description
value	`String` The projectId to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setProjectIdBytes(ByteString value)

public BigQuerySource.Builder setProjectIdBytes(ByteString value)

The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 5;

Parameter

Name	Description
value	`ByteString` The bytes for projectId to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BigQuerySource.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
BigQuerySource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTableId(String value)

public BigQuerySource.Builder setTableId(String value)

Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.

string table_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`String` The tableId to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setTableIdBytes(ByteString value)

public BigQuerySource.Builder setTableIdBytes(ByteString value)

Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.

string table_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`ByteString` The bytes for tableId to set.

Returns

Type	Description
BigQuerySource.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BigQuerySource.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
BigQuerySource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)