Reference documentation and code samples for the Google Cloud Capacity Planner V1beta Client class BigQueryDestination.
A BigQuery destination for exporting assets to.
Generated from protobuf message google.cloud.capacityplanner.v1beta.BigQueryDestination
Namespace
Google \ Cloud \ CapacityPlanner \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ dataset |
string
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 |
string
Required. The BigQuery table to which the snapshot result should be written. |
↳ partition_key |
int
Optional. The partition key for BigQuery partitioned table. |
↳ write_disposition |
int
Optional. Specifies the action that occurs if the destination table or partition already exists. |
↳ create_disposition |
int
Optional. Specifies the action that occurs if the destination table does not exist |
↳ gcs_location |
string
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'. |
getDataset
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataset
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTable
Required. The BigQuery table to which the snapshot result should be written.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTable
Required. The BigQuery table to which the snapshot result should be written.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPartitionKey
Optional. The partition key for BigQuery partitioned table.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type PartitionKey. |
setPartitionKey
Optional. The partition key for BigQuery partitioned table.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type PartitionKey. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWriteDisposition
Optional. Specifies the action that occurs if the destination table or partition already exists.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type WriteDisposition. |
setWriteDisposition
Optional. Specifies the action that occurs if the destination table or partition already exists.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type WriteDisposition. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateDisposition
Optional. Specifies the action that occurs if the destination table does not exist
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type CreateDisposition. |
setCreateDisposition
Optional. Specifies the action that occurs if the destination table does not exist
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type CreateDisposition. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcsLocation
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'.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGcsLocation
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'.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|