com.google.api.services.spanner.v1.model.ResultSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-spanner Show documentation
There is a newer version: v1-rev20241119-2.0.0
Show 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.spanner.v1.model;

/**
 * Results from Read or ExecuteSql.
 *
 *  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 Spanner 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 ResultSet extends com.google.api.client.json.GenericJson {

  /**
   * Metadata about the result set, such as row type information.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ResultSetMetadata metadata;

  /**
   * Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element
   * in each row matches the ith field in metadata.row_type. Elements are encoded based on type as
   * described here.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List> rows;

  /**
   * Query plan and execution statistics for the SQL statement that produced this result set. These
   * can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats
   * containing the number of rows modified, unless executed using the
   * ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be
   * populated, based on the ExecuteSqlRequest.query_mode.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ResultSetStats stats;

  /**
   * Metadata about the result set, such as row type information.
   * @return value or {@code null} for none
   */
  public ResultSetMetadata getMetadata() {
    return metadata;
  }

  /**
   * Metadata about the result set, such as row type information.
   * @param metadata metadata or {@code null} for none
   */
  public ResultSet setMetadata(ResultSetMetadata metadata) {
    this.metadata = metadata;
    return this;
  }

  /**
   * Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element
   * in each row matches the ith field in metadata.row_type. Elements are encoded based on type as
   * described here.
   * @return value or {@code null} for none
   */
  public java.util.List> getRows() {
    return rows;
  }

  /**
   * Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element
   * in each row matches the ith field in metadata.row_type. Elements are encoded based on type as
   * described here.
   * @param rows rows or {@code null} for none
   */
  public ResultSet setRows(java.util.List> rows) {
    this.rows = rows;
    return this;
  }

  /**
   * Query plan and execution statistics for the SQL statement that produced this result set. These
   * can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats
   * containing the number of rows modified, unless executed using the
   * ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be
   * populated, based on the ExecuteSqlRequest.query_mode.
   * @return value or {@code null} for none
   */
  public ResultSetStats getStats() {
    return stats;
  }

  /**
   * Query plan and execution statistics for the SQL statement that produced this result set. These
   * can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats
   * containing the number of rows modified, unless executed using the
   * ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be
   * populated, based on the ExecuteSqlRequest.query_mode.
   * @param stats stats or {@code null} for none
   */
  public ResultSet setStats(ResultSetStats stats) {
    this.stats = stats;
    return this;
  }

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

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

}