Cloud Firestore V1beta1 Client - Class Document (1.47.0)

Reference documentation and code samples for the Cloud Firestore V1beta1 Client class Document.

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

Generated from protobuf message google.firestore.v1beta1.Document

Namespace

Google \ Cloud \ Firestore \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The resource name of the document, for example projects/{project_id}/databases/{database_id}/documents/{document_path}.
↳ fields array|Google\Protobuf\Internal\MapField

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 bak`tik.
↳ create_time Google\Protobuf\Timestamp

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.
↳ update_time Google\Protobuf\Timestamp

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.

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFields

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setFields

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

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.

Returns
Type Description
Google\Protobuf\Timestamp

setCreateTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

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.

Returns
Type Description
Google\Protobuf\Timestamp

setUpdateTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this