public final class BigQuerySource extends GeneratedMessageV3 implements BigQuerySourceOrBuilder
BigQuery source import data from.
Protobuf type google.cloud.retail.v2.BigQuerySource
Static Fields
DATASET_ID_FIELD_NUMBER
public static final int DATASET_ID_FIELD_NUMBER
Field Value
DATA_SCHEMA_FIELD_NUMBER
public static final int DATA_SCHEMA_FIELD_NUMBER
Field Value
GCS_STAGING_DIR_FIELD_NUMBER
public static final int GCS_STAGING_DIR_FIELD_NUMBER
Field Value
PARTITION_DATE_FIELD_NUMBER
public static final int PARTITION_DATE_FIELD_NUMBER
Field Value
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TABLE_ID_FIELD_NUMBER
public static final int TABLE_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static BigQuerySource getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static BigQuerySource.Builder newBuilder()
Returns
newBuilder(BigQuerySource prototype)
public static BigQuerySource.Builder newBuilder(BigQuerySource prototype)
Parameter
Returns
public static BigQuerySource parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static BigQuerySource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static BigQuerySource parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BigQuerySource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static BigQuerySource parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BigQuerySource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BigQuerySource parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static BigQuerySource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BigQuerySource parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static BigQuerySource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static BigQuerySource parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BigQuerySource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<BigQuerySource> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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
getDefaultInstanceForType()
public BigQuerySource getDefaultInstanceForType()
Returns
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.
|
getParserForType()
public Parser<BigQuerySource> getParserForType()
Returns
Overrides
getPartitionCase()
public BigQuerySource.PartitionCase getPartitionCase()
Returns
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.
|
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
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public BigQuerySource.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BigQuerySource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public BigQuerySource.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions