Interface QueryAssetsRequestOrBuilder (3.38.0)

Version 3.38.0

• 3.55.0 (latest)
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.2-SNAPSHOT
• 3.6.0
• 3.4.1
• 3.3.1
• 3.2.17

public interface QueryAssetsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getJobReference()

public abstract String getJobReference()

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

string job_reference = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The jobReference.

getJobReferenceBytes()

public abstract ByteString getJobReferenceBytes()

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

string job_reference = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for jobReference.

getOutputConfig()

public abstract QueryAssetsOutputConfig 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.

.google.cloud.asset.v1.QueryAssetsOutputConfig output_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
QueryAssetsOutputConfig	The outputConfig.

getOutputConfigOrBuilder()

public abstract QueryAssetsOutputConfigOrBuilder getOutputConfigOrBuilder()

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.

.google.cloud.asset.v1.QueryAssetsOutputConfig output_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
QueryAssetsOutputConfigOrBuilder

getPageSize()

public abstract int 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.

int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. A page token received from previous QueryAssets.

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

string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. A page token received from previous QueryAssets.

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

string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String 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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.

getQueryCase()

public abstract QueryAssetsRequest.QueryCase getQueryCase()

Returns
Type	Description
QueryAssetsRequest.QueryCase

getReadTime()

public abstract Timestamp getReadTime()

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

.google.protobuf.Timestamp read_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The readTime.

getReadTimeOrBuilder()

public abstract TimestampOrBuilder getReadTimeOrBuilder()

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

.google.protobuf.Timestamp read_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getReadTimeWindow()

public abstract TimeWindow 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.

.google.cloud.asset.v1.TimeWindow read_time_window = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimeWindow	The readTimeWindow.

getReadTimeWindowOrBuilder()

public abstract TimeWindowOrBuilder getReadTimeWindowOrBuilder()

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.

.google.cloud.asset.v1.TimeWindow read_time_window = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimeWindowOrBuilder

getStatement()

public abstract String getStatement()

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

string statement = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The statement.

getStatementBytes()

public abstract ByteString getStatementBytes()

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

string statement = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for statement.

getTimeCase()

public abstract QueryAssetsRequest.TimeCase getTimeCase()

Returns
Type	Description
QueryAssetsRequest.TimeCase

getTimeout()

public abstract Duration 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.

.google.protobuf.Duration timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The timeout.

getTimeoutOrBuilder()

public abstract DurationOrBuilder getTimeoutOrBuilder()

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.

.google.protobuf.Duration timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

hasJobReference()

public abstract boolean hasJobReference()

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

string job_reference = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the jobReference field is set.

hasOutputConfig()

public abstract boolean hasOutputConfig()

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.

.google.cloud.asset.v1.QueryAssetsOutputConfig output_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the outputConfig field is set.

hasReadTime()

public abstract boolean hasReadTime()

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

.google.protobuf.Timestamp read_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the readTime field is set.

hasReadTimeWindow()

public abstract boolean hasReadTimeWindow()

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.

.google.cloud.asset.v1.TimeWindow read_time_window = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the readTimeWindow field is set.

hasStatement()

public abstract boolean hasStatement()

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

string statement = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the statement field is set.

hasTimeout()

public abstract boolean hasTimeout()

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.

.google.protobuf.Duration timeout = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the timeout field is set.