public static final class Key.PathElement.Builder extends GeneratedMessageV3.Builder<Key.PathElement.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Key.PathElement.BuilderImplements
Key.PathElementOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Key.PathElement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
build()
public Key.PathElement build()| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
buildPartial()
public Key.PathElement buildPartial()| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
clear()
public Key.PathElement.Builder clear()| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Key.PathElement.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
clearId()
public Key.PathElement.Builder clearId()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 |
Key.PathElement.Builder |
This builder for chaining. |
clearIdType()
public Key.PathElement.Builder clearIdType()| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
clearKind()
public Key.PathElement.Builder clearKind()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 |
Key.PathElement.Builder |
This builder for chaining. |
clearName()
public Key.PathElement.Builder clearName()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 |
Key.PathElement.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Key.PathElement.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
clone()
public Key.PathElement.Builder clone()| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
getDefaultInstanceForType()
public Key.PathElement getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Key.PathElement |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Key.PathElement other)
public Key.PathElement.Builder mergeFrom(Key.PathElement other)| Parameter | |
|---|---|
| Name | Description |
other |
Key.PathElement |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Key.PathElement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Key.PathElement.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Key.PathElement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Key.PathElement.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
setId(long value)
public Key.PathElement.Builder setId(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe id to set. |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
This builder for chaining. |
setKind(String value)
public Key.PathElement.Builder setKind(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe kind to set. |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
This builder for chaining. |
setKindBytes(ByteString value)
public Key.PathElement.Builder setKindBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for kind to set. |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
This builder for chaining. |
setName(String value)
public Key.PathElement.Builder setName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Key.PathElement.Builder setNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Key.PathElement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Key.PathElement.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Key.PathElement.Builder |
|