Google Cloud Asset V1 Client - Class QueryAssetsRequest (2.1.0)

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

QueryAssets request.

Generated from protobuf message google.cloud.asset.v1.QueryAssetsRequest

Namespace

Google \ Cloud \ Asset \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"), or a folder number (such as "folders/123"). Only assets belonging to the parent will be returned.
↳ statement string

Optional. A SQL statement that's compatible with BigQuery SQL.
↳ job_reference string

Optional. Reference to the query job, which is from the QueryAssetsResponse of previous QueryAssets call.
↳ page_size int

Optional. The maximum number of rows to return in the results. Responses are limited to 10 MB and 1000 rows. By default, the maximum row count is 1000. When the byte or row count limit is reached, the rest of the query results will be paginated. The field will be ignored when [output_config] is specified.
↳ page_token string

Optional. A page token received from previous QueryAssets. The field will be ignored when [output_config] is specified.
↳ timeout Google\Protobuf\Duration

Optional. Specifies the maximum amount of time that the client is willing to wait for the query to complete. By default, this limit is 5 min for the first query, and 1 minute for the following queries. If the query is complete, the done field in the QueryAssetsResponse is true, otherwise false. Like BigQuery jobs.query API The call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. The field will be ignored when [output_config] is specified.
↳ read_time_window Google\Cloud\Asset\V1\TimeWindow

Optional. [start_time] is required. [start_time] must be less than [end_time] Defaults [end_time] to now if [start_time] is set and [end_time] isn't. Maximum permitted time range is 7 days.
↳ read_time Google\Protobuf\Timestamp

Optional. Queries cloud assets as they appeared at the specified point in time.
↳ output_config Google\Cloud\Asset\V1\QueryAssetsOutputConfig

Optional. Destination where the query results will be saved. When this field is specified, the query results won't be saved in the [QueryAssetsResponse.query_result]. Instead [QueryAssetsResponse.output_config] will be set. Meanwhile, [QueryAssetsResponse.job_reference] will be set and can be used to check the status of the query job when passed to a following [QueryAssets] API call.

getParent

Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"), or a folder number (such as "folders/123").

Only assets belonging to the parent will be returned.

Returns
Type Description
string

setParent

Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"), or a folder number (such as "folders/123").

Only assets belonging to the parent will be returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getStatement

Optional. A SQL statement that's compatible with BigQuery SQL.

Returns
Type Description
string

hasStatement

setStatement

Optional. A SQL statement that's compatible with BigQuery SQL.

Parameter
Name Description
var string
Returns
Type Description
$this

getJobReference

Optional. Reference to the query job, which is from the QueryAssetsResponse of previous QueryAssets call.

Returns
Type Description
string

hasJobReference

setJobReference

Optional. Reference to the query job, which is from the QueryAssetsResponse of previous QueryAssets call.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of rows to return in the results. Responses are limited to 10 MB and 1000 rows.

By default, the maximum row count is 1000. When the byte or row count limit is reached, the rest of the query results will be paginated. The field will be ignored when [output_config] is specified.

Returns
Type Description
int

setPageSize

Optional. The maximum number of rows to return in the results. Responses are limited to 10 MB and 1000 rows.

By default, the maximum row count is 1000. When the byte or row count limit is reached, the rest of the query results will be paginated. The field will be ignored when [output_config] is specified.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token received from previous QueryAssets.

The field will be ignored when [output_config] is specified.

Returns
Type Description
string

setPageToken

Optional. A page token received from previous QueryAssets.

The field will be ignored when [output_config] is specified.

Parameter
Name Description
var string
Returns
Type Description
$this

getTimeout

Optional. Specifies the maximum amount of time that the client is willing to wait for the query to complete. By default, this limit is 5 min for the first query, and 1 minute for the following queries. If the query is complete, the done field in the QueryAssetsResponse is true, otherwise false.

Like BigQuery jobs.query API The call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. The field will be ignored when [output_config] is specified.

Returns
Type Description
Google\Protobuf\Duration|null

hasTimeout

clearTimeout

setTimeout

Optional. Specifies the maximum amount of time that the client is willing to wait for the query to complete. By default, this limit is 5 min for the first query, and 1 minute for the following queries. If the query is complete, the done field in the QueryAssetsResponse is true, otherwise false.

Like BigQuery jobs.query API The call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. The field will be ignored when [output_config] is specified.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getReadTimeWindow

Optional. [start_time] is required. [start_time] must be less than [end_time] Defaults [end_time] to now if [start_time] is set and [end_time] isn't. Maximum permitted time range is 7 days.

Returns
Type Description
Google\Cloud\Asset\V1\TimeWindow|null

hasReadTimeWindow

setReadTimeWindow

Optional. [start_time] is required. [start_time] must be less than [end_time] Defaults [end_time] to now if [start_time] is set and [end_time] isn't. Maximum permitted time range is 7 days.

Parameter
Name Description
var Google\Cloud\Asset\V1\TimeWindow
Returns
Type Description
$this

getReadTime

Optional. Queries cloud assets as they appeared at the specified point in time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasReadTime

setReadTime

Optional. Queries cloud assets as they appeared at the specified point in time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getOutputConfig

Optional. Destination where the query results will be saved.

When this field is specified, the query results won't be saved in the [QueryAssetsResponse.query_result]. Instead [QueryAssetsResponse.output_config] will be set. Meanwhile, [QueryAssetsResponse.job_reference] will be set and can be used to check the status of the query job when passed to a following [QueryAssets] API call.

Returns
Type Description
Google\Cloud\Asset\V1\QueryAssetsOutputConfig|null

hasOutputConfig

clearOutputConfig

setOutputConfig

Optional. Destination where the query results will be saved.

When this field is specified, the query results won't be saved in the [QueryAssetsResponse.query_result]. Instead [QueryAssetsResponse.output_config] will be set. Meanwhile, [QueryAssetsResponse.job_reference] will be set and can be used to check the status of the query job when passed to a following [QueryAssets] API call.

Parameter
Name Description
var Google\Cloud\Asset\V1\QueryAssetsOutputConfig
Returns
Type Description
$this

getQuery

Returns
Type Description
string

getTime

Returns
Type Description
string