com.google.api.services.cloudasset.v1.model.QueryAssetsRequest Maven / Gradle / Ivy
The newest version!
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.cloudasset.v1.model;
/**
* QueryAssets request.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Cloud Asset API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class QueryAssetsRequest extends com.google.api.client.json.GenericJson {
/**
* Optional. Reference to the query job, which is from the `QueryAssetsResponse` of previous
* `QueryAssets` call.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String jobReference;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private QueryAssetsOutputConfig outputConfig;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer pageSize;
/**
* Optional. A page token received from previous `QueryAssets`. The field will be ignored when
* [output_config] is specified.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String pageToken;
/**
* Optional. Queries cloud assets as they appeared at the specified point in time.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String readTime;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private TimeWindow readTimeWindow;
/**
* Optional. A SQL statement that's compatible with [BigQuery
* SQL](https://cloud.google.com/bigquery/docs/introduction-sql).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String statement;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String timeout;
/**
* Optional. Reference to the query job, which is from the `QueryAssetsResponse` of previous
* `QueryAssets` call.
* @return value or {@code null} for none
*/
public java.lang.String getJobReference() {
return jobReference;
}
/**
* Optional. Reference to the query job, which is from the `QueryAssetsResponse` of previous
* `QueryAssets` call.
* @param jobReference jobReference or {@code null} for none
*/
public QueryAssetsRequest setJobReference(java.lang.String jobReference) {
this.jobReference = jobReference;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public QueryAssetsOutputConfig getOutputConfig() {
return outputConfig;
}
/**
* 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.
* @param outputConfig outputConfig or {@code null} for none
*/
public QueryAssetsRequest setOutputConfig(QueryAssetsOutputConfig outputConfig) {
this.outputConfig = outputConfig;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.Integer getPageSize() {
return pageSize;
}
/**
* 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.
* @param pageSize pageSize or {@code null} for none
*/
public QueryAssetsRequest setPageSize(java.lang.Integer pageSize) {
this.pageSize = pageSize;
return this;
}
/**
* Optional. A page token received from previous `QueryAssets`. The field will be ignored when
* [output_config] is specified.
* @return value or {@code null} for none
*/
public java.lang.String getPageToken() {
return pageToken;
}
/**
* Optional. A page token received from previous `QueryAssets`. The field will be ignored when
* [output_config] is specified.
* @param pageToken pageToken or {@code null} for none
*/
public QueryAssetsRequest setPageToken(java.lang.String pageToken) {
this.pageToken = pageToken;
return this;
}
/**
* Optional. Queries cloud assets as they appeared at the specified point in time.
* @return value or {@code null} for none
*/
public String getReadTime() {
return readTime;
}
/**
* Optional. Queries cloud assets as they appeared at the specified point in time.
* @param readTime readTime or {@code null} for none
*/
public QueryAssetsRequest setReadTime(String readTime) {
this.readTime = readTime;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public TimeWindow getReadTimeWindow() {
return readTimeWindow;
}
/**
* 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.
* @param readTimeWindow readTimeWindow or {@code null} for none
*/
public QueryAssetsRequest setReadTimeWindow(TimeWindow readTimeWindow) {
this.readTimeWindow = readTimeWindow;
return this;
}
/**
* Optional. A SQL statement that's compatible with [BigQuery
* SQL](https://cloud.google.com/bigquery/docs/introduction-sql).
* @return value or {@code null} for none
*/
public java.lang.String getStatement() {
return statement;
}
/**
* Optional. A SQL statement that's compatible with [BigQuery
* SQL](https://cloud.google.com/bigquery/docs/introduction-sql).
* @param statement statement or {@code null} for none
*/
public QueryAssetsRequest setStatement(java.lang.String statement) {
this.statement = statement;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public String getTimeout() {
return timeout;
}
/**
* 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.
* @param timeout timeout or {@code null} for none
*/
public QueryAssetsRequest setTimeout(String timeout) {
this.timeout = timeout;
return this;
}
@Override
public QueryAssetsRequest set(String fieldName, Object value) {
return (QueryAssetsRequest) super.set(fieldName, value);
}
@Override
public QueryAssetsRequest clone() {
return (QueryAssetsRequest) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy