Package com.google.cloud.asset.v1

Interface QueryAssetsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    QueryAssetsRequest, QueryAssetsRequest.Builder
    public interface QueryAssetsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getParent

        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:
        The parent.

      • getParentBytes

        com.google.protobuf.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:
        The bytes for parent.

      • hasStatement

        boolean hasStatement()
         Optional. A SQL statement that's compatible with [BigQuery Standard
 SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).
        string statement = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the statement field is set.

      • getStatement

        String getStatement()
         Optional. A SQL statement that's compatible with [BigQuery Standard
 SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).
        string statement = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The statement.

      • getStatementBytes

        com.google.protobuf.ByteString getStatementBytes()
         Optional. A SQL statement that's compatible with [BigQuery Standard
 SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).
        string statement = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for statement.

      • hasJobReference

        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:
        Whether the jobReference field is set.

      • getJobReference

        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:
        The jobReference.

      • getJobReferenceBytes

        com.google.protobuf.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:
        The bytes for jobReference.

      • getPageSize

        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:
        The pageSize.

      • getPageToken

        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:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.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:
        The bytes for pageToken.

      • hasTimeout

        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](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#queryrequest)
 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:
        Whether the timeout field is set.

      • getTimeout

        com.google.protobuf.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](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#queryrequest)
 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:
        The timeout.

      • getTimeoutOrBuilder

        com.google.protobuf.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](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#queryrequest)
 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];

      • hasReadTimeWindow

        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:
        Whether the readTimeWindow field is set.

      • getReadTimeWindow

        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:
        The readTimeWindow.

      • getReadTimeWindowOrBuilder

        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];

      • hasReadTime

        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:
        Whether the readTime field is set.

      • getReadTime

        com.google.protobuf.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:
        The readTime.

      • getReadTimeOrBuilder

        com.google.protobuf.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];

      • hasOutputConfig

        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:
        Whether the outputConfig field is set.

      • getOutputConfig

        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:
        The outputConfig.

      • getOutputConfigOrBuilder

        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];