- JSON representation
- GcsDestination
- BigQueryDestination
- PartitionKey
- WriteDisposition
- CreateDisposition
Output configuration for export destination.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field destination . Export destination. destination can be only one of the following: |
|
gcsDestination |
Destination on Cloud Storage. |
bigqueryDestination |
Destination on BigQuery. |
GcsDestination
A Cloud Storage location.
JSON representation |
---|
{ "uri": string, "bucket": string, "object": string, "force": boolean } |
Fields | |
---|---|
uri |
Optional. The path to the file in Cloud Storage where the export will be stored. The URI is in the form |
bucket |
Required. The bucket name to which the export will be stored. |
object |
Required. The object name to which the export will be stored. |
force |
Optional. Flag to indicate overwrite in case file already exists. |
BigQueryDestination
A BigQuery destination for exporting assets to.
JSON representation |
---|
{ "dataset": string, "table": string, "partitionKey": enum ( |
Fields | |
---|---|
dataset |
Required. The BigQuery dataset in format "projects/{projectId}/datasets/{datasetId}", to which the snapshot result should be exported. If this dataset does not exist, the export call returns an INVALID_ARGUMENT error. |
table |
Required. The BigQuery table to which the snapshot result should be written. |
partitionKey |
Optional. The partition key for BigQuery partitioned table. |
writeDisposition |
Optional. Specifies the action that occurs if the destination table or partition already exists. |
createDisposition |
Optional. Specifies the action that occurs if the destination table does not exist |
gcsLocation |
Optional. Specifies the Cloud Storage location. Users can choose to provide a location for Cloud Storage bucket to store the exported data. (as it is possible that some locations are restricted via org policy for that project) Temporary Cloud Storage bucket creation is an interim step for BigQuery upload. If no value is provided, the default location used will be 'US'. |
PartitionKey
This enum determines the partition key column for the BigQuery tables. Partitioning can improve query performance and reduce query cost by filtering partitions. Refer to https://cloud.google.com/bigquery/docs/partitioned-tables for details.
Enums | |
---|---|
PARTITION_KEY_UNSPECIFIED |
Unspecified partition key. Tables won't be partitioned using this option. |
REQUEST_TIME |
The time when the request is received. If specified as partition key, the result table(s) is partitioned by the RequestTime column, an additional timestamp column representing when the request was received. |
WriteDisposition
Specifies the action that occurs if the destination table or partition already exists. By default, the data will be appended to the existing table.
Enums | |
---|---|
WRITE_DISPOSITION_UNSPECIFIED |
Unspecified write disposition. |
WRITE_APPEND |
If the table or partition already exists, BigQuery appends the data to the table or the latest partition. |
WRITE_TRUNCATE |
If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data. |
WRITE_EMPTY |
If the table already exists and contains data, an error is returned. |
CreateDisposition
Specifies the action that occurs if the destination table does not exist. By default, a new table will be created.
Enums | |
---|---|
CREATE_DISPOSITION_UNSPECIFIED |
Unspecified create disposition. |
CREATE_IF_NEEDED |
If the table does not exist, BigQuery creates the table. |
CREATE_NEVER |
If the table does not exist, an error will be returned. |