public static final class Key.PathElement extends GeneratedMessageV3 implements Key.PathElementOrBuilderA (kind, ID/name) pair used to construct a key path.
If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
Protobuf type google.datastore.v1.Key.PathElement
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Key.PathElementImplements
Key.PathElementOrBuilderStatic Fields
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Key.PathElement getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Key.PathElement.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
newBuilder(Key.PathElement prototype)
public static Key.PathElement.Builder newBuilder(Key.PathElement prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Key.PathElement |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
parseDelimitedFrom(InputStream input)
public static Key.PathElement parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Key.PathElement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Key.PathElement parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Key.PathElement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Key.PathElement parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Key.PathElement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Key.PathElement parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Key.PathElement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Key.PathElement parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Key.PathElement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Key.PathElement parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Key.PathElement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Key.PathElement> parser()| Returns | |
|---|---|
| Type | Description |
Parser<PathElement> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public Key.PathElement getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
getId()
public long getId()The auto-allocated ID of the entity.
Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
int64 id = 2;
| Returns | |
|---|---|
| Type | Description |
long |
The id. |
getIdTypeCase()
public Key.PathElement.IdTypeCase getIdTypeCase()| Returns | |
|---|---|
| Type | Description |
Key.PathElement.IdTypeCase |
|
getKind()
public String getKind()The kind of the entity.
A kind matching regex .* is reserved/read-only.
A kind must not contain more than 1500 bytes when UTF-8 encoded.
Cannot be "".
Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
encoded as bytes<X> where <X> is the base-64 encoding of the
bytes.
string kind = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The kind. |
getKindBytes()
public ByteString getKindBytes()The kind of the entity.
A kind matching regex .* is reserved/read-only.
A kind must not contain more than 1500 bytes when UTF-8 encoded.
Cannot be "".
Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
encoded as bytes<X> where <X> is the base-64 encoding of the
bytes.
string kind = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for kind. |
getName()
public String getName()The name of the entity.
A name matching regex .* is reserved/read-only.
A name must not be more than 1500 bytes when UTF-8 encoded.
Cannot be "".
Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
encoded as bytes<X> where <X> is the base-64 encoding of the
bytes.
string name = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()The name of the entity.
A name matching regex .* is reserved/read-only.
A name must not be more than 1500 bytes when UTF-8 encoded.
Cannot be "".
Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
encoded as bytes<X> where <X> is the base-64 encoding of the
bytes.
string name = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<Key.PathElement> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<PathElement> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hasId()
public boolean hasId()The auto-allocated ID of the entity.
Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
int64 id = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the id field is set. |
hasName()
public boolean hasName()The name of the entity.
A name matching regex .* is reserved/read-only.
A name must not be more than 1500 bytes when UTF-8 encoded.
Cannot be "".
Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
encoded as bytes<X> where <X> is the base-64 encoding of the
bytes.
string name = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the name field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Key.PathElement.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Key.PathElement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Key.PathElement.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|