Cloud Asset V1 API - Class Google::Cloud::Asset::V1::QueryAssetsRequest (v0.28.0)

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

QueryAssets request.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#job_reference

def job_reference() -> ::String

Returns

(::String) — Optional. Reference to the query job, which is from the QueryAssetsResponse of previous QueryAssets call.

#job_reference=

def job_reference=(value) -> ::String

Parameter

value (::String) — Optional. Reference to the query job, which is from the QueryAssetsResponse of previous QueryAssets call.

Returns

(::String) — Optional. Reference to the query job, which is from the QueryAssetsResponse of previous QueryAssets call.

#output_config

def output_config() -> ::Google::Cloud::Asset::V1::QueryAssetsOutputConfig

Returns

(::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.

#output_config=

def output_config=(value) -> ::Google::Cloud::Asset::V1::QueryAssetsOutputConfig

Parameter

value (::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.

Returns

(::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.

#page_size

def page_size() -> ::Integer

Returns

(::Integer) — 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_size=

def page_size=(value) -> ::Integer

Parameter

value (::Integer) — 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

(::Integer) — 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

def page_token() -> ::String

Returns

(::String) — Optional. A page token received from previous QueryAssets.

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

#page_token=

def page_token=(value) -> ::String

Parameter

value (::String) — Optional. A page token received from previous QueryAssets.

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

Returns

(::String) — Optional. A page token received from previous QueryAssets.

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

#parent

def parent() -> ::String

Returns

(::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.

#parent=

def parent=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#read_time

def read_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Optional. Queries cloud assets as they appeared at the specified point in time.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Optional. Queries cloud assets as they appeared at the specified point in time.

Returns

(::Google::Protobuf::Timestamp) — Optional. Queries cloud assets as they appeared at the specified point in time.

#read_time_window

def read_time_window() -> ::Google::Cloud::Asset::V1::TimeWindow

Returns

(::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_window=

def read_time_window=(value) -> ::Google::Cloud::Asset::V1::TimeWindow

Parameter

value (::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.

Returns

(::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.

#statement

def statement() -> ::String

Returns

(::String) — Optional. A SQL statement that's compatible with BigQuery SQL.

#statement=

def statement=(value) -> ::String

Parameter

value (::String) — Optional. A SQL statement that's compatible with BigQuery SQL.

Returns

(::String) — Optional. A SQL statement that's compatible with BigQuery SQL.

#timeout

def timeout() -> ::Google::Protobuf::Duration

Returns

(::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.

#timeout=

def timeout=(value) -> ::Google::Protobuf::Duration

Parameter

value (::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.

Returns

(::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.