com.google.cloud.datastore

Class Key

java.lang.Object

com.google.cloud.datastore.BaseKey

com.google.cloud.datastore.IncompleteKey

com.google.cloud.datastore.Key

All Implemented Interfaces:

Serializable

public final class Key
extends IncompleteKey

A key that is guaranteed to be complete and could be used to reference a Google Cloud Datastore Entity. This class is immutable.

See Also:

Google Cloud Datastore Entities, Properties, and Keys, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Key.Builder

Method Summary

Methods

Modifier and Type	Method and Description
static Key.Builder	builder(IncompleteKey copyFrom, long id)
static Key.Builder	builder(IncompleteKey copyFrom, String name)
static Key.Builder	builder(Key copyFrom)
static Key.Builder	builder(Key parent, String kind, long id)
static Key.Builder	builder(Key parent, String kind, String name)
static Key.Builder	builder(String projectId, String kind, long id)
static Key.Builder	builder(String projectId, String kind, String name)
static Key	fromUrlSafe(String urlSafe) Create a Key given its URL safe encoded form.
boolean	hasId()
boolean	hasName()
Long	id() Returns the key's id or null if it has a name instead.
String	name() Returns the key's name or null if it has an id instead.
Object	nameOrId() Returns the key's id (as Long) or name (as String).
String	toUrlSafe() Returns the key in an encoded form that can be used as part of a URL.

Methods inherited from class com.google.cloud.datastore.IncompleteKey

builder, builder, builder, parent

Methods inherited from class com.google.cloud.datastore.BaseKey

ancestors, equals, hashCode, kind, namespace, projectId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

hasId

public boolean hasId()

id

public Long id()

Returns the key's id or null if it has a name instead.

hasName

public boolean hasName()

name

public String name()

Returns the key's name or null if it has an id instead.

nameOrId

public Object nameOrId()

Returns the key's id (as Long) or name (as String). Never null.

toUrlSafe

public String toUrlSafe()

Returns the key in an encoded form that can be used as part of a URL.

fromUrlSafe

public static Key fromUrlSafe(String urlSafe)

Create a Key given its URL safe encoded form.

Throws:

IllegalArgumentException - when decoding fails

builder

public static Key.Builder builder(String projectId,
                  String kind,
                  String name)

builder

public static Key.Builder builder(String projectId,
                  String kind,
                  long id)

builder

public static Key.Builder builder(Key copyFrom)

builder

public static Key.Builder builder(IncompleteKey copyFrom,
                  String name)

builder

public static Key.Builder builder(IncompleteKey copyFrom,
                  long id)

builder

public static Key.Builder builder(Key parent,
                  String kind,
                  String name)

builder

public static Key.Builder builder(Key parent,
                  String kind,
                  long id)