public interface DocumentOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsFields(String key)
public abstract 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.events.cloud.firestore.v1.Value> fields = 2;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getCreateTime()
public abstract Timestamp getCreateTime() 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 abstract TimestampOrBuilder getCreateTimeOrBuilder() 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 | |
getFields()
public abstract Map<String,Value> getFields()Use #getFieldsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> | |
getFieldsCount()
public abstract 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.events.cloud.firestore.v1.Value> fields = 2;
| Returns | |
|---|---|
| Type | Description |
int | |
getFieldsMap()
public abstract 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.events.cloud.firestore.v1.Value> fields = 2;
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> | |
getFieldsOrDefault(String key, Value defaultValue)
public abstract 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.events.cloud.firestore.v1.Value> fields = 2;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | Value |
| Returns | |
|---|---|
| Type | Description |
Value | |
getFieldsOrThrow(String key)
public abstract 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.events.cloud.firestore.v1.Value> fields = 2;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Value | |
getName()
public abstract 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 abstract 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 abstract Timestamp getUpdateTime() 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 abstract TimestampOrBuilder getUpdateTimeOrBuilder() 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 abstract boolean hasCreateTime() 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 abstract boolean hasUpdateTime() 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. |