Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class BigQuerySource.
BigQuery source import data from.
Generated from protobuf message google.cloud.discoveryengine.v1beta.BigQuerySource
Methods
__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. |
↳ 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 user event imports: * |
getPartitionDate
BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Date|null | |
hasPartitionDate
setPartitionDate
BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
| 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 user event imports:
user_event(default): One UserEvent per row. Supported values for document imports:document(default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data.custom: One custom data per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
| Returns | |
|---|---|
| Type | Description |
string | |
setDataSchema
The schema to use when parsing the data from the source.
Supported values for user event imports:
user_event(default): One UserEvent per row. Supported values for document imports:document(default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data.custom: One custom data per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartition
| Returns | |
|---|---|
| Type | Description |
string | |