Types

class google.cloud.firestore_v1.types.Any()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message, google.protobuf.internal.well_known_types.Any

type_url()

Field google.protobuf.Any.type_url

value()

Field google.protobuf.Any.value

class google.cloud.firestore_v1.types.ArrayValue()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

An array value.

values()

Values in the array.

values()

Field google.firestore.v1.ArrayValue.values

class google.cloud.firestore_v1.types.BatchGetDocumentsRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

database()

The database name. In the format: projects/{project_id}/databases/{database_id}.

documents()

The names of the documents to retrieve. In the format: proje cts/{project_id}/databases/{database_id}/documents/{document_p ath}. The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.

mask()

The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.

consistency_selector()

The consistency mode for this transaction. If not set, defaults to strong consistency.

transaction()

Reads documents in a transaction.

new_transaction()

Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

read_time()

Reads documents as they were at the given time. This may not be older than 60 seconds.

database()

Field google.firestore.v1.BatchGetDocumentsRequest.database

documents()

Field google.firestore.v1.BatchGetDocumentsRequest.documents

mask()

Field google.firestore.v1.BatchGetDocumentsRequest.mask

new_transaction()

Field google.firestore.v1.BatchGetDocumentsRequest.new_transaction

read_time()

Field google.firestore.v1.BatchGetDocumentsRequest.read_time

transaction()

Field google.firestore.v1.BatchGetDocumentsRequest.transaction

class google.cloud.firestore_v1.types.BatchGetDocumentsResponse()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

result()

A single result. This can be empty if the server is just returning a transaction.

found()

A document that was requested.

missing()

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/docume nts/{document_path}.

transaction()

The transaction that was started as part of this request. Will only be set in the first response, and only if [BatchGetDocume ntsRequest.new_transaction][google.firestore.v1.BatchGetDocum entsRequest.new_transaction] was set in the request.

read_time()

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

found()

Field google.firestore.v1.BatchGetDocumentsResponse.found

missing()

Field google.firestore.v1.BatchGetDocumentsResponse.missing

read_time()

Field google.firestore.v1.BatchGetDocumentsResponse.read_time

transaction()

Field google.firestore.v1.BatchGetDocumentsResponse.transaction

class google.cloud.firestore_v1.types.BeginTransactionRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

database()

The database name. In the format: projects/{project_id}/databases/{database_id}.

options()

The options for the transaction. Defaults to a read-write transaction.

database()

Field google.firestore.v1.BeginTransactionRequest.database

options()

Field google.firestore.v1.BeginTransactionRequest.options

class google.cloud.firestore_v1.types.BeginTransactionResponse()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The response for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

transaction()

The transaction that was started.

transaction()

Field google.firestore.v1.BeginTransactionResponse.transaction

class google.cloud.firestore_v1.types.BoolValue()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

value()

Field google.protobuf.BoolValue.value

class google.cloud.firestore_v1.types.BytesValue()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

value()

Field google.protobuf.BytesValue.value

class google.cloud.firestore_v1.types.CommitRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.Commit][google.firestore.v1.Firestore.Commit].

database()

The database name. In the format: projects/{project_id}/databases/{database_id}.

writes()

The writes to apply. Always executed atomically and in order.

transaction()

If set, applies all writes in this transaction, and commits it.

database()

Field google.firestore.v1.CommitRequest.database

transaction()

Field google.firestore.v1.CommitRequest.transaction

writes()

Field google.firestore.v1.CommitRequest.writes

class google.cloud.firestore_v1.types.CommitResponse()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The response for [Firestore.Commit][google.firestore.v1.Firestore.Commit].

write_results()

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

commit_time()

The time at which the commit occurred.

commit_time()

Field google.firestore.v1.CommitResponse.commit_time

write_results()

Field google.firestore.v1.CommitResponse.write_results

class google.cloud.firestore_v1.types.CreateDocumentRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.CreateDocument][google.firestore.v1.Firestore.CreateDocument].

parent()

The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chat rooms/{chatroom_id}

collection_id()

The collection ID, relative to parent, to list. For example: chatrooms.

document_id()

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

document()

The document to create. name must not be set.

mask()

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

collection_id()

Field google.firestore.v1.CreateDocumentRequest.collection_id

document()

Field google.firestore.v1.CreateDocumentRequest.document

document_id()

Field google.firestore.v1.CreateDocumentRequest.document_id

mask()

Field google.firestore.v1.CreateDocumentRequest.mask

parent()

Field google.firestore.v1.CreateDocumentRequest.parent

class google.cloud.firestore_v1.types.Cursor()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A position in a query result set.

values()

The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.

before()

If the position is just before or just after the given values, relative to the sort order defined by the query.

before()

Field google.firestore.v1.Cursor.before

values()

Field google.firestore.v1.Cursor.values

class google.cloud.firestore_v1.types.CustomHttpPattern()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

kind()

Field google.api.CustomHttpPattern.kind

path()

Field google.api.CustomHttpPattern.path

class google.cloud.firestore_v1.types.DeleteDocumentRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument].

name()

The resource name of the Document to delete. In the format: `` projects/{project_id}/databases/{database_id}/documents/{docum ent_path}``.

current_document()

An optional precondition on the document. The request will fail if this is set and not met by the target document.

current_document()

Field google.firestore.v1.DeleteDocumentRequest.current_document

name()

Field google.firestore.v1.DeleteDocumentRequest.name

class google.cloud.firestore_v1.types.DescriptorProto()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

class ExtensionRange()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

end()

Field google.protobuf.DescriptorProto.ExtensionRange.end

options()

Field google.protobuf.DescriptorProto.ExtensionRange.options

start()

Field google.protobuf.DescriptorProto.ExtensionRange.start

class ReservedRange()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

end()

Field google.protobuf.DescriptorProto.ReservedRange.end

start()

Field google.protobuf.DescriptorProto.ReservedRange.start

enum_type()

Field google.protobuf.DescriptorProto.enum_type

extension()

Field google.protobuf.DescriptorProto.extension

extension_range()

Field google.protobuf.DescriptorProto.extension_range

field()

Field google.protobuf.DescriptorProto.field

name()

Field google.protobuf.DescriptorProto.name

nested_type()

Field google.protobuf.DescriptorProto.nested_type

oneof_decl()

Field google.protobuf.DescriptorProto.oneof_decl

options()

Field google.protobuf.DescriptorProto.options

reserved_name()

Field google.protobuf.DescriptorProto.reserved_name

reserved_range()

Field google.protobuf.DescriptorProto.reserved_range

class google.cloud.firestore_v1.types.Document()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

name()

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

fields()

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`representsx&yand`bak\`tik`representsbak`tik`.

create_time()

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()

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.

class FieldsEntry()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

key()

Field google.firestore.v1.Document.FieldsEntry.key

value()

Field google.firestore.v1.Document.FieldsEntry.value

create_time()

Field google.firestore.v1.Document.create_time

fields()

Field google.firestore.v1.Document.fields

name()

Field google.firestore.v1.Document.name

update_time()

Field google.firestore.v1.Document.update_time

class google.cloud.firestore_v1.types.DocumentChange()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A [Document][google.firestore.v1.Document] has changed.

May be the result of multiple [writes][google.firestore.v1.Write], including deletes, that ultimately resulted in a new value for the [Document][google.firestore.v1.Document].

Multiple [DocumentChange][google.firestore.v1.DocumentChange] messages may be returned for the same logical change, if multiple targets are affected.

document()

The new state of the [Document][google.firestore.v1.Document]. If mask is set, contains only fields that were updated or added.

target_ids()

A set of target IDs of targets that match this document.

removed_target_ids()

A set of target IDs for targets that no longer match this document.

document()

Field google.firestore.v1.DocumentChange.document

removed_target_ids()

Field google.firestore.v1.DocumentChange.removed_target_ids

target_ids()

Field google.firestore.v1.DocumentChange.target_ids

class google.cloud.firestore_v1.types.DocumentDelete()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A [Document][google.firestore.v1.Document] has been deleted.

May be the result of multiple [writes][google.firestore.v1.Write], including updates, the last of which deleted the [Document][google.firestore.v1.Document].

Multiple [DocumentDelete][google.firestore.v1.DocumentDelete] messages may be returned for the same logical delete, if multiple targets are affected.

document()

The resource name of the [Document][google.firestore.v1.Document] that was deleted.

removed_target_ids()

A set of target IDs for targets that previously matched this entity.

read_time()

The read timestamp at which the delete was observed. Greater or equal to the commit_time of the delete.

document()

Field google.firestore.v1.DocumentDelete.document

read_time()

Field google.firestore.v1.DocumentDelete.read_time

removed_target_ids()

Field google.firestore.v1.DocumentDelete.removed_target_ids

class google.cloud.firestore_v1.types.DocumentMask()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a [Document][google.firestore.v1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1.Value].

field_paths()

The list of field paths in the mask. See [Document.fields][google.firestore.v1.Document.fields] for a field path syntax reference.

field_paths()

Field google.firestore.v1.DocumentMask.field_paths

class google.cloud.firestore_v1.types.DocumentRemove()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A [Document][google.firestore.v1.Document] has been removed from the view of the targets.

Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document.

Multiple [DocumentRemove][google.firestore.v1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.

document()

The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.

removed_target_ids()

A set of target IDs for targets that previously matched this document.

read_time()

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

document()

Field google.firestore.v1.DocumentRemove.document

read_time()

Field google.firestore.v1.DocumentRemove.read_time

removed_target_ids()

Field google.firestore.v1.DocumentRemove.removed_target_ids

class google.cloud.firestore_v1.types.DocumentTransform()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A transformation of a document.

document()

The name of the document to transform.

field_transforms()

The list of transformations to apply to the fields of the document, in order. This must not be empty.

class FieldTransform()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A transformation of a field of the document.

field_path()

The path of the field. See [Document.fields][google.firestore.v1.Document.fields] for the field path syntax reference.

transform_type()

The transformation to apply on the field.

set_to_server_value()

Sets the field to the given server value.

increment()

Adds the given value to the field’s current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.

maximum()

Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

minimum()

Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

append_missing_elements()

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.

remove_all_from_array()

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.

append_missing_elements()

Field google.firestore.v1.DocumentTransform.FieldTransform.append_missing_elements

field_path()

Field google.firestore.v1.DocumentTransform.FieldTransform.field_path

increment()

Field google.firestore.v1.DocumentTransform.FieldTransform.increment

maximum()

Field google.firestore.v1.DocumentTransform.FieldTransform.maximum

minimum()

Field google.firestore.v1.DocumentTransform.FieldTransform.minimum

remove_all_from_array()

Field google.firestore.v1.DocumentTransform.FieldTransform.remove_all_from_array

set_to_server_value()

Field google.firestore.v1.DocumentTransform.FieldTransform.set_to_server_value

document()

Field google.firestore.v1.DocumentTransform.document

field_transforms()

Field google.firestore.v1.DocumentTransform.field_transforms

class google.cloud.firestore_v1.types.DoubleValue()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

value()

Field google.protobuf.DoubleValue.value

class google.cloud.firestore_v1.types.Empty()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

class google.cloud.firestore_v1.types.EnumDescriptorProto()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

class EnumReservedRange()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

end()

Field google.protobuf.EnumDescriptorProto.EnumReservedRange.end

start()

Field google.protobuf.EnumDescriptorProto.EnumReservedRange.start

name()

Field google.protobuf.EnumDescriptorProto.name

options()

Field google.protobuf.EnumDescriptorProto.options

reserved_name()

Field google.protobuf.EnumDescriptorProto.reserved_name

reserved_range()

Field google.protobuf.EnumDescriptorProto.reserved_range

value()

Field google.protobuf.EnumDescriptorProto.value

class google.cloud.firestore_v1.types.EnumOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

allow_alias()

Field google.protobuf.EnumOptions.allow_alias

deprecated()

Field google.protobuf.EnumOptions.deprecated

uninterpreted_option()

Field google.protobuf.EnumOptions.uninterpreted_option

class google.cloud.firestore_v1.types.EnumValueDescriptorProto()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

name()

Field google.protobuf.EnumValueDescriptorProto.name

number()

Field google.protobuf.EnumValueDescriptorProto.number

options()

Field google.protobuf.EnumValueDescriptorProto.options

class google.cloud.firestore_v1.types.EnumValueOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

deprecated()

Field google.protobuf.EnumValueOptions.deprecated

uninterpreted_option()

Field google.protobuf.EnumValueOptions.uninterpreted_option

class google.cloud.firestore_v1.types.ExistenceFilter()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A digest of all the documents that match a given target.

target_id()

The target ID to which this filter applies.

count()

The total count of documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id]. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target.

count()

Field google.firestore.v1.ExistenceFilter.count

target_id()

Field google.firestore.v1.ExistenceFilter.target_id

class google.cloud.firestore_v1.types.ExtensionRangeOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

uninterpreted_option()

Field google.protobuf.ExtensionRangeOptions.uninterpreted_option

class google.cloud.firestore_v1.types.FieldDescriptorProto()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

default_value()

Field google.protobuf.FieldDescriptorProto.default_value

extendee()

Field google.protobuf.FieldDescriptorProto.extendee

json_name()

Field google.protobuf.FieldDescriptorProto.json_name

label()

Field google.protobuf.FieldDescriptorProto.label

name()

Field google.protobuf.FieldDescriptorProto.name

number()

Field google.protobuf.FieldDescriptorProto.number

oneof_index()

Field google.protobuf.FieldDescriptorProto.oneof_index

options()

Field google.protobuf.FieldDescriptorProto.options

proto3_optional()

Field google.protobuf.FieldDescriptorProto.proto3_optional

type()

Field google.protobuf.FieldDescriptorProto.type

type_name()

Field google.protobuf.FieldDescriptorProto.type_name

class google.cloud.firestore_v1.types.FieldOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

ctype()

Field google.protobuf.FieldOptions.ctype

deprecated()

Field google.protobuf.FieldOptions.deprecated

jstype()

Field google.protobuf.FieldOptions.jstype

lazy()

Field google.protobuf.FieldOptions.lazy

packed()

Field google.protobuf.FieldOptions.packed

uninterpreted_option()

Field google.protobuf.FieldOptions.uninterpreted_option

unverified_lazy()

Field google.protobuf.FieldOptions.unverified_lazy

weak()

Field google.protobuf.FieldOptions.weak

class google.cloud.firestore_v1.types.FileDescriptorProto()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

dependency()

Field google.protobuf.FileDescriptorProto.dependency

enum_type()

Field google.protobuf.FileDescriptorProto.enum_type

extension()

Field google.protobuf.FileDescriptorProto.extension

message_type()

Field google.protobuf.FileDescriptorProto.message_type

name()

Field google.protobuf.FileDescriptorProto.name

options()

Field google.protobuf.FileDescriptorProto.options

package()

Field google.protobuf.FileDescriptorProto.package

public_dependency()

Field google.protobuf.FileDescriptorProto.public_dependency

service()

Field google.protobuf.FileDescriptorProto.service

source_code_info()

Field google.protobuf.FileDescriptorProto.source_code_info

syntax()

Field google.protobuf.FileDescriptorProto.syntax

weak_dependency()

Field google.protobuf.FileDescriptorProto.weak_dependency

class google.cloud.firestore_v1.types.FileDescriptorSet()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

file()

Field google.protobuf.FileDescriptorSet.file

class google.cloud.firestore_v1.types.FileOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

cc_enable_arenas()

Field google.protobuf.FileOptions.cc_enable_arenas

cc_generic_services()

Field google.protobuf.FileOptions.cc_generic_services

csharp_namespace()

Field google.protobuf.FileOptions.csharp_namespace

deprecated()

Field google.protobuf.FileOptions.deprecated

go_package()

Field google.protobuf.FileOptions.go_package

java_generate_equals_and_hash()

Field google.protobuf.FileOptions.java_generate_equals_and_hash

java_generic_services()

Field google.protobuf.FileOptions.java_generic_services

java_multiple_files()

Field google.protobuf.FileOptions.java_multiple_files

java_outer_classname()

Field google.protobuf.FileOptions.java_outer_classname

java_package()

Field google.protobuf.FileOptions.java_package

java_string_check_utf8()

Field google.protobuf.FileOptions.java_string_check_utf8

objc_class_prefix()

Field google.protobuf.FileOptions.objc_class_prefix

optimize_for()

Field google.protobuf.FileOptions.optimize_for

php_class_prefix()

Field google.protobuf.FileOptions.php_class_prefix

php_generic_services()

Field google.protobuf.FileOptions.php_generic_services

php_metadata_namespace()

Field google.protobuf.FileOptions.php_metadata_namespace

php_namespace()

Field google.protobuf.FileOptions.php_namespace

py_generic_services()

Field google.protobuf.FileOptions.py_generic_services

ruby_package()

Field google.protobuf.FileOptions.ruby_package

swift_prefix()

Field google.protobuf.FileOptions.swift_prefix

uninterpreted_option()

Field google.protobuf.FileOptions.uninterpreted_option

class google.cloud.firestore_v1.types.FloatValue()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

value()

Field google.protobuf.FloatValue.value

class google.cloud.firestore_v1.types.GeneratedCodeInfo()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

class Annotation()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

begin()

Field google.protobuf.GeneratedCodeInfo.Annotation.begin

end()

Field google.protobuf.GeneratedCodeInfo.Annotation.end

path()

Field google.protobuf.GeneratedCodeInfo.Annotation.path

source_file()

Field google.protobuf.GeneratedCodeInfo.Annotation.source_file

annotation()

Field google.protobuf.GeneratedCodeInfo.annotation

class google.cloud.firestore_v1.types.GetDocumentRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].

name()

The resource name of the Document to get. In the format: pro jects/{project_id}/databases/{database_id}/documents/{document _path}.

mask()

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

consistency_selector()

The consistency mode for this transaction. If not set, defaults to strong consistency.

transaction()

Reads the document in a transaction.

read_time()

Reads the version of the document at the given time. This may not be older than 60 seconds.

mask()

Field google.firestore.v1.GetDocumentRequest.mask

name()

Field google.firestore.v1.GetDocumentRequest.name

read_time()

Field google.firestore.v1.GetDocumentRequest.read_time

transaction()

Field google.firestore.v1.GetDocumentRequest.transaction

class google.cloud.firestore_v1.types.Http()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

fully_decode_reserved_expansion()

Field google.api.Http.fully_decode_reserved_expansion

rules()

Field google.api.Http.rules

class google.cloud.firestore_v1.types.HttpRule()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

additional_bindings()

Field google.api.HttpRule.additional_bindings

body()

Field google.api.HttpRule.body

custom()

Field google.api.HttpRule.custom

delete()

Field google.api.HttpRule.delete

get()

Field google.api.HttpRule.get

patch()

Field google.api.HttpRule.patch

post()

Field google.api.HttpRule.post

put()

Field google.api.HttpRule.put

response_body()

Field google.api.HttpRule.response_body

selector()

Field google.api.HttpRule.selector

class google.cloud.firestore_v1.types.Int32Value()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

value()

Field google.protobuf.Int32Value.value

class google.cloud.firestore_v1.types.Int64Value()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

value()

Field google.protobuf.Int64Value.value

class google.cloud.firestore_v1.types.LatLng()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

latitude()

Field google.type.LatLng.latitude

longitude()

Field google.type.LatLng.longitude

class google.cloud.firestore_v1.types.ListCollectionIdsRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

parent()

The parent document. In the format: projects/{project_id}/da tabases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my- database/documents/chatrooms/my-chatroom

page_size()

The maximum number of results to return.

page_token()

A page token. Must be a value from [ListCollectionIdsResponse] [google.firestore.v1.ListCollectionIdsResponse].

page_size()

Field google.firestore.v1.ListCollectionIdsRequest.page_size

page_token()

Field google.firestore.v1.ListCollectionIdsRequest.page_token

parent()

Field google.firestore.v1.ListCollectionIdsRequest.parent

class google.cloud.firestore_v1.types.ListCollectionIdsResponse()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The response from [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

collection_ids()

The collection ids.

next_page_token()

A page token that may be used to continue the list.

collection_ids()

Field google.firestore.v1.ListCollectionIdsResponse.collection_ids

next_page_token()

Field google.firestore.v1.ListCollectionIdsResponse.next_page_token

class google.cloud.firestore_v1.types.ListDocumentsRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

parent()

The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{doc ument_path}. For example: projects/my- project/databases/my-database/documents or projects/my- project/databases/my-database/documents/chatrooms/my- chatroom

collection_id()

The collection ID, relative to parent, to list. For example: chatrooms or messages.

page_size()

The maximum number of documents to return.

page_token()

The next_page_token value returned from a previous List request, if any.

order_by()

The order to sort results by. For example: priority desc, name.

mask()

The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.

consistency_selector()

The consistency mode for this transaction. If not set, defaults to strong consistency.

transaction()

Reads documents in a transaction.

read_time()

Reads documents as they were at the given time. This may not be older than 60 seconds.

show_missing()

If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, [Document.create_time][google.firestore.v1.Document.c reate_time], or [Document.update_time][google.firestore.v1.D ocument.update_time] set. Requests with show_missing may not specify where or order_by.

collection_id()

Field google.firestore.v1.ListDocumentsRequest.collection_id

mask()

Field google.firestore.v1.ListDocumentsRequest.mask

order_by()

Field google.firestore.v1.ListDocumentsRequest.order_by

page_size()

Field google.firestore.v1.ListDocumentsRequest.page_size

page_token()

Field google.firestore.v1.ListDocumentsRequest.page_token

parent()

Field google.firestore.v1.ListDocumentsRequest.parent

read_time()

Field google.firestore.v1.ListDocumentsRequest.read_time

show_missing()

Field google.firestore.v1.ListDocumentsRequest.show_missing

transaction()

Field google.firestore.v1.ListDocumentsRequest.transaction

class google.cloud.firestore_v1.types.ListDocumentsResponse()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The response for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

documents()

The Documents found.

next_page_token()

The next page token.

documents()

Field google.firestore.v1.ListDocumentsResponse.documents

next_page_token()

Field google.firestore.v1.ListDocumentsResponse.next_page_token

class google.cloud.firestore_v1.types.ListValue()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message, google.protobuf.internal.well_known_types.ListValue

values()

Field google.protobuf.ListValue.values

class google.cloud.firestore_v1.types.ListenRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A request for [Firestore.Listen][google.firestore.v1.Firestore.Listen]

database()

The database name. In the format: projects/{project_id}/databases/{database_id}.

target_change()

The supported target changes.

add_target()

A target to add to this stream.

remove_target()

The ID of a target to remove from this stream.

labels()

Labels associated with this target change.

class LabelsEntry()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

key()

Field google.firestore.v1.ListenRequest.LabelsEntry.key

value()

Field google.firestore.v1.ListenRequest.LabelsEntry.value

add_target()

Field google.firestore.v1.ListenRequest.add_target

database()

Field google.firestore.v1.ListenRequest.database

labels()

Field google.firestore.v1.ListenRequest.labels

remove_target()

Field google.firestore.v1.ListenRequest.remove_target

class google.cloud.firestore_v1.types.ListenResponse()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The response for [Firestore.Listen][google.firestore.v1.Firestore.Listen].

response_type()

The supported responses.

target_change()

Targets have changed.

document_change()

A [Document][google.firestore.v1.Document] has changed.

document_delete()

A [Document][google.firestore.v1.Document] has been deleted.

document_remove()

A [Document][google.firestore.v1.Document] has been removed from a target (because it is no longer relevant to that target).

filter()

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

document_change()

Field google.firestore.v1.ListenResponse.document_change

document_delete()

Field google.firestore.v1.ListenResponse.document_delete

document_remove()

Field google.firestore.v1.ListenResponse.document_remove

filter()

Field google.firestore.v1.ListenResponse.filter

target_change()

Field google.firestore.v1.ListenResponse.target_change

class google.cloud.firestore_v1.types.MapValue()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A map value.

fields()

The map’s fields. The map keys represent field names. 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.

class FieldsEntry()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

key()

Field google.firestore.v1.MapValue.FieldsEntry.key

value()

Field google.firestore.v1.MapValue.FieldsEntry.value

fields()

Field google.firestore.v1.MapValue.fields

class google.cloud.firestore_v1.types.MessageOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

deprecated()

Field google.protobuf.MessageOptions.deprecated

map_entry()

Field google.protobuf.MessageOptions.map_entry

message_set_wire_format()

Field google.protobuf.MessageOptions.message_set_wire_format

no_standard_descriptor_accessor()

Field google.protobuf.MessageOptions.no_standard_descriptor_accessor

uninterpreted_option()

Field google.protobuf.MessageOptions.uninterpreted_option

class google.cloud.firestore_v1.types.MethodDescriptorProto()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

client_streaming()

Field google.protobuf.MethodDescriptorProto.client_streaming

input_type()

Field google.protobuf.MethodDescriptorProto.input_type

name()

Field google.protobuf.MethodDescriptorProto.name

options()

Field google.protobuf.MethodDescriptorProto.options

output_type()

Field google.protobuf.MethodDescriptorProto.output_type

server_streaming()

Field google.protobuf.MethodDescriptorProto.server_streaming

class google.cloud.firestore_v1.types.MethodOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

deprecated()

Field google.protobuf.MethodOptions.deprecated

idempotency_level()

Field google.protobuf.MethodOptions.idempotency_level

uninterpreted_option()

Field google.protobuf.MethodOptions.uninterpreted_option

class google.cloud.firestore_v1.types.OneofDescriptorProto()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

name()

Field google.protobuf.OneofDescriptorProto.name

options()

Field google.protobuf.OneofDescriptorProto.options

class google.cloud.firestore_v1.types.OneofOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

uninterpreted_option()

Field google.protobuf.OneofOptions.uninterpreted_option

class google.cloud.firestore_v1.types.Precondition()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A precondition on a document, used for conditional operations.

condition_type()

The type of precondition.

exists()

When set to true, the target document must exist. When set to false, the target document must not exist.

update_time()

When set, the target document must exist and have been last updated at that time.

exists()

Field google.firestore.v1.Precondition.exists

update_time()

Field google.firestore.v1.Precondition.update_time

class google.cloud.firestore_v1.types.RollbackRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.Rollback][google.firestore.v1.Firestore.Rollback].

database()

The database name. In the format: projects/{project_id}/databases/{database_id}.

transaction()

The transaction to roll back.

database()

Field google.firestore.v1.RollbackRequest.database

transaction()

Field google.firestore.v1.RollbackRequest.transaction

class google.cloud.firestore_v1.types.RunQueryRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

parent()

query_type()

The query to run.

structured_query()

A structured query.

consistency_selector()

The consistency mode for this transaction. If not set, defaults to strong consistency.

transaction()

Reads documents in a transaction.

new_transaction()

Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

read_time()

Reads documents as they were at the given time. This may not be older than 60 seconds.

new_transaction()

Field google.firestore.v1.RunQueryRequest.new_transaction

parent()

Field google.firestore.v1.RunQueryRequest.parent

read_time()

Field google.firestore.v1.RunQueryRequest.read_time

structured_query()

Field google.firestore.v1.RunQueryRequest.structured_query

transaction()

Field google.firestore.v1.RunQueryRequest.transaction

class google.cloud.firestore_v1.types.RunQueryResponse()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The response for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

transaction()

The transaction that was started as part of this request. Can only be set in the first response, and only if [RunQueryReques t.new_transaction][google.firestore.v1.RunQueryRequest.new_t ransaction] was set in the request. If set, no other fields will be set in this response.

document()

A query result. Not set when reporting partial progress.

read_time()

The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. If the query returns no results, a response with read_time and no document will be sent, and this represents the time at which the query was run.

skipped_results()

The number of results that have been skipped due to an offset between the last response and the current response.

document()

Field google.firestore.v1.RunQueryResponse.document

read_time()

Field google.firestore.v1.RunQueryResponse.read_time

skipped_results()

Field google.firestore.v1.RunQueryResponse.skipped_results

transaction()

Field google.firestore.v1.RunQueryResponse.transaction

class google.cloud.firestore_v1.types.ServiceDescriptorProto()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

method()

Field google.protobuf.ServiceDescriptorProto.method

name()

Field google.protobuf.ServiceDescriptorProto.name

options()

Field google.protobuf.ServiceDescriptorProto.options

class google.cloud.firestore_v1.types.ServiceOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

deprecated()

Field google.protobuf.ServiceOptions.deprecated

uninterpreted_option()

Field google.protobuf.ServiceOptions.uninterpreted_option

class google.cloud.firestore_v1.types.SourceCodeInfo()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

class Location()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

leading_comments()

Field google.protobuf.SourceCodeInfo.Location.leading_comments

leading_detached_comments()

Field google.protobuf.SourceCodeInfo.Location.leading_detached_comments

path()

Field google.protobuf.SourceCodeInfo.Location.path

span()

Field google.protobuf.SourceCodeInfo.Location.span

trailing_comments()

Field google.protobuf.SourceCodeInfo.Location.trailing_comments

location()

Field google.protobuf.SourceCodeInfo.location

class google.cloud.firestore_v1.types.Status()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

code()

Field google.rpc.Status.code

details()

Field google.rpc.Status.details

message()

Field google.rpc.Status.message

class google.cloud.firestore_v1.types.StringValue()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

value()

Field google.protobuf.StringValue.value

class google.cloud.firestore_v1.types.Struct()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message, google.protobuf.internal.well_known_types.Struct

class FieldsEntry()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

key()

Field google.protobuf.Struct.FieldsEntry.key

value()

Field google.protobuf.Struct.FieldsEntry.value

fields()

Field google.protobuf.Struct.fields

class google.cloud.firestore_v1.types.StructuredQuery()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A Firestore query.

select()

The projection to return.

from()

The collections to query.

where()

The filter to apply.

order_by()

The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: - Any field required to appear in order_by, that is not already specified in order_by, is appended to the order in field name order by default. - If an order on __name__ is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or ‘ASCENDING’ if no order was specified. For example: - SELECT \* FROM Foo ORDER BY A becomes SELECT \* FROM Foo ORDER BY A, __name__ - SELECT \* FROM Foo ORDER BY A DESC becomes SELECT \* FROM Foo ORDER BY A DESC, __name__ DESC - SELECT \* FROM Foo WHERE A > 1 becomes SELECT \* FROM Foo WHERE A > 1 ORDER BY A, __name__

start_at()

A starting point for the query results.

end_at()

A end point for the query results.

offset()

The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.

limit()

The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.

class CollectionSelector()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A selection of a collection, such as messages as m1.

collection_id()

The collection ID. When set, selects only collections with this ID.

all_descendants()

When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest. When true, selects all descendant collections.

all_descendants()

Field google.firestore.v1.StructuredQuery.CollectionSelector.all_descendants

collection_id()

Field google.firestore.v1.StructuredQuery.CollectionSelector.collection_id

class CompositeFilter()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A filter that merges multiple other filters using the given operator.

op()

The operator for combining multiple filters.

filters()

The list of filters to combine. Must contain at least one filter.

filters()

Field google.firestore.v1.StructuredQuery.CompositeFilter.filters

op()

Field google.firestore.v1.StructuredQuery.CompositeFilter.op

class FieldFilter()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A filter on a specific field.

field()

The field to filter by.

op()

The operator to filter by.

value()

The value to compare to.

field()

Field google.firestore.v1.StructuredQuery.FieldFilter.field

op()

Field google.firestore.v1.StructuredQuery.FieldFilter.op

value()

Field google.firestore.v1.StructuredQuery.FieldFilter.value

class FieldReference()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A reference to a field, such as max(messages.time) as max_time.

field_path()

Field google.firestore.v1.StructuredQuery.FieldReference.field_path

class Filter()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A filter.

filter_type()

The type of filter.

composite_filter()

A composite filter.

field_filter()

A filter on a document field.

unary_filter()

A filter that takes exactly one argument.

composite_filter()

Field google.firestore.v1.StructuredQuery.Filter.composite_filter

field_filter()

Field google.firestore.v1.StructuredQuery.Filter.field_filter

unary_filter()

Field google.firestore.v1.StructuredQuery.Filter.unary_filter

class Order()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

An order on a field.

field()

The field to order by.

direction()

The direction to order by. Defaults to ASCENDING.

direction()

Field google.firestore.v1.StructuredQuery.Order.direction

field()

Field google.firestore.v1.StructuredQuery.Order.field

class Projection()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The projection of document’s fields to return.

fields()

The fields to return. If empty, all fields are returned. To only return the name of the document, use ['__name__'].

fields()

Field google.firestore.v1.StructuredQuery.Projection.fields

class UnaryFilter()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A filter with a single operand.

op()

The unary operator to apply.

operand_type()

The argument to the filter.

field()

The field to which to apply the operator.

field()

Field google.firestore.v1.StructuredQuery.UnaryFilter.field

op()

Field google.firestore.v1.StructuredQuery.UnaryFilter.op

end_at()

Field google.firestore.v1.StructuredQuery.end_at

from()

Field google.firestore.v1.StructuredQuery.from

limit()

Field google.firestore.v1.StructuredQuery.limit

offset()

Field google.firestore.v1.StructuredQuery.offset

order_by()

Field google.firestore.v1.StructuredQuery.order_by

select()

Field google.firestore.v1.StructuredQuery.select

start_at()

Field google.firestore.v1.StructuredQuery.start_at

where()

Field google.firestore.v1.StructuredQuery.where

class google.cloud.firestore_v1.types.Target()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A specification of a set of documents to listen to.

target_type()

The type of target to listen to.

query()

A target specified by a query.

documents()

A target specified by a set of document names.

resume_type()

When to start listening. If not specified, all matching Documents are returned before any subsequent changes.

resume_token()

A resume token from a prior [TargetChange][google.firestore.v1.TargetChange] for an identical target. Using a resume token with a different target is unsupported and may fail.

read_time()

Start listening after a specific read_time. The client must know the state of matching documents at this time.

target_id()

The target ID that identifies the target on the stream. Must be a positive number and non-zero.

once()

If the target should be removed once it is current and consistent.

class DocumentsTarget()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A target specified by a set of documents names.

documents()

Field google.firestore.v1.Target.DocumentsTarget.documents

class QueryTarget()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A target specified by a query.

parent()

query_type()

The query to run.

structured_query()

A structured query.

parent()

Field google.firestore.v1.Target.QueryTarget.parent

structured_query()

Field google.firestore.v1.Target.QueryTarget.structured_query

documents()

Field google.firestore.v1.Target.documents

once()

Field google.firestore.v1.Target.once

query()

Field google.firestore.v1.Target.query

read_time()

Field google.firestore.v1.Target.read_time

resume_token()

Field google.firestore.v1.Target.resume_token

target_id()

Field google.firestore.v1.Target.target_id

class google.cloud.firestore_v1.types.TargetChange()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

Targets being watched have changed.

target_change_type()

The type of change that occurred.

target_ids()

The target IDs of targets that have changed. If empty, the change applies to all targets. The order of the target IDs is not defined.

cause()

The error that resulted in this change, if applicable.

resume_token()

A token that can be used to resume the stream for the given target_ids, or all targets if target_ids is empty. Not set on every target change.

read_time()

The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot). The stream is guaranteed to send a read_time with target_ids empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not). For a given stream, read_time is guaranteed to be monotonically increasing.

cause()

Field google.firestore.v1.TargetChange.cause

read_time()

Field google.firestore.v1.TargetChange.read_time

resume_token()

Field google.firestore.v1.TargetChange.resume_token

target_change_type()

Field google.firestore.v1.TargetChange.target_change_type

target_ids()

Field google.firestore.v1.TargetChange.target_ids

class google.cloud.firestore_v1.types.Timestamp()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message, google.protobuf.internal.well_known_types.Timestamp

nanos()

Field google.protobuf.Timestamp.nanos

seconds()

Field google.protobuf.Timestamp.seconds

class google.cloud.firestore_v1.types.TransactionOptions()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

Options for creating a new transaction.

mode()

The mode of the transaction.

read_only()

The transaction can only be used for read operations.

read_write()

The transaction can be used for both read and write operations.

class ReadOnly()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

Options for a transaction that can only be used to read documents.

consistency_selector()

The consistency mode for this transaction. If not set, defaults to strong consistency.

read_time()

Reads documents at the given time. This may not be older than 60 seconds.

read_time()

Field google.firestore.v1.TransactionOptions.ReadOnly.read_time

class ReadWrite()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

Options for a transaction that can be used to read and write documents.

retry_transaction()

An optional transaction to retry.

retry_transaction()

Field google.firestore.v1.TransactionOptions.ReadWrite.retry_transaction

read_only()

Field google.firestore.v1.TransactionOptions.read_only

read_write()

Field google.firestore.v1.TransactionOptions.read_write

class google.cloud.firestore_v1.types.UInt32Value()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

value()

Field google.protobuf.UInt32Value.value

class google.cloud.firestore_v1.types.UInt64Value()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

value()

Field google.protobuf.UInt64Value.value

class google.cloud.firestore_v1.types.UninterpretedOption()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

class NamePart()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

is_extension()

Field google.protobuf.UninterpretedOption.NamePart.is_extension

name_part()

Field google.protobuf.UninterpretedOption.NamePart.name_part

aggregate_value()

Field google.protobuf.UninterpretedOption.aggregate_value

double_value()

Field google.protobuf.UninterpretedOption.double_value

identifier_value()

Field google.protobuf.UninterpretedOption.identifier_value

name()

Field google.protobuf.UninterpretedOption.name

negative_int_value()

Field google.protobuf.UninterpretedOption.negative_int_value

positive_int_value()

Field google.protobuf.UninterpretedOption.positive_int_value

string_value()

Field google.protobuf.UninterpretedOption.string_value

class google.cloud.firestore_v1.types.UpdateDocumentRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].

document()

The updated document. Creates the document if it does not already exist.

update_mask()

The fields to update. None of the field paths in the mask may contain a reserved name. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server.

mask()

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

current_document()

An optional precondition on the document. The request will fail if this is set and not met by the target document.

current_document()

Field google.firestore.v1.UpdateDocumentRequest.current_document

document()

Field google.firestore.v1.UpdateDocumentRequest.document

mask()

Field google.firestore.v1.UpdateDocumentRequest.mask

update_mask()

Field google.firestore.v1.UpdateDocumentRequest.update_mask

class google.cloud.firestore_v1.types.Value()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A message that can hold any of the supported value types.

value_type()

Must have a value set.

null_value()

A null value.

boolean_value()

A boolean value.

integer_value()

An integer value.

double_value()

A double value.

timestamp_value()

A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.

string_value()

A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

bytes_value()

A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

reference_value()

A reference to a document. For example: projects/{project_id }/databases/{database_id}/documents/{document_path}.

geo_point_value()

A geo point value representing a point on the surface of Earth.

array_value()

An array value. Cannot directly contain another array value, though can contain an map which contains another array.

map_value()

A map value.

array_value()

Field google.firestore.v1.Value.array_value

boolean_value()

Field google.firestore.v1.Value.boolean_value

bytes_value()

Field google.firestore.v1.Value.bytes_value

double_value()

Field google.firestore.v1.Value.double_value

geo_point_value()

Field google.firestore.v1.Value.geo_point_value

integer_value()

Field google.firestore.v1.Value.integer_value

map_value()

Field google.firestore.v1.Value.map_value

null_value()

Field google.firestore.v1.Value.null_value

reference_value()

Field google.firestore.v1.Value.reference_value

string_value()

Field google.firestore.v1.Value.string_value

timestamp_value()

Field google.firestore.v1.Value.timestamp_value

class google.cloud.firestore_v1.types.Write()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

A write on a document.

operation()

The operation to execute.

update()

A document to write.

delete()

A document name to delete. In the format: projects/{project_ id}/databases/{database_id}/documents/{document_path}.

transform()

Applies a transformation to a document. At most one transform per document is allowed in a given request. An update cannot follow a transform on the same document in a given request.

update_mask()

The fields to update in this write. This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.

current_document()

An optional precondition on the document. The write will fail if this is set and not met by the target document.

current_document()

Field google.firestore.v1.Write.current_document

delete()

Field google.firestore.v1.Write.delete

transform()

Field google.firestore.v1.Write.transform

update()

Field google.firestore.v1.Write.update

update_mask()

Field google.firestore.v1.Write.update_mask

class google.cloud.firestore_v1.types.WriteRequest()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The request for [Firestore.Write][google.firestore.v1.Firestore.Write].

The first request creates a stream, or resumes an existing one from a token.

When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request.

When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

database()

The database name. In the format: projects/{project_id}/databases/{database_id}. This is only required in the first message.

stream_id()

The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.

writes()

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

stream_token()

A stream token that was previously sent by the server. The client should set this field to the token from the most recent [WriteResponse][google.firestore.v1.WriteResponse] it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the stream_id field. Leave this field unset when creating a new stream.

labels()

Labels associated with this write request.

class LabelsEntry()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

key()

Field google.firestore.v1.WriteRequest.LabelsEntry.key

value()

Field google.firestore.v1.WriteRequest.LabelsEntry.value

database()

Field google.firestore.v1.WriteRequest.database

labels()

Field google.firestore.v1.WriteRequest.labels

stream_id()

Field google.firestore.v1.WriteRequest.stream_id

stream_token()

Field google.firestore.v1.WriteRequest.stream_token

writes()

Field google.firestore.v1.WriteRequest.writes

class google.cloud.firestore_v1.types.WriteResponse()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The response for [Firestore.Write][google.firestore.v1.Firestore.Write].

stream_id()

The ID of the stream. Only set on the first message, when a new stream was created.

stream_token()

A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set.

write_results()

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

commit_time()

The time at which the commit occurred.

commit_time()

Field google.firestore.v1.WriteResponse.commit_time

stream_id()

Field google.firestore.v1.WriteResponse.stream_id

stream_token()

Field google.firestore.v1.WriteResponse.stream_token

write_results()

Field google.firestore.v1.WriteResponse.write_results

class google.cloud.firestore_v1.types.WriteResult()

Bases: google.protobuf.pyext._message.CMessage, google.protobuf.message.Message

The result of applying a write.

update_time()

The last update time of the document after applying the write. Not set after a delete. If the write did not actually change the document, this will be the previous update_time.

transform_results()

The results of applying each [DocumentTransform.FieldTransform ][google.firestore.v1.DocumentTransform.FieldTransform], in the same order.

transform_results()

Field google.firestore.v1.WriteResult.transform_results

update_time()

Field google.firestore.v1.WriteResult.update_time