Class: Google::Cloud::Asset::V1::QueryAssetsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/asset/v1/asset_service.rb

Overview

QueryAssets request.

Instance Attribute Summary collapse

Instance Attribute Details

#job_reference ⇒ ::String

Returns 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.



1718
1719
1720
1721
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1718

class QueryAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#output_config ⇒ ::Google::Cloud::Asset::V1::QueryAssetsOutputConfig

Returns 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.



1718
1719
1720
1721
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1718

class QueryAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.



1718
1719
1720
1721
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1718

class QueryAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.



1718
1719
1720
1721
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1718

class QueryAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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.



1718
1719
1720
1721
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1718

class QueryAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_time ⇒ ::Google::Protobuf::Timestamp

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

Returns:



1718
1719
1720
1721
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1718

class QueryAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_time_window ⇒ ::Google::Cloud::Asset::V1::TimeWindow

Returns 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.



1718
1719
1720
1721
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1718

class QueryAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#statement ⇒ ::String

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

Returns:

  • (::String) —

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



1718
1719
1720
1721
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1718

class QueryAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#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.

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.



1718
1719
1720
1721
 
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 1718

class QueryAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end