com.google.api.services.datastore

Class DatastoreV1.Key

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.api.services.datastore.DatastoreV1.Key

All Implemented Interfaces:

DatastoreV1.KeyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

DatastoreV1

public static final class DatastoreV1.Key
extends com.google.protobuf.GeneratedMessage
implements DatastoreV1.KeyOrBuilder

Protobuf type api.services.datastore.Key

 A unique identifier for an entity.
 If a key's partition id or any of its path kinds or names are
 reserved/read-only, the key is reserved/read-only.
 A reserved/read-only key is forbidden in certain documented contexts.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatastoreV1.Key.Builder Protobuf type api.services.datastore.Key
static class	DatastoreV1.Key.PathElement Protobuf type api.services.datastore.Key.PathElement
static interface	DatastoreV1.Key.PathElementOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.protobuf.Parser<DatastoreV1.Key>	PARSER
static int	PARTITION_ID_FIELD_NUMBER
static int	PATH_ELEMENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders

Method Summary

Modifier and Type	Method and Description
static DatastoreV1.Key	getDefaultInstance()
DatastoreV1.Key	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<DatastoreV1.Key>	getParserForType()
DatastoreV1.PartitionId	getPartitionId() optional .api.services.datastore.PartitionId partition_id = 1;
DatastoreV1.PartitionIdOrBuilder	getPartitionIdOrBuilder() optional .api.services.datastore.PartitionId partition_id = 1;
DatastoreV1.Key.PathElement	getPathElement(int index) repeated .api.services.datastore.Key.PathElement path_element = 2;
int	getPathElementCount() repeated .api.services.datastore.Key.PathElement path_element = 2;
List<DatastoreV1.Key.PathElement>	getPathElementList() repeated .api.services.datastore.Key.PathElement path_element = 2;
DatastoreV1.Key.PathElementOrBuilder	getPathElementOrBuilder(int index) repeated .api.services.datastore.Key.PathElement path_element = 2;
List<? extends DatastoreV1.Key.PathElementOrBuilder>	getPathElementOrBuilderList() repeated .api.services.datastore.Key.PathElement path_element = 2;
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasPartitionId() optional .api.services.datastore.PartitionId partition_id = 1;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DatastoreV1.Key.Builder	newBuilder()
static DatastoreV1.Key.Builder	newBuilder(DatastoreV1.Key prototype)
DatastoreV1.Key.Builder	newBuilderForType()
protected DatastoreV1.Key.Builder	newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
static DatastoreV1.Key	parseDelimitedFrom(InputStream input)
static DatastoreV1.Key	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DatastoreV1.Key	parseFrom(byte[] data)
static DatastoreV1.Key	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DatastoreV1.Key	parseFrom(com.google.protobuf.ByteString data)
static DatastoreV1.Key	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DatastoreV1.Key	parseFrom(com.google.protobuf.CodedInputStream input)
static DatastoreV1.Key	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DatastoreV1.Key	parseFrom(InputStream input)
static DatastoreV1.Key	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
DatastoreV1.Key.Builder	toBuilder()
protected Object	writeReplace()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getRepeatedField, getRepeatedFieldCount, hasField, makeExtensionsImmutable, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashBoolean, hashCode, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getRepeatedField, getRepeatedFieldCount, hasField

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARSER

public static com.google.protobuf.Parser<DatastoreV1.Key> PARSER

PARTITION_ID_FIELD_NUMBER

public static final int PARTITION_ID_FIELD_NUMBER

See Also:

Constant Field Values

PATH_ELEMENT_FIELD_NUMBER

public static final int PATH_ELEMENT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDefaultInstance

public static DatastoreV1.Key getDefaultInstance()

getDefaultInstanceForType

public DatastoreV1.Key getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessage

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getParserForType

public com.google.protobuf.Parser<DatastoreV1.Key> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

hasPartitionId

public boolean hasPartitionId()

optional .api.services.datastore.PartitionId partition_id = 1;

 Entities are partitioned into subsets, currently identified by a dataset
 (usually implicitly specified by the project) and namespace ID.
 Queries are scoped to a single partition.
 

Specified by:

hasPartitionId in interface DatastoreV1.KeyOrBuilder

getPartitionId

public DatastoreV1.PartitionId getPartitionId()

optional .api.services.datastore.PartitionId partition_id = 1;

 Entities are partitioned into subsets, currently identified by a dataset
 (usually implicitly specified by the project) and namespace ID.
 Queries are scoped to a single partition.
 

Specified by:

getPartitionId in interface DatastoreV1.KeyOrBuilder

getPartitionIdOrBuilder

public DatastoreV1.PartitionIdOrBuilder getPartitionIdOrBuilder()

optional .api.services.datastore.PartitionId partition_id = 1;

 Entities are partitioned into subsets, currently identified by a dataset
 (usually implicitly specified by the project) and namespace ID.
 Queries are scoped to a single partition.
 

Specified by:

getPartitionIdOrBuilder in interface DatastoreV1.KeyOrBuilder

getPathElementList

public List<DatastoreV1.Key.PathElement> getPathElementList()

repeated .api.services.datastore.Key.PathElement path_element = 2;

 The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a <em>root entity</em>, the second element identifies
 a <em>child</em> of the root entity, the third element a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's <em>ancestors</em>.
 An entity path is always fully complete: ALL of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. A path can never
 be empty. The path can have at most 100 elements.
 

Specified by:

getPathElementList in interface DatastoreV1.KeyOrBuilder

getPathElementOrBuilderList

public List<? extends DatastoreV1.Key.PathElementOrBuilder> getPathElementOrBuilderList()

repeated .api.services.datastore.Key.PathElement path_element = 2;

 The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a <em>root entity</em>, the second element identifies
 a <em>child</em> of the root entity, the third element a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's <em>ancestors</em>.
 An entity path is always fully complete: ALL of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. A path can never
 be empty. The path can have at most 100 elements.
 

Specified by:

getPathElementOrBuilderList in interface DatastoreV1.KeyOrBuilder

getPathElementCount

public int getPathElementCount()

repeated .api.services.datastore.Key.PathElement path_element = 2;

 The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a <em>root entity</em>, the second element identifies
 a <em>child</em> of the root entity, the third element a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's <em>ancestors</em>.
 An entity path is always fully complete: ALL of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. A path can never
 be empty. The path can have at most 100 elements.
 

Specified by:

getPathElementCount in interface DatastoreV1.KeyOrBuilder

getPathElement

public DatastoreV1.Key.PathElement getPathElement(int index)

repeated .api.services.datastore.Key.PathElement path_element = 2;

 The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a <em>root entity</em>, the second element identifies
 a <em>child</em> of the root entity, the third element a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's <em>ancestors</em>.
 An entity path is always fully complete: ALL of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. A path can never
 be empty. The path can have at most 100 elements.
 

Specified by:

getPathElement in interface DatastoreV1.KeyOrBuilder

getPathElementOrBuilder

public DatastoreV1.Key.PathElementOrBuilder getPathElementOrBuilder(int index)

repeated .api.services.datastore.Key.PathElement path_element = 2;

 The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a <em>root entity</em>, the second element identifies
 a <em>child</em> of the root entity, the third element a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's <em>ancestors</em>.
 An entity path is always fully complete: ALL of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. A path can never
 be empty. The path can have at most 100 elements.
 

Specified by:

getPathElementOrBuilder in interface DatastoreV1.KeyOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.AbstractMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.AbstractMessage

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Overrides:

writeReplace in class com.google.protobuf.GeneratedMessage

Throws:

ObjectStreamException

parseFrom

public static DatastoreV1.Key parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DatastoreV1.Key parseFrom(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DatastoreV1.Key parseFrom(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DatastoreV1.Key parseFrom(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DatastoreV1.Key parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static DatastoreV1.Key parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static DatastoreV1.Key parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static DatastoreV1.Key parseDelimitedFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static DatastoreV1.Key parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static DatastoreV1.Key parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilder

public static DatastoreV1.Key.Builder newBuilder()

newBuilderForType

public DatastoreV1.Key.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DatastoreV1.Key.Builder newBuilder(DatastoreV1.Key prototype)

toBuilder

public DatastoreV1.Key.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DatastoreV1.Key.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage