Google Cloud Asset V1 Client - Class BigQueryDestination (1.9.2)

Reference documentation and code samples for the Google Cloud Asset V1 Client class BigQueryDestination.

A BigQuery destination.

Generated from protobuf message google.cloud.asset.v1.IamPolicyAnalysisOutputConfig.BigQueryDestination

Methods

__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 analysis results should be exported. If this dataset does not exist, the export call will return an INVALID_ARGUMENT error.
`↳ table_prefix`	`string` Required. The prefix of the BigQuery tables to which the analysis results will be written. Tables will be created based on this table_prefix if not exist: * <table_prefix>_analysis table will contain export operation's metadata. * <table_prefix>_analysis_result will contain all the IamPolicyAnalysisResult. When [partition_key] is specified, both tables will be partitioned based on the [partition_key].
`↳ partition_key`	`int` The partition key for BigQuery partitioned table.
`↳ write_disposition`	`string` Optional. Specifies the action that occurs if the destination table or partition already exists. The following values are supported: * WRITE_TRUNCATE: If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data. * WRITE_APPEND: If the table or partition already exists, BigQuery appends the data to the table or the latest partition. * WRITE_EMPTY: If the table already exists and contains data, an error is returned. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Details are at https://cloud.google.com/bigquery/docs/loading-data-local#appending_to_or_overwriting_a_table_using_a_local_file.

getDataset

Required. The BigQuery dataset in format "projects/projectId/datasets/datasetId", to which the analysis results should be exported. If this dataset does not exist, the export call will return an INVALID_ARGUMENT error.

Generated from protobuf field string dataset = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

setDataset

Generated from protobuf field string dataset = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTablePrefix

Required. The prefix of the BigQuery tables to which the analysis results will be written. Tables will be created based on this table_prefix if not exist:

<table_prefix>_analysis table will contain export operation's metadata.
<table_prefix>_analysis_result will contain all the IamPolicyAnalysisResult. When [partition_key] is specified, both tables will be partitioned based on the [partition_key].

Generated from protobuf field string table_prefix = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

setTablePrefix

Required. The prefix of the BigQuery tables to which the analysis results will be written. Tables will be created based on this table_prefix if not exist:

<table_prefix>_analysis table will contain export operation's metadata.
<table_prefix>_analysis_result will contain all the IamPolicyAnalysisResult. When [partition_key] is specified, both tables will be partitioned based on the [partition_key].

Generated from protobuf field string table_prefix = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPartitionKey

The partition key for BigQuery partitioned table.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisOutputConfig.BigQueryDestination.PartitionKey partition_key = 3;

Returns
Type	Description
`int`

setPartitionKey

The partition key for BigQuery partitioned table.

Generated from protobuf field .google.cloud.asset.v1.IamPolicyAnalysisOutputConfig.BigQueryDestination.PartitionKey partition_key = 3;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getWriteDisposition

Optional. Specifies the action that occurs if the destination table or partition already exists. The following values are supported:

WRITE_TRUNCATE: If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data.
WRITE_APPEND: If the table or partition already exists, BigQuery appends the data to the table or the latest partition.
WRITE_EMPTY: If the table already exists and contains data, an error is returned. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Details are at https://cloud.google.com/bigquery/docs/loading-data-local#appending_to_or_overwriting_a_table_using_a_local_file.

Generated from protobuf field string write_disposition = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setWriteDisposition

Optional. Specifies the action that occurs if the destination table or partition already exists. The following values are supported:

WRITE_TRUNCATE: If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data.
WRITE_APPEND: If the table or partition already exists, BigQuery appends the data to the table or the latest partition.
WRITE_EMPTY: If the table already exists and contains data, an error is returned. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Details are at https://cloud.google.com/bigquery/docs/loading-data-local#appending_to_or_overwriting_a_table_using_a_local_file.

Generated from protobuf field string write_disposition = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`