com.google.api.services.datastore.model.Entity 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://github.com/google/apis-client-generator/
 * (build: 2016-01-08 17:48:37 UTC)
 * on 2016-02-11 at 06:02:36 UTC 
 * Modify at your own risk.
 */

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

/**
 * An entity.
 *
 *  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:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class Entity extends com.google.api.client.json.GenericJson {

  /**
   * The entity's key.
   *
   * An entity must have a key, unless otherwise documented (for example, an entity in
   * Value.entityValue may have no key). An entity's kind is its key's path's last element's kind,
   * or null if it has no key.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Key key;

  /**
   * The entity's properties.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map properties;

  static {
    // hack to force ProGuard to consider Property used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(Property.class);
  }

  /**
   * The entity's key.
   *
   * An entity must have a key, unless otherwise documented (for example, an entity in
   * Value.entityValue may have no key). An entity's kind is its key's path's last element's kind,
   * or null if it has no key.
   * @return value or {@code null} for none
   */
  public Key getKey() {
    return key;
  }

  /**
   * The entity's key.
   *
   * An entity must have a key, unless otherwise documented (for example, an entity in
   * Value.entityValue may have no key). An entity's kind is its key's path's last element's kind,
   * or null if it has no key.
   * @param key key or {@code null} for none
   */
  public Entity setKey(Key key) {
    this.key = key;
    return this;
  }

  /**
   * The entity's properties.
   * @return value or {@code null} for none
   */
  public java.util.Map getProperties() {
    return properties;
  }

  /**
   * The entity's properties.
   * @param properties properties or {@code null} for none
   */
  public Entity setProperties(java.util.Map properties) {
    this.properties = properties;
    return this;
  }

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

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

}