public static final class Document.Builder extends GeneratedMessageV3.Builder<Document.Builder> implements DocumentOrBuilderA Firestore document.
Must not exceed 1 MiB - 4 bytes.
Protobuf type google.firestore.v1.Document
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.BuilderImplements
DocumentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Document.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
build()
public Document build()| Returns | |
|---|---|
| Type | Description |
Document | |
buildPartial()
public Document buildPartial()| Returns | |
|---|---|
| Type | Description |
Document | |
clear()
public Document.Builder clear()| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Document.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
clearFields()
public Document.Builder clearFields()| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
Document.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Document.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
clone()
public Document.Builder clone()| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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 _, and must not start with 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 |
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. |
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;
| Returns | |
|---|---|
| Type | Description |
Builder | |
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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getFields()
public Map<String,Value> getFields()Use #getFieldsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> | |
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 _, and must not start with 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 _, and must not start with 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 |
Map<String,Value> | |
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 _, and must not start with 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;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | Value |
| 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 _, and must not start with 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.
| Returns | |
|---|---|
| Type | Description |
Map<String,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. |
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;
| Returns | |
|---|---|
| Type | Description |
Builder | |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
mergeFrom(Document other)
public Document.Builder mergeFrom(Document other)| Parameter | |
|---|---|
| Name | Description |
other | Document |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Document.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Document.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Document.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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 _, and must not start with 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 |
values | Map<String,Value> |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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 _, and must not start with 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;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | Value |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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 _, and must not start with 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 |
Document.Builder | |
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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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 |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Document.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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 | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | This builder for chaining. |
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 | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Document.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Document.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
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 |
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |