Reference documentation and code samples for the Common Protos for Google Cloud APIs Client class Query.
Query job configuration.
Generated from protobuf message google.cloud.audit.BigQueryAuditMetadata.JobConfig.Query
Namespace
Google \ Cloud \ Audit \ BigQueryAuditMetadata \ JobConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ query |
string
The SQL query to run. Truncated if exceeds 50K. |
↳ query_truncated |
bool
True if the query field was truncated. |
↳ destination_table |
string
The destination table for the query results. |
↳ create_disposition |
int
Destination table create disposition. |
↳ write_disposition |
int
Destination table write disposition. |
↳ default_dataset |
string
Default dataset for the query. |
↳ table_definitions |
array<Google\Cloud\Audit\BigQueryAuditMetadata\TableDefinition>
External data sources used in the query. |
↳ priority |
int
Priority given to the query. |
↳ destination_table_encryption |
Google\Cloud\Audit\BigQueryAuditMetadata\EncryptionInfo
Result table encryption information. Set when non-default encryption is used. |
↳ statement_type |
int
Type of the query. |
getQuery
The SQL query to run. Truncated if exceeds 50K.
| Returns | |
|---|---|
| Type | Description |
string |
|
setQuery
The SQL query to run. Truncated if exceeds 50K.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueryTruncated
True if the query field was truncated.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setQueryTruncated
True if the query field was truncated.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestinationTable
The destination table for the query results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDestinationTable
The destination table for the query results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateDisposition
Destination table create disposition.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type CreateDisposition. |
setCreateDisposition
Destination table create disposition.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type CreateDisposition. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWriteDisposition
Destination table write disposition.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type WriteDisposition. |
setWriteDisposition
Destination table write disposition.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type WriteDisposition. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultDataset
Default dataset for the query.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDefaultDataset
Default dataset for the query.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTableDefinitions
External data sources used in the query.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setTableDefinitions
External data sources used in the query.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Audit\BigQueryAuditMetadata\TableDefinition>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPriority
Priority given to the query.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Priority. |
setPriority
Priority given to the query.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Priority. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestinationTableEncryption
Result table encryption information. Set when non-default encryption is used.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Audit\BigQueryAuditMetadata\EncryptionInfo|null |
|
hasDestinationTableEncryption
clearDestinationTableEncryption
setDestinationTableEncryption
Result table encryption information. Set when non-default encryption is used.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Audit\BigQueryAuditMetadata\EncryptionInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatementType
Type of the query.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type QueryStatementType. |
setStatementType
Type of the query.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type QueryStatementType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|