public static final class Document.Builder extends GeneratedMessageV3.Builder<Document.Builder> implements DocumentOrBuilder
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
Protobuf type google.firestore.v1.Document
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Document.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
buildPartial()
public Document buildPartial()
clear()
public Document.Builder clear()
Overrides
clearCreateTime()
public Document.Builder clearCreateTime()
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;
clearField(Descriptors.FieldDescriptor field)
public Document.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearFields()
public Document.Builder clearFields()
clearName()
public Document.Builder clearName()
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string name = 1;
clearOneof(Descriptors.OneofDescriptor oneof)
public Document.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearUpdateTime()
public Document.Builder clearUpdateTime()
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;
clone()
public Document.Builder clone()
Overrides
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;
| Parameter |
|---|
| Name | Description |
key | String
|
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.
|
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
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()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getFields()
public Map<String,Value> getFields()
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;
| Returns |
|---|
| Type | Description |
int | |
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;
| Returns |
|---|
| Type | Description |
Value | |
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;
| Parameter |
|---|
| Name | Description |
key | String
|
| Returns |
|---|
| Type | Description |
Value | |
getMutableFields()
public Map<String,Value> getMutableFields()
Use alternate mutation accessors instead.
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.
|
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.
|
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
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;
| 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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeCreateTime(Timestamp value)
public Document.Builder mergeCreateTime(Timestamp value)
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;
mergeFrom(Document other)
public Document.Builder mergeFrom(Document other)
public Document.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public Document.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Document.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
mergeUpdateTime(Timestamp value)
public Document.Builder mergeUpdateTime(Timestamp value)
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;
putAllFields(Map<String,Value> values)
public Document.Builder putAllFields(Map<String,Value> values)
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;
putFields(String key, Value value)
public Document.Builder putFields(String key, Value value)
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;
removeFields(String key)
public Document.Builder removeFields(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;
| Parameter |
|---|
| Name | Description |
key | String
|
setCreateTime(Timestamp value)
public Document.Builder setCreateTime(Timestamp value)
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;
setCreateTime(Timestamp.Builder builderForValue)
public Document.Builder setCreateTime(Timestamp.Builder builderForValue)
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;
| Parameter |
|---|
| Name | Description |
builderForValue | Builder
|
setField(Descriptors.FieldDescriptor field, Object value)
public Document.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setName(String value)
public Document.Builder setName(String value)
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string name = 1;
| Parameter |
|---|
| Name | Description |
value | String
The name to set.
|
setNameBytes(ByteString value)
public Document.Builder setNameBytes(ByteString value)
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string name = 1;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for name to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Document.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Document.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
setUpdateTime(Timestamp value)
public Document.Builder setUpdateTime(Timestamp value)
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;
setUpdateTime(Timestamp.Builder builderForValue)
public Document.Builder setUpdateTime(Timestamp.Builder builderForValue)
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;
| Parameter |
|---|
| Name | Description |
builderForValue | Builder
|
