Reference documentation and code samples for the Google Cloud Retail V2 Client class BigQuerySource.
BigQuery source import data from.
Generated from protobuf message google.cloud.retail.v2.BigQuerySource
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ partition_date |
Google\Type\Date
BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported in ImportProductsRequest. |
↳ project_id |
string
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. |
↳ dataset_id |
string
Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. |
↳ table_id |
string
Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. |
↳ gcs_staging_dir |
string
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. |
↳ data_schema |
string
The schema to use when parsing the data from the source. Supported values for product imports: * |
getPartitionDate
BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
Only supported in ImportProductsRequest.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Date|null |
|
hasPartitionDate
setPartitionDate
BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
Only supported in ImportProductsRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Date
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProjectId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatasetId
Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatasetId
Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTableId
Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTableId
Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGcsStagingDir
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports:suggestions(default): One JSON completion suggestion per line.denylist: One JSON deny suggestion per line.allowlist: One JSON allow suggestion per line.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataSchema
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: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports:suggestions(default): One JSON completion suggestion per line.denylist: One JSON deny suggestion per line.allowlist: One JSON allow suggestion per line.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPartition
| Returns | |
|---|---|
| Type | Description |
string |
|