Package com.google.cloud.asset.v1

Class QueryAssetsRequest

  • All Implemented Interfaces:
    QueryAssetsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class QueryAssetsRequest
extends com.google.protobuf.GeneratedMessageV3
implements QueryAssetsRequestOrBuilder
     QueryAssets request.
    Protobuf type google.cloud.asset.v1.QueryAssetsRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface QueryAssetsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface QueryAssetsRequestOrBuilder
        Returns:
        The bytes for parent.

      • hasStatement

        public 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];
        Specified by:
        hasStatement in interface QueryAssetsRequestOrBuilder
        Returns:
        Whether the statement field is set.

      • getStatement

        public 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];
        Specified by:
        getStatement in interface QueryAssetsRequestOrBuilder
        Returns:
        The statement.

      • getStatementBytes

        public 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];
        Specified by:
        getStatementBytes in interface QueryAssetsRequestOrBuilder
        Returns:
        The bytes for statement.

      • hasJobReference

        public 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];
        Specified by:
        hasJobReference in interface QueryAssetsRequestOrBuilder
        Returns:
        Whether the jobReference field is set.

      • getJobReference

        public 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];
        Specified by:
        getJobReference in interface QueryAssetsRequestOrBuilder
        Returns:
        The jobReference.

      • getJobReferenceBytes

        public 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];
        Specified by:
        getJobReferenceBytes in interface QueryAssetsRequestOrBuilder
        Returns:
        The bytes for jobReference.

      • getPageSize

        public 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];
        Specified by:
        getPageSize in interface QueryAssetsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public 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];
        Specified by:
        getPageToken in interface QueryAssetsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public 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];
        Specified by:
        getPageTokenBytes in interface QueryAssetsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • hasTimeout

        public 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];
        Specified by:
        hasTimeout in interface QueryAssetsRequestOrBuilder
        Returns:
        Whether the timeout field is set.

      • getTimeout

        public 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];
        Specified by:
        getTimeout in interface QueryAssetsRequestOrBuilder
        Returns:
        The timeout.

      • getTimeoutOrBuilder

        public 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];
        Specified by:
        getTimeoutOrBuilder in interface QueryAssetsRequestOrBuilder

      • hasReadTimeWindow

        public 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];
        Specified by:
        hasReadTimeWindow in interface QueryAssetsRequestOrBuilder
        Returns:
        Whether the readTimeWindow field is set.

      • getReadTimeWindow

        public 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];
        Specified by:
        getReadTimeWindow in interface QueryAssetsRequestOrBuilder
        Returns:
        The readTimeWindow.

      • getReadTimeWindowOrBuilder

        public 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];
        Specified by:
        getReadTimeWindowOrBuilder in interface QueryAssetsRequestOrBuilder

      • hasReadTime

        public 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];
        Specified by:
        hasReadTime in interface QueryAssetsRequestOrBuilder
        Returns:
        Whether the readTime field is set.

      • getReadTime

        public 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];
        Specified by:
        getReadTime in interface QueryAssetsRequestOrBuilder
        Returns:
        The readTime.

      • getReadTimeOrBuilder

        public 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];
        Specified by:
        getReadTimeOrBuilder in interface QueryAssetsRequestOrBuilder

      • hasOutputConfig

        public 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];
        Specified by:
        hasOutputConfig in interface QueryAssetsRequestOrBuilder
        Returns:
        Whether the outputConfig field is set.

      • getOutputConfig

        public 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];
        Specified by:
        getOutputConfig in interface QueryAssetsRequestOrBuilder
        Returns:
        The outputConfig.

      • getOutputConfigOrBuilder

        public 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];
        Specified by:
        getOutputConfigOrBuilder in interface QueryAssetsRequestOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static QueryAssetsRequest parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryAssetsRequest parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryAssetsRequest parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryAssetsRequest parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryAssetsRequest parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryAssetsRequest parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryAssetsRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public QueryAssetsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public QueryAssetsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected QueryAssetsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<QueryAssetsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public QueryAssetsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder