public final class Document extends GeneratedMessageV3 implements DocumentOrBuilder
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
Protobuf type google.firestore.v1.Document
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentImplements
DocumentOrBuilderInherited Members
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static Document getDefaultInstance()
Returns | |
---|---|
Type | Description |
Document |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static Document.Builder newBuilder()
Returns | |
---|---|
Type | Description |
Document.Builder |
newBuilder(Document prototype)
public static Document.Builder newBuilder(Document prototype)
Parameter | |
---|---|
Name | Description |
prototype |
Document |
Returns | |
---|---|
Type | Description |
Document.Builder |
parseDelimitedFrom(InputStream input)
public static Document parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static Document parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Document parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Document parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static Document parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Document parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Document |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Document> parser()
Methods
containsFields(String key)
public boolean containsFields(String key)
The document's fields.
The map keys represent field names.
Field names matching the regular expression .*
are reserved. Reserved
field names are forbidden except in certain documented contexts. The field
names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
empty.
Field paths may be used in other contexts to refer to structured fields
defined here. For map_value
, the field path is represented by a
dot-delimited (.
) string of segments. Each segment is either a simple
field name (defined below) or a quoted field name. For example, the
structured field "foo" : { map_value: { "x&y" : { string_value: "hello"
}}}
would be represented by the field path foo.
x&y
.
A simple field name contains only characters
a to
z,
A to
Z,
0 to
9, or
_, and must not start with
0 to
9. For example,
foo_bar_17.
A quoted field name starts and ends with
and
may contain any character. Some characters, including
, must be
escaped using a
\. For example,
x&y
represents
x&y and
bak\tik
represents
bak
tik ``.
map<string, .google.firestore.v1.Value> fields = 2;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which the document was created.
This value increases monotonically when a document is deleted then
recreated. It can also be compared to values from other documents and
the read_time
of a query.
.google.protobuf.Timestamp create_time = 3;
Returns | |
---|---|
Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which the document was created.
This value increases monotonically when a document is deleted then
recreated. It can also be compared to values from other documents and
the read_time
of a query.
.google.protobuf.Timestamp create_time = 3;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public Document getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Document |
getFields() (deprecated)
public Map<String,Value> getFields()
Use #getFieldsMap() instead.
getFieldsCount()
public int getFieldsCount()
The document's fields.
The map keys represent field names.
Field names matching the regular expression .*
are reserved. Reserved
field names are forbidden except in certain documented contexts. The field
names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
empty.
Field paths may be used in other contexts to refer to structured fields
defined here. For map_value
, the field path is represented by a
dot-delimited (.
) string of segments. Each segment is either a simple
field name (defined below) or a quoted field name. For example, the
structured field "foo" : { map_value: { "x&y" : { string_value: "hello"
}}}
would be represented by the field path foo.
x&y
.
A simple field name contains only characters
a to
z,
A to
Z,
0 to
9, or
_, and must not start with
0 to
9. For example,
foo_bar_17.
A quoted field name starts and ends with
and
may contain any character. Some characters, including
, must be
escaped using a
\. For example,
x&y
represents
x&y and
bak\tik
represents
bak
tik ``.
map<string, .google.firestore.v1.Value> fields = 2;
Returns | |
---|---|
Type | Description |
int |
getFieldsMap()
public Map<String,Value> getFieldsMap()
The document's fields.
The map keys represent field names.
Field names matching the regular expression .*
are reserved. Reserved
field names are forbidden except in certain documented contexts. The field
names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
empty.
Field paths may be used in other contexts to refer to structured fields
defined here. For map_value
, the field path is represented by a
dot-delimited (.
) string of segments. Each segment is either a simple
field name (defined below) or a quoted field name. For example, the
structured field "foo" : { map_value: { "x&y" : { string_value: "hello"
}}}
would be represented by the field path foo.
x&y
.
A simple field name contains only characters
a to
z,
A to
Z,
0 to
9, or
_, and must not start with
0 to
9. For example,
foo_bar_17.
A quoted field name starts and ends with
and
may contain any character. Some characters, including
, must be
escaped using a
\. For example,
x&y
represents
x&y and
bak\tik
represents
bak
tik ``.
map<string, .google.firestore.v1.Value> fields = 2;
getFieldsOrDefault(String key, Value defaultValue)
public Value getFieldsOrDefault(String key, Value defaultValue)
The document's fields.
The map keys represent field names.
Field names matching the regular expression .*
are reserved. Reserved
field names are forbidden except in certain documented contexts. The field
names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
empty.
Field paths may be used in other contexts to refer to structured fields
defined here. For map_value
, the field path is represented by a
dot-delimited (.
) string of segments. Each segment is either a simple
field name (defined below) or a quoted field name. For example, the
structured field "foo" : { map_value: { "x&y" : { string_value: "hello"
}}}
would be represented by the field path foo.
x&y
.
A simple field name contains only characters
a to
z,
A to
Z,
0 to
9, or
_, and must not start with
0 to
9. For example,
foo_bar_17.
A quoted field name starts and ends with
and
may contain any character. Some characters, including
, must be
escaped using a
\. For example,
x&y
represents
x&y and
bak\tik
represents
bak
tik ``.
map<string, .google.firestore.v1.Value> fields = 2;
Returns | |
---|---|
Type | Description |
Value |
getFieldsOrThrow(String key)
public Value getFieldsOrThrow(String key)
The document's fields.
The map keys represent field names.
Field names matching the regular expression .*
are reserved. Reserved
field names are forbidden except in certain documented contexts. The field
names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
empty.
Field paths may be used in other contexts to refer to structured fields
defined here. For map_value
, the field path is represented by a
dot-delimited (.
) string of segments. Each segment is either a simple
field name (defined below) or a quoted field name. For example, the
structured field "foo" : { map_value: { "x&y" : { string_value: "hello"
}}}
would be represented by the field path foo.
x&y
.
A simple field name contains only characters
a to
z,
A to
Z,
0 to
9, or
_, and must not start with
0 to
9. For example,
foo_bar_17.
A quoted field name starts and ends with
and
may contain any character. Some characters, including
, must be
escaped using a
\. For example,
x&y
represents
x&y and
bak\tik
represents
bak
tik ``.
map<string, .google.firestore.v1.Value> fields = 2;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
Value |
getName()
public String getName()
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
string name = 1;
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
string name = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<Document> getParserForType()
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time at which the document was last changed.
This value is initially set to the create_time
then increases
monotonically with each change to the document. It can also be
compared to values from other documents and the read_time
of a query.
.google.protobuf.Timestamp update_time = 4;
Returns | |
---|---|
Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time at which the document was last changed.
This value is initially set to the create_time
then increases
monotonically with each change to the document. It can also be
compared to values from other documents and the read_time
of a query.
.google.protobuf.Timestamp update_time = 4;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
hasCreateTime()
public boolean hasCreateTime()
Output only. The time at which the document was created.
This value increases monotonically when a document is deleted then
recreated. It can also be compared to values from other documents and
the read_time
of a query.
.google.protobuf.Timestamp create_time = 3;
Returns | |
---|---|
Type | Description |
boolean |
Whether the createTime field is set. |
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The time at which the document was last changed.
This value is initially set to the create_time
then increases
monotonically with each change to the document. It can also be
compared to values from other documents and the read_time
of a query.
.google.protobuf.Timestamp update_time = 4;
Returns | |
---|---|
Type | Description |
boolean |
Whether the updateTime field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public Document.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
Document.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
Document.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public Document.Builder toBuilder()
Returns | |
---|---|
Type | Description |
Document.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |