publicfinalclass KeyextendsGeneratedMessageV3implementsKeyOrBuilder
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.
Protobuf type google.datastore.v1.Key
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
PARTITION_ID_FIELD_NUMBER
publicstaticfinalintPARTITION_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
PATH_FIELD_NUMBER
publicstaticfinalintPATH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticKeygetDefaultInstance()
| Returns |
| Type |
Description |
Key |
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticKey.BuildernewBuilder()
newBuilder(Key prototype)
publicstaticKey.BuildernewBuilder(Keyprototype)
| Parameter |
| Name |
Description |
prototype |
Key
|
publicstaticKeyparseDelimitedFrom(InputStreaminput)
| Returns |
| Type |
Description |
Key |
publicstaticKeyparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Key |
parseFrom(byte[] data)
publicstaticKeyparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Key |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticKeyparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Key |
parseFrom(ByteString data)
publicstaticKeyparseFrom(ByteStringdata)
| Returns |
| Type |
Description |
Key |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticKeyparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Key |
publicstaticKeyparseFrom(CodedInputStreaminput)
| Returns |
| Type |
Description |
Key |
publicstaticKeyparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Key |
publicstaticKeyparseFrom(InputStreaminput)
| Returns |
| Type |
Description |
Key |
publicstaticKeyparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Key |
parseFrom(ByteBuffer data)
publicstaticKeyparseFrom(ByteBufferdata)
| Returns |
| Type |
Description |
Key |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticKeyparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Key |
parser()
publicstaticParser<Key>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
publicKeygetDefaultInstanceForType()
| Returns |
| Type |
Description |
Key |
getParserForType()
publicParser<Key>getParserForType()
Overrides
getPartitionId()
publicPartitionIdgetPartitionId()
Entities are partitioned into subsets, currently identified by a project
ID and namespace ID.
Queries are scoped to a single partition.
.google.datastore.v1.PartitionId partition_id = 1;
getPartitionIdOrBuilder()
publicPartitionIdOrBuildergetPartitionIdOrBuilder()
Entities are partitioned into subsets, currently identified by a project
ID and namespace ID.
Queries are scoped to a single partition.
.google.datastore.v1.PartitionId partition_id = 1;
getPath(int index)
publicKey.PathElementgetPath(intindex)
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 root entity, the second element identifies
a child of the root entity, the third element identifies a child of the
second entity, and so forth. The entities identified by all prefixes of
the path are called the element's ancestors.
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. For example,
the last path element of the key of Mutation.insert may have no
identifier.
A path can never be empty, and a path can have at most 100 elements.
repeated .google.datastore.v1.Key.PathElement path = 2;
| Parameter |
| Name |
Description |
index |
int
|
getPathCount()
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 root entity, the second element identifies
a child of the root entity, the third element identifies a child of the
second entity, and so forth. The entities identified by all prefixes of
the path are called the element's ancestors.
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. For example,
the last path element of the key of Mutation.insert may have no
identifier.
A path can never be empty, and a path can have at most 100 elements.
repeated .google.datastore.v1.Key.PathElement path = 2;
| Returns |
| Type |
Description |
int |
getPathList()
publicList<Key.PathElement>getPathList()
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 root entity, the second element identifies
a child of the root entity, the third element identifies a child of the
second entity, and so forth. The entities identified by all prefixes of
the path are called the element's ancestors.
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. For example,
the last path element of the key of Mutation.insert may have no
identifier.
A path can never be empty, and a path can have at most 100 elements.
repeated .google.datastore.v1.Key.PathElement path = 2;
getPathOrBuilder(int index)
publicKey.PathElementOrBuildergetPathOrBuilder(intindex)
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 root entity, the second element identifies
a child of the root entity, the third element identifies a child of the
second entity, and so forth. The entities identified by all prefixes of
the path are called the element's ancestors.
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. For example,
the last path element of the key of Mutation.insert may have no
identifier.
A path can never be empty, and a path can have at most 100 elements.
repeated .google.datastore.v1.Key.PathElement path = 2;
| Parameter |
| Name |
Description |
index |
int
|
getPathOrBuilderList()
publicList<?extendsKey.PathElementOrBuilder>getPathOrBuilderList()
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 root entity, the second element identifies
a child of the root entity, the third element identifies a child of the
second entity, and so forth. The entities identified by all prefixes of
the path are called the element's ancestors.
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. For example,
the last path element of the key of Mutation.insert may have no
identifier.
A path can never be empty, and a path can have at most 100 elements.
repeated .google.datastore.v1.Key.PathElement path = 2;
| Returns |
| Type |
Description |
List<? extends com.google.datastore.v1.Key.PathElementOrBuilder> |
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
hasPartitionId()
publicbooleanhasPartitionId()
Entities are partitioned into subsets, currently identified by a project
ID and namespace ID.
Queries are scoped to a single partition.
.google.datastore.v1.PartitionId partition_id = 1;
| Returns |
| Type |
Description |
boolean |
Whether the partitionId field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicKey.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedKey.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicKey.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides