public final class Document extends GeneratedMessageV3 implements DocumentOrBuilder
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
Protobuf type google.firestore.v1.Document
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Document getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Document.Builder newBuilder()
Returns
newBuilder(Document prototype)
public static Document.Builder newBuilder(Document prototype)
Parameter
Returns
public static Document parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Document parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Document parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Document parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Document parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Document parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Document parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Document parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Document parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Document> parser()
Returns
Methods
containsFields(String key)
public boolean containsFields(String key)
The document's fields.
The map keys represent field names.
A simple field name contains only characters a to z, A to Z,
0 to 9, or 0 to 9. For example,
foo_bar_17.
Field names matching the regular expression _.*__ are reserved. Reserved
field names are forbidden except in certain documented contexts. The map
keys, 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 the simple
or quoted field names of the containing fields, delimited by .. For
example, the structured field
"foo" : { map_value: { "x&y" : { string_value: "hello" }}} would be
represented by the field path foo.x&y.
Within a field path, 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 baktik ``.
map<string, .google.firestore.v1.Value> fields = 2;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
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;
getDefaultInstanceForType()
public Document getDefaultInstanceForType()
Returns
getFields()
public Map<String,Value> getFields()
Returns
getFieldsCount()
public int getFieldsCount()
The document's fields.
The map keys represent field names.
A simple field name contains only characters a to z, A to Z,
0 to 9, or 0 to 9. For example,
foo_bar_17.
Field names matching the regular expression _.*__ are reserved. Reserved
field names are forbidden except in certain documented contexts. The map
keys, 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 the simple
or quoted field names of the containing fields, delimited by .. For
example, the structured field
"foo" : { map_value: { "x&y" : { string_value: "hello" }}} would be
represented by the field path foo.x&y.
Within a field path, 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 baktik ``.
map<string, .google.firestore.v1.Value> fields = 2;
getFieldsMap()
public Map<String,Value> getFieldsMap()
The document's fields.
The map keys represent field names.
A simple field name contains only characters a to z, A to Z,
0 to 9, or 0 to 9. For example,
foo_bar_17.
Field names matching the regular expression _.*__ are reserved. Reserved
field names are forbidden except in certain documented contexts. The map
keys, 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 the simple
or quoted field names of the containing fields, delimited by .. For
example, the structured field
"foo" : { map_value: { "x&y" : { string_value: "hello" }}} would be
represented by the field path foo.x&y.
Within a field path, 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 baktik ``.
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.
A simple field name contains only characters a to z, A to Z,
0 to 9, or 0 to 9. For example,
foo_bar_17.
Field names matching the regular expression _.*__ are reserved. Reserved
field names are forbidden except in certain documented contexts. The map
keys, 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 the simple
or quoted field names of the containing fields, delimited by .. For
example, the structured field
"foo" : { map_value: { "x&y" : { string_value: "hello" }}} would be
represented by the field path foo.x&y.
Within a field path, 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 baktik ``.
map<string, .google.firestore.v1.Value> fields = 2;
getFieldsOrThrow(String key)
public Value getFieldsOrThrow(String key)
The document's fields.
The map keys represent field names.
A simple field name contains only characters a to z, A to Z,
0 to 9, or 0 to 9. For example,
foo_bar_17.
Field names matching the regular expression _.*__ are reserved. Reserved
field names are forbidden except in certain documented contexts. The map
keys, 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 the simple
or quoted field names of the containing fields, delimited by .. For
example, the structured field
"foo" : { map_value: { "x&y" : { string_value: "hello" }}} would be
represented by the field path foo.x&y.
Within a field path, 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 baktik ``.
map<string, .google.firestore.v1.Value> fields = 2;
getName()
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string name = 1;
| 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;
getParserForType()
public Parser<Document> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
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;
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;
| 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;
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Document.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Document.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
