Google Cloud Asset Inventory v1 API - Class QueryAssetsRequest (3.11.0)

public sealed class QueryAssetsRequest : IMessage<QueryAssetsRequest>, IEquatable<QueryAssetsRequest>, IDeepCloneable<QueryAssetsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Asset Inventory v1 API class QueryAssetsRequest.

QueryAssets request.

Inheritance

object > QueryAssetsRequest

Namespace

Google.Cloud.Asset.V1

Assembly

Google.Cloud.Asset.V1.dll

Constructors

QueryAssetsRequest()

public QueryAssetsRequest()

QueryAssetsRequest(QueryAssetsRequest)

public QueryAssetsRequest(QueryAssetsRequest other)
Parameter
NameDescription
otherQueryAssetsRequest

Properties

HasJobReference

public bool HasJobReference { get; }

Gets whether the "job_reference" field is set

Property Value
TypeDescription
bool

HasStatement

public bool HasStatement { get; }

Gets whether the "statement" field is set

Property Value
TypeDescription
bool

JobReference

public string JobReference { get; set; }

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

Property Value
TypeDescription
string

OutputConfig

public QueryAssetsOutputConfig OutputConfig { get; set; }

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.

Property Value
TypeDescription
QueryAssetsOutputConfig

PageSize

public int PageSize { get; set; }

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.

Property Value
TypeDescription
int

PageToken

public string PageToken { get; set; }

Optional. A page token received from previous QueryAssets.

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

Property Value
TypeDescription
string

Parent

public string Parent { get; set; }

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.

Property Value
TypeDescription
string

ParentAsResourceName

public IResourceName ParentAsResourceName { get; set; }

IResourceName-typed view over the Parent resource name property.

Property Value
TypeDescription
IResourceName

QueryCase

public QueryAssetsRequest.QueryOneofCase QueryCase { get; }
Property Value
TypeDescription
QueryAssetsRequestQueryOneofCase

ReadTime

public Timestamp ReadTime { get; set; }

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

Property Value
TypeDescription
Timestamp

ReadTimeWindow

public TimeWindow ReadTimeWindow { get; set; }

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.

Property Value
TypeDescription
TimeWindow

Statement

public string Statement { get; set; }

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

Property Value
TypeDescription
string

TimeCase

public QueryAssetsRequest.TimeOneofCase TimeCase { get; }
Property Value
TypeDescription
QueryAssetsRequestTimeOneofCase

Timeout

public Duration Timeout { get; set; }

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.

Property Value
TypeDescription
Duration