com.google.api.services.spanner.v1.model.Field 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-rev20241020-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;

/**
 * Message representing a single field of a struct.
 *
 *  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 Field extends com.google.api.client.json.GenericJson {

  /**
   * The name of the field. For reads, this is the column name. For SQL queries, it is the column
   * alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g.,
   * `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name
   * (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with
   * the same name.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The type of the field.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Type type;

  /**
   * The name of the field. For reads, this is the column name. For SQL queries, it is the column
   * alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g.,
   * `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name
   * (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with
   * the same name.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The name of the field. For reads, this is the column name. For SQL queries, it is the column
   * alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g.,
   * `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name
   * (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with
   * the same name.
   * @param name name or {@code null} for none
   */
  public Field setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * The type of the field.
   * @return value or {@code null} for none
   */
  public Type getType() {
    return type;
  }

  /**
   * The type of the field.
   * @param type type or {@code null} for none
   */
  public Field setType(Type type) {
    this.type = type;
    return this;
  }

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

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

}