com.google.firestore.v1beta1

Interface DocumentOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Document, Document.Builder

public interface DocumentOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsFields(java.lang.String key) The document's fields.
Timestamp	getCreateTime() Output only.
TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
java.util.Map<java.lang.String,Value>	getFields() Deprecated.
int	getFieldsCount() The document's fields.
java.util.Map<java.lang.String,Value>	getFieldsMap() The document's fields.
Value	getFieldsOrDefault(java.lang.String key, Value defaultValue) The document's fields.
Value	getFieldsOrThrow(java.lang.String key) The document's fields.
java.lang.String	getName() The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
ByteString	getNameBytes() The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
Timestamp	getUpdateTime() Output only.
TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

java.lang.String getName()

 The resource name of the document, for example
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 

string name = 1;

getNameBytes

ByteString getNameBytes()

 The resource name of the document, for example
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 

string name = 1;

getFieldsCount

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` or `_`. 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 `` bak`tik ``.
 

map<string, .google.firestore.v1beta1.Value> fields = 2;

containsFields

boolean containsFields(java.lang.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` or `_`. 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 `` bak`tik ``.
 

map<string, .google.firestore.v1beta1.Value> fields = 2;

getFields

@Deprecated
java.util.Map<java.lang.String,Value> getFields()

Deprecated.

Use getFieldsMap() instead.

getFieldsMap

java.util.Map<java.lang.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` or `_`. 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 `` bak`tik ``.
 

map<string, .google.firestore.v1beta1.Value> fields = 2;

getFieldsOrDefault

Value getFieldsOrDefault(java.lang.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` or `_`. 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 `` bak`tik ``.
 

map<string, .google.firestore.v1beta1.Value> fields = 2;

getFieldsOrThrow

Value getFieldsOrThrow(java.lang.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` or `_`. 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 `` bak`tik ``.
 

map<string, .google.firestore.v1beta1.Value> fields = 2;

hasCreateTime

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;

getCreateTime

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

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;

hasUpdateTime

boolean hasUpdateTime()

 Output only. The time at which the document was last changed.
 This value is initally 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;

getUpdateTime

Timestamp getUpdateTime()

 Output only. The time at which the document was last changed.
 This value is initally 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

TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. The time at which the document was last changed.
 This value is initally 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;