Common Protos for Google Cloud APIs Client - Class Query (0.4.2)

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 \ JobConfig

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setQuery

The SQL query to run. Truncated if exceeds 50K.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getQueryTruncated

True if the query field was truncated.

Returns
TypeDescription
bool

setQueryTruncated

True if the query field was truncated.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDestinationTable

The destination table for the query results.

Returns
TypeDescription
string

setDestinationTable

The destination table for the query results.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateDisposition

Destination table create disposition.

Returns
TypeDescription
int

setCreateDisposition

Destination table create disposition.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getWriteDisposition

Destination table write disposition.

Returns
TypeDescription
int

setWriteDisposition

Destination table write disposition.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDefaultDataset

Default dataset for the query.

Returns
TypeDescription
string

setDefaultDataset

Default dataset for the query.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTableDefinitions

External data sources used in the query.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTableDefinitions

External data sources used in the query.

Parameter
NameDescription
var array<Google\Cloud\Audit\BigQueryAuditMetadata\TableDefinition>
Returns
TypeDescription
$this

getPriority

Priority given to the query.

Returns
TypeDescription
int

setPriority

Priority given to the query.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDestinationTableEncryption

Result table encryption information. Set when non-default encryption is used.

Returns
TypeDescription
Google\Cloud\Audit\BigQueryAuditMetadata\EncryptionInfo|null

hasDestinationTableEncryption

clearDestinationTableEncryption

setDestinationTableEncryption

Result table encryption information. Set when non-default encryption is used.

Parameter
NameDescription
var Google\Cloud\Audit\BigQueryAuditMetadata\EncryptionInfo
Returns
TypeDescription
$this

getStatementType

Type of the query.

Returns
TypeDescription
int

setStatementType

Type of the query.

Parameter
NameDescription
var int
Returns
TypeDescription
$this