com.google.api.services.cloudasset.v1.model.QueryResult Maven / Gradle / Ivy

Go to download
/*
 * 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;

/**
 * Execution results of the query. The result is formatted as rows represented by BigQuery
 * compatible [schema]. When pagination is necessary, it will contains the page token to retrieve
 * the results of following pages.
 *
 *  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 QueryResult extends com.google.api.client.json.GenericJson {

  /**
   * Token to retrieve the next page of the results.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String nextPageToken;

  /**
   * Each row hold a query result in the format of `Struct`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List> rows;

  /**
   * Describes the format of the [rows].
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TableSchema schema;

  /**
   * Total rows of the whole query results.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long totalRows;

  /**
   * Token to retrieve the next page of the results.
   * @return value or {@code null} for none
   */
  public java.lang.String getNextPageToken() {
    return nextPageToken;
  }

  /**
   * Token to retrieve the next page of the results.
   * @param nextPageToken nextPageToken or {@code null} for none
   */
  public QueryResult setNextPageToken(java.lang.String nextPageToken) {
    this.nextPageToken = nextPageToken;
    return this;
  }

  /**
   * Each row hold a query result in the format of `Struct`.
   * @return value or {@code null} for none
   */
  public java.util.List> getRows() {
    return rows;
  }

  /**
   * Each row hold a query result in the format of `Struct`.
   * @param rows rows or {@code null} for none
   */
  public QueryResult setRows(java.util.List> rows) {
    this.rows = rows;
    return this;
  }

  /**
   * Describes the format of the [rows].
   * @return value or {@code null} for none
   */
  public TableSchema getSchema() {
    return schema;
  }

  /**
   * Describes the format of the [rows].
   * @param schema schema or {@code null} for none
   */
  public QueryResult setSchema(TableSchema schema) {
    this.schema = schema;
    return this;
  }

  /**
   * Total rows of the whole query results.
   * @return value or {@code null} for none
   */
  public java.lang.Long getTotalRows() {
    return totalRows;
  }

  /**
   * Total rows of the whole query results.
   * @param totalRows totalRows or {@code null} for none
   */
  public QueryResult setTotalRows(java.lang.Long totalRows) {
    this.totalRows = totalRows;
    return this;
  }

  @Override
  public QueryResult set(String fieldName, Object value) {
    return (QueryResult) super.set(fieldName, value);
  }

  @Override
  public QueryResult clone() {
    return (QueryResult) super.clone();
  }

}