public final class QueryAssetsRequest extends GeneratedMessageV3 implements QueryAssetsRequestOrBuilder
QueryAssets request.
Protobuf type google.cloud.asset.v1.QueryAssetsRequest
Static Fields
JOB_REFERENCE_FIELD_NUMBER
public static final int JOB_REFERENCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OUTPUT_CONFIG_FIELD_NUMBER
public static final int OUTPUT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
READ_TIME_WINDOW_FIELD_NUMBER
public static final int READ_TIME_WINDOW_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATEMENT_FIELD_NUMBER
public static final int STATEMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static QueryAssetsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static QueryAssetsRequest.Builder newBuilder()
newBuilder(QueryAssetsRequest prototype)
public static QueryAssetsRequest.Builder newBuilder(QueryAssetsRequest prototype)
public static QueryAssetsRequest parseDelimitedFrom(InputStream input)
public static QueryAssetsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static QueryAssetsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryAssetsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static QueryAssetsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryAssetsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryAssetsRequest parseFrom(CodedInputStream input)
public static QueryAssetsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryAssetsRequest parseFrom(InputStream input)
public static QueryAssetsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static QueryAssetsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QueryAssetsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<QueryAssetsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public QueryAssetsRequest getDefaultInstanceForType()
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];
| Returns |
| Type |
Description |
String |
The jobReference.
|
getJobReferenceBytes()
public 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 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];
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];
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 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 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 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 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.
|
getParserForType()
public Parser<QueryAssetsRequest> getParserForType()
Overrides
getQueryCase()
public QueryAssetsRequest.QueryCase getQueryCase()
getReadTime()
public 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 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];
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];
| Returns |
| Type |
Description |
TimeWindow |
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStatement()
public String getStatement()
Optional. A SQL statement that's compatible with BigQuery Standard
SQL.
string statement = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The statement.
|
getStatementBytes()
public ByteString getStatementBytes()
Optional. A SQL statement that's compatible with BigQuery Standard
SQL.
string statement = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for statement.
|
getTimeCase()
public QueryAssetsRequest.TimeCase getTimeCase()
getTimeout()
public 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 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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];
| Returns |
| Type |
Description |
boolean |
Whether the jobReference field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the outputConfig field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the readTime field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the readTimeWindow field is set.
|
hasStatement()
public boolean hasStatement()
Optional. A SQL statement that's compatible with BigQuery Standard
SQL.
string statement = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the statement field is set.
|
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
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public QueryAssetsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QueryAssetsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public QueryAssetsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
