public final class Key extends GeneratedMessageV3 implements KeyOrBuilder
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
Static Fields
PARTITION_ID_FIELD_NUMBER
public static final int PARTITION_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Key getDefaultInstance()
| Returns |
|---|
| Type | Description |
Key | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Key.Builder newBuilder()
newBuilder(Key prototype)
public static Key.Builder newBuilder(Key prototype)
| Parameter |
|---|
| Name | Description |
prototype | Key
|
public static Key parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(byte[] data)
public static Key parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(ByteString data)
public static Key parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(ByteBuffer data)
public static Key parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
parser()
public static Parser<Key> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public Key getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Key | |
getParserForType()
public Parser<Key> getParserForType()
Overrides
getPartitionId()
public PartitionId getPartitionId()
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()
public PartitionIdOrBuilder getPartitionIdOrBuilder()
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)
public Key.PathElement getPath(int index)
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()
public 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()
public List<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)
public Key.PathElementOrBuilder getPathOrBuilder(int index)
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()
public List<? extends Key.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()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasPartitionId()
public boolean hasPartitionId()
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()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Key.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Key.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Key.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
