com.google.api.services.datastore.model.KeyPathElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-datastore Show documentation
There is a newer version: v1-rev20241204-2.0.0
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * 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://code.google.com/p/google-apis-client-generator/
 * (build: 2016-04-08 17:16:44 UTC)
 * on 2016-04-27 at 02:41:28 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.datastore.model;

/**
 * A (kind, ID/name) pair used to construct a key path.
 *
 * At most one of name or ID may be set. If either is set, the element is complete. If neither is
 * set, the element is incomplete.
 *
 *  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 Google Cloud Datastore API. For a detailed
 * explanation see:
 * http://code.google.com/p/google-http-java-client/wiki/JSON
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class KeyPathElement extends com.google.api.client.json.GenericJson {

  /**
   * The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not
   * be supported in the future.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long id;

  /**
   * The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not
   * contain more than 500 characters. Cannot be "".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kind;

  /**
   * The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not
   * be more than 500 characters. Cannot be "".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not
   * be supported in the future.
   * @return value or {@code null} for none
   */
  public java.lang.Long getId() {
    return id;
  }

  /**
   * The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not
   * be supported in the future.
   * @param id id or {@code null} for none
   */
  public KeyPathElement setId(java.lang.Long id) {
    this.id = id;
    return this;
  }

  /**
   * The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not
   * contain more than 500 characters. Cannot be "".
   * @return value or {@code null} for none
   */
  public java.lang.String getKind() {
    return kind;
  }

  /**
   * The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not
   * contain more than 500 characters. Cannot be "".
   * @param kind kind or {@code null} for none
   */
  public KeyPathElement setKind(java.lang.String kind) {
    this.kind = kind;
    return this;
  }

  /**
   * The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not
   * be more than 500 characters. Cannot be "".
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not
   * be more than 500 characters. Cannot be "".
   * @param name name or {@code null} for none
   */
  public KeyPathElement setName(java.lang.String name) {
    this.name = name;
    return this;
  }

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

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

}