As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Index

_

__add__() (google.cloud.firestore_v1.field_path.FieldPath method) __copy__() (google.cloud.firestore_v1.base_document.BaseDocumentReference method) __deepcopy__() (google.cloud.firestore_v1.base_document.BaseDocumentReference method)

__eq__() (google.cloud.firestore_v1.base_document.BaseDocumentReference method) __exit__() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) __ne__() (google.cloud.firestore_v1.base_document.BaseDocumentReference method)

A

add() (google.cloud.firestore_v1.async_collection.AsyncCollectionReference method) (google.cloud.firestore_v1.collection.CollectionReference method) add_aggregation() (google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery method) add_aggregations() (google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery method) add_document() (google.cloud.firestore_bundle.bundle.FirestoreBundle method) add_named_query() (google.cloud.firestore_bundle.bundle.FirestoreBundle method) add_target (google.cloud.firestore_v1.types.ListenRequest attribute) aggregate_fields (google.cloud.firestore_v1.types.AggregationResult attribute) AggregationQuery (class in google.cloud.firestore_v1.aggregation) AggregationResult (class in google.cloud.firestore_v1.base_aggregation) (class in google.cloud.firestore_v1.types) AggregationResult.AggregateFieldsEntry (class in google.cloud.firestore_v1.types) aggregations (google.cloud.firestore_v1.types.StructuredAggregationQuery attribute) alias (google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation attribute) all_descendants (google.cloud.firestore_v1.types.StructuredQuery.CollectionSelector attribute) analyze (google.cloud.firestore_v1.types.ExplainOptions attribute) And (class in google.cloud.firestore_v1.base_query) api_endpoint (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient property) append_missing_elements (google.cloud.firestore_v1.types.DocumentTransform.FieldTransform attribute)

array_value (google.cloud.firestore_v1.types.Value attribute) ArrayRemove (class in google.cloud.firestore_v1.transforms) ArrayUnion (class in google.cloud.firestore_v1.transforms) ArrayValue (class in google.cloud.firestore_v1.types) ASCENDING (google.cloud.firestore_v1.base_query.BaseQuery attribute) async_transactional() (in module google.cloud.firestore_v1.async_transaction) AsyncAggregationQuery (class in google.cloud.firestore_v1.async_aggregation) AsyncClient (class in google.cloud.firestore_v1.async_client) AsyncCollectionGroup (class in google.cloud.firestore_v1.async_query) AsyncCollectionReference (class in google.cloud.firestore_v1.async_collection) AsyncDocumentReference (class in google.cloud.firestore_v1.async_document) AsyncQuery (class in google.cloud.firestore_v1.async_query) AsyncTransaction (class in google.cloud.firestore_v1.async_transaction) AsyncWriteBatch (class in google.cloud.firestore_v1.async_batch) avg (google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation attribute) avg() (google.cloud.firestore_v1.async_query.AsyncQuery method) (google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery method) (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.query.Query method) AvgAggregation (class in google.cloud.firestore_v1.base_aggregation)

B

backup_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) backup_schedule_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) BaseAggregation (class in google.cloud.firestore_v1.base_aggregation) BaseAggregationQuery (class in google.cloud.firestore_v1.base_aggregation) BaseBatch (class in google.cloud.firestore_v1.base_batch) BaseClient (class in google.cloud.firestore_v1.base_client) BaseCollectionGroup (class in google.cloud.firestore_v1.base_query) BaseCollectionReference (class in google.cloud.firestore_v1.base_collection) BaseCompositeFilter (class in google.cloud.firestore_v1.base_query) BaseDocumentReference (class in google.cloud.firestore_v1.base_document) BaseFilter (class in google.cloud.firestore_v1.base_query) BaseQuery (class in google.cloud.firestore_v1.base_query) BaseTransaction (class in google.cloud.firestore_v1.base_transaction) BaseWriteBatch (class in google.cloud.firestore_v1.base_batch) batch() (google.cloud.firestore_v1.async_client.AsyncClient method) (google.cloud.firestore_v1.client.Client method)

BatchGetDocumentsRequest (class in google.cloud.firestore_v1.types) BatchGetDocumentsResponse (class in google.cloud.firestore_v1.types) BatchWriteRequest (class in google.cloud.firestore_v1.types) BatchWriteRequest.LabelsEntry (class in google.cloud.firestore_v1.types) BatchWriteResponse (class in google.cloud.firestore_v1.types) before (google.cloud.firestore_v1.types.Cursor attribute) BeginTransactionRequest (class in google.cloud.firestore_v1.types) BeginTransactionResponse (class in google.cloud.firestore_v1.types) bitmap (google.cloud.firestore_v1.types.BitSequence attribute) bits (google.cloud.firestore_v1.types.BloomFilter attribute) BitSequence (class in google.cloud.firestore_v1.types) BloomFilter (class in google.cloud.firestore_v1.types) boolean_value (google.cloud.firestore_v1.types.Value attribute) build() (google.cloud.firestore_bundle.bundle.FirestoreBundle method) bulk_delete_documents() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) bulk_writer() (google.cloud.firestore_v1.base_client.BaseClient method) bytes_value (google.cloud.firestore_v1.types.Value attribute)

C

cancel_operation() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) cause (google.cloud.firestore_v1.types.TargetChange attribute) Client (class in google.cloud.firestore_v1.client) collection() (google.cloud.firestore_v1.async_client.AsyncClient method) (google.cloud.firestore_v1.base_document.BaseDocumentReference method) (google.cloud.firestore_v1.client.Client method) collection_group() (google.cloud.firestore_v1.async_client.AsyncClient method) (google.cloud.firestore_v1.client.Client method) collection_group_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) collection_id (google.cloud.firestore_v1.types.CreateDocumentRequest attribute) (google.cloud.firestore_v1.types.ListDocumentsRequest attribute) (google.cloud.firestore_v1.types.StructuredQuery.CollectionSelector attribute) collection_ids (google.cloud.firestore_v1.types.ListCollectionIdsResponse attribute) CollectionGroup (class in google.cloud.firestore_v1.query) CollectionReference (class in google.cloud.firestore_v1.collection) collections() (google.cloud.firestore_v1.async_client.AsyncClient method) (google.cloud.firestore_v1.async_document.AsyncDocumentReference method) (google.cloud.firestore_v1.client.Client method) (google.cloud.firestore_v1.document.DocumentReference method) commit() (google.cloud.firestore_v1.async_batch.AsyncWriteBatch method) (google.cloud.firestore_v1.async_transaction.AsyncTransaction method) (google.cloud.firestore_v1.base_batch.BaseBatch method) (google.cloud.firestore_v1.batch.WriteBatch method) (google.cloud.firestore_v1.transaction.Transaction method) commit_time (google.cloud.firestore_v1.types.CommitResponse attribute) (google.cloud.firestore_v1.types.WriteResponse attribute) CommitRequest (class in google.cloud.firestore_v1.types)

CommitResponse (class in google.cloud.firestore_v1.types) common_billing_account_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) common_folder_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) common_location_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) common_organization_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) common_project_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) composite_filter (google.cloud.firestore_v1.types.StructuredQuery.Filter attribute) count (google.cloud.firestore_v1.types.ExistenceFilter attribute) (google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation attribute) count() (google.cloud.firestore_v1.async_query.AsyncQuery method) (google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery method) (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.query.Query method) CountAggregation (class in google.cloud.firestore_v1.base_aggregation) create() (google.cloud.firestore_v1.async_document.AsyncDocumentReference method) (google.cloud.firestore_v1.async_transaction.AsyncTransaction method) (google.cloud.firestore_v1.base_batch.BaseBatch method) (google.cloud.firestore_v1.document.DocumentReference method) (google.cloud.firestore_v1.transaction.Transaction method) create_backup_schedule() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) create_database() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) create_index() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) create_time (google.cloud.firestore_v1.types.Document attribute) CreateDocumentRequest (class in google.cloud.firestore_v1.types) current_document (google.cloud.firestore_v1.types.DeleteDocumentRequest attribute) (google.cloud.firestore_v1.types.UpdateDocumentRequest attribute) (google.cloud.firestore_v1.types.Write attribute) Cursor (class in google.cloud.firestore_v1.types)

D

database (google.cloud.firestore_v1.types.BatchGetDocumentsRequest attribute) (google.cloud.firestore_v1.types.BatchWriteRequest attribute) (google.cloud.firestore_v1.types.BeginTransactionRequest attribute) (google.cloud.firestore_v1.types.CommitRequest attribute) (google.cloud.firestore_v1.types.ListenRequest attribute) (google.cloud.firestore_v1.types.RollbackRequest attribute) (google.cloud.firestore_v1.types.WriteRequest attribute) database_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) debug_stats (google.cloud.firestore_v1.types.ExecutionStats attribute) DEFAULT_DATABASE (in module google.cloud.firestore_v1.base_client) delete (google.cloud.firestore_v1.types.Write attribute) delete() (google.cloud.firestore_v1.async_document.AsyncDocumentReference method) (google.cloud.firestore_v1.async_transaction.AsyncTransaction method) (google.cloud.firestore_v1.base_batch.BaseBatch method) (google.cloud.firestore_v1.document.DocumentReference method) (google.cloud.firestore_v1.transaction.Transaction method) delete_backup() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) delete_backup_schedule() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) delete_database() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) delete_index() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) delete_operation() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) DeleteDocumentRequest (class in google.cloud.firestore_v1.types) DESCENDING (google.cloud.firestore_v1.base_query.BaseQuery attribute) direction (google.cloud.firestore_v1.types.StructuredQuery.Order attribute) distance_measure (google.cloud.firestore_v1.types.StructuredQuery.FindNearest attribute) distance_result_field (google.cloud.firestore_v1.types.StructuredQuery.FindNearest attribute) distance_threshold (google.cloud.firestore_v1.types.StructuredQuery.FindNearest attribute) Document (class in google.cloud.firestore_v1.types) document (google.cloud.firestore_v1.types.CreateDocumentRequest attribute) (google.cloud.firestore_v1.types.DocumentChange attribute) (google.cloud.firestore_v1.types.DocumentDelete attribute) (google.cloud.firestore_v1.types.DocumentRemove attribute) (google.cloud.firestore_v1.types.DocumentTransform attribute) (google.cloud.firestore_v1.types.RunQueryResponse attribute) (google.cloud.firestore_v1.types.UpdateDocumentRequest attribute)

document() (google.cloud.firestore_v1.async_client.AsyncClient method) (google.cloud.firestore_v1.async_collection.AsyncCollectionReference method) (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.client.Client method) Document.FieldsEntry (class in google.cloud.firestore_v1.types) document_change (google.cloud.firestore_v1.types.ListenResponse attribute) document_delete (google.cloud.firestore_v1.types.ListenResponse attribute) document_id (google.cloud.firestore_v1.types.CreateDocumentRequest attribute) document_id() (google.cloud.firestore_v1.field_path.FieldPath static method) document_remove (google.cloud.firestore_v1.types.ListenResponse attribute) DocumentChange (class in google.cloud.firestore_v1.types) DocumentDelete (class in google.cloud.firestore_v1.types) DocumentMask (class in google.cloud.firestore_v1.types) DocumentReference (class in google.cloud.firestore_v1.document) DocumentRemove (class in google.cloud.firestore_v1.types) documents (google.cloud.firestore_v1.types.BatchGetDocumentsRequest attribute) (google.cloud.firestore_v1.types.ListDocumentsResponse attribute) (google.cloud.firestore_v1.types.Target attribute) (google.cloud.firestore_v1.types.Target.DocumentsTarget attribute) DocumentSnapshot (class in google.cloud.firestore_v1.base_document) DocumentTransform (class in google.cloud.firestore_v1.types) DocumentTransform.FieldTransform (class in google.cloud.firestore_v1.types) DocumentTransform.FieldTransform.ServerValue (class in google.cloud.firestore_v1.types) done (google.cloud.firestore_v1.types.RunQueryResponse attribute) double_value (google.cloud.firestore_v1.types.Value attribute)

E

end_at (google.cloud.firestore_v1.types.StructuredQuery attribute) end_at() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method) end_before() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method) eq_or_parent() (google.cloud.firestore_v1.field_path.FieldPath method) execution_duration (google.cloud.firestore_v1.types.ExecutionStats attribute) execution_stats (google.cloud.firestore_v1.types.ExplainMetrics attribute) ExecutionStats (class in google.cloud.firestore_v1.types) ExistenceFilter (class in google.cloud.firestore_v1.types)

exists (google.cloud.firestore_v1.base_document.DocumentSnapshot property) (google.cloud.firestore_v1.types.Precondition attribute) expected_count (google.cloud.firestore_v1.types.Target attribute) explain_metrics (google.cloud.firestore_v1.types.RunAggregationQueryResponse attribute) (google.cloud.firestore_v1.types.RunQueryResponse attribute) explain_options (google.cloud.firestore_v1.types.RunAggregationQueryRequest attribute) (google.cloud.firestore_v1.types.RunQueryRequest attribute) ExplainMetrics (class in google.cloud.firestore_v1.types) ExplainOptions (class in google.cloud.firestore_v1.types) export_documents() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method)

F

field (google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation.Avg attribute) (google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation.Sum attribute) (google.cloud.firestore_v1.types.StructuredQuery.FieldFilter attribute) (google.cloud.firestore_v1.types.StructuredQuery.Order attribute) (google.cloud.firestore_v1.types.StructuredQuery.UnaryFilter attribute) field_filter (google.cloud.firestore_v1.types.StructuredQuery.Filter attribute) field_path (google.cloud.firestore_v1.types.DocumentTransform.FieldTransform attribute) (google.cloud.firestore_v1.types.StructuredQuery.FieldReference attribute) field_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) (google.cloud.firestore_v1.base_client.BaseClient static method) field_paths (google.cloud.firestore_v1.types.DocumentMask attribute) field_transforms (google.cloud.firestore_v1.types.DocumentTransform attribute) FieldFilter (class in google.cloud.firestore_v1.base_query) FieldPath (class in google.cloud.firestore_v1.field_path) fields (google.cloud.firestore_v1.types.Document attribute) (google.cloud.firestore_v1.types.MapValue attribute) (google.cloud.firestore_v1.types.StructuredQuery.Projection attribute)

filter (google.cloud.firestore_v1.types.ListenResponse attribute) filters (google.cloud.firestore_v1.types.StructuredQuery.CompositeFilter attribute) find_nearest (google.cloud.firestore_v1.types.StructuredQuery attribute) find_nearest() (google.cloud.firestore_v1.async_query.AsyncQuery method) (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.query.Query method) FirestoreAdminClient (class in google.cloud.firestore_admin_v1.services.firestore_admin.client) FirestoreBundle (class in google.cloud.firestore_bundle.bundle) found (google.cloud.firestore_v1.types.BatchGetDocumentsResponse attribute) from_ (google.cloud.firestore_v1.types.StructuredQuery attribute) from_api_repr() (google.cloud.firestore_v1.field_path.FieldPath class method) from_service_account_file() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient class method) from_service_account_info() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient class method) from_service_account_json() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient class method) from_string() (google.cloud.firestore_v1.field_path.FieldPath class method)

G

geo_point_value (google.cloud.firestore_v1.types.Value attribute) get() (google.cloud.firestore_v1.aggregation.AggregationQuery method) (google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery method) (google.cloud.firestore_v1.async_collection.AsyncCollectionReference method) (google.cloud.firestore_v1.async_document.AsyncDocumentReference method) (google.cloud.firestore_v1.async_query.AsyncQuery method) (google.cloud.firestore_v1.async_transaction.AsyncTransaction method) (google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery method) (google.cloud.firestore_v1.base_document.DocumentSnapshot method) (google.cloud.firestore_v1.collection.CollectionReference method) (google.cloud.firestore_v1.document.DocumentReference method) (google.cloud.firestore_v1.query.Query method) (google.cloud.firestore_v1.transaction.Transaction method) get_all() (google.cloud.firestore_v1.async_client.AsyncClient method) (google.cloud.firestore_v1.async_transaction.AsyncTransaction method) (google.cloud.firestore_v1.client.Client method) (google.cloud.firestore_v1.transaction.Transaction method) get_backup() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) get_backup_schedule() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) get_database() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) get_field() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) get_field_path() (in module google.cloud.firestore_v1.field_path) get_index() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) get_mtls_endpoint_and_cert_source() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient class method) get_nested_value() (in module google.cloud.firestore_v1.field_path) get_operation() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) get_partitions() (google.cloud.firestore_v1.async_query.AsyncCollectionGroup method) (google.cloud.firestore_v1.query.CollectionGroup method) GetDocumentRequest (class in google.cloud.firestore_v1.types) google.cloud.firestore_admin_v1.services.firestore_admin.client module google.cloud.firestore_bundle.bundle module google.cloud.firestore_v1.aggregation module google.cloud.firestore_v1.async_aggregation module google.cloud.firestore_v1.async_batch module google.cloud.firestore_v1.async_client module

google.cloud.firestore_v1.async_collection module google.cloud.firestore_v1.async_document module google.cloud.firestore_v1.async_query module google.cloud.firestore_v1.async_transaction module google.cloud.firestore_v1.base_aggregation module google.cloud.firestore_v1.base_batch module google.cloud.firestore_v1.base_client module google.cloud.firestore_v1.base_collection module google.cloud.firestore_v1.base_document module google.cloud.firestore_v1.base_query module google.cloud.firestore_v1.base_transaction module google.cloud.firestore_v1.batch module google.cloud.firestore_v1.client module google.cloud.firestore_v1.collection module google.cloud.firestore_v1.document module google.cloud.firestore_v1.field_path module google.cloud.firestore_v1.query module google.cloud.firestore_v1.transaction module google.cloud.firestore_v1.transforms module google.cloud.firestore_v1.types module

H

hash_count (google.cloud.firestore_v1.types.BloomFilter attribute)

I

id (google.cloud.firestore_v1.async_transaction.AsyncTransaction property) (google.cloud.firestore_v1.base_collection.BaseCollectionReference property) (google.cloud.firestore_v1.base_document.BaseDocumentReference property) (google.cloud.firestore_v1.base_document.DocumentSnapshot property) (google.cloud.firestore_v1.base_transaction.BaseTransaction property) (google.cloud.firestore_v1.transaction.Transaction property) import_documents() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method)

in_progress (google.cloud.firestore_v1.async_transaction.AsyncTransaction property) (google.cloud.firestore_v1.base_transaction.BaseTransaction property) (google.cloud.firestore_v1.transaction.Transaction property) Increment (class in google.cloud.firestore_v1.transforms) increment (google.cloud.firestore_v1.types.DocumentTransform.FieldTransform attribute) index_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) indexes_used (google.cloud.firestore_v1.types.PlanSummary attribute) integer_value (google.cloud.firestore_v1.types.Value attribute)

L

labels (google.cloud.firestore_v1.types.BatchWriteRequest attribute) (google.cloud.firestore_v1.types.ListenRequest attribute) (google.cloud.firestore_v1.types.WriteRequest attribute) limit (google.cloud.firestore_v1.types.StructuredQuery attribute) (google.cloud.firestore_v1.types.StructuredQuery.FindNearest attribute) limit() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method) limit_to_last() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method) lineage() (google.cloud.firestore_v1.field_path.FieldPath method) list_backup_schedules() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) list_backups() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) list_databases() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method)

list_documents() (google.cloud.firestore_v1.async_collection.AsyncCollectionReference method) (google.cloud.firestore_v1.collection.CollectionReference method) list_fields() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) list_indexes() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) list_operations() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) ListCollectionIdsRequest (class in google.cloud.firestore_v1.types) ListCollectionIdsResponse (class in google.cloud.firestore_v1.types) ListDocumentsRequest (class in google.cloud.firestore_v1.types) ListDocumentsResponse (class in google.cloud.firestore_v1.types) ListenRequest (class in google.cloud.firestore_v1.types) ListenRequest.LabelsEntry (class in google.cloud.firestore_v1.types) ListenResponse (class in google.cloud.firestore_v1.types) location_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method)

M

map_value (google.cloud.firestore_v1.types.Value attribute) MapValue (class in google.cloud.firestore_v1.types) MapValue.FieldsEntry (class in google.cloud.firestore_v1.types) mask (google.cloud.firestore_v1.types.BatchGetDocumentsRequest attribute) (google.cloud.firestore_v1.types.CreateDocumentRequest attribute) (google.cloud.firestore_v1.types.GetDocumentRequest attribute) (google.cloud.firestore_v1.types.ListDocumentsRequest attribute) (google.cloud.firestore_v1.types.UpdateDocumentRequest attribute) MAX_ATTEMPTS (in module google.cloud.firestore_v1.base_transaction) Maximum (class in google.cloud.firestore_v1.transforms) maximum (google.cloud.firestore_v1.types.DocumentTransform.FieldTransform attribute) Minimum (class in google.cloud.firestore_v1.transforms) minimum (google.cloud.firestore_v1.types.DocumentTransform.FieldTransform attribute) missing (google.cloud.firestore_v1.types.BatchGetDocumentsResponse attribute) module google.cloud.firestore_admin_v1.services.firestore_admin.client google.cloud.firestore_bundle.bundle google.cloud.firestore_v1.aggregation google.cloud.firestore_v1.async_aggregation google.cloud.firestore_v1.async_batch google.cloud.firestore_v1.async_client google.cloud.firestore_v1.async_collection google.cloud.firestore_v1.async_document google.cloud.firestore_v1.async_query google.cloud.firestore_v1.async_transaction google.cloud.firestore_v1.base_aggregation google.cloud.firestore_v1.base_batch google.cloud.firestore_v1.base_client google.cloud.firestore_v1.base_collection google.cloud.firestore_v1.base_document google.cloud.firestore_v1.base_query google.cloud.firestore_v1.base_transaction google.cloud.firestore_v1.batch google.cloud.firestore_v1.client google.cloud.firestore_v1.collection google.cloud.firestore_v1.document google.cloud.firestore_v1.field_path google.cloud.firestore_v1.query google.cloud.firestore_v1.transaction google.cloud.firestore_v1.transforms google.cloud.firestore_v1.types

N

name (google.cloud.firestore_v1.types.DeleteDocumentRequest attribute) (google.cloud.firestore_v1.types.Document attribute) (google.cloud.firestore_v1.types.GetDocumentRequest attribute) new_transaction (google.cloud.firestore_v1.types.BatchGetDocumentsRequest attribute) (google.cloud.firestore_v1.types.RunAggregationQueryRequest attribute) (google.cloud.firestore_v1.types.RunQueryRequest attribute)

next_page_token (google.cloud.firestore_v1.types.ListCollectionIdsResponse attribute) (google.cloud.firestore_v1.types.ListDocumentsResponse attribute) (google.cloud.firestore_v1.types.PartitionQueryResponse attribute) null_value (google.cloud.firestore_v1.types.Value attribute)

O

offset (google.cloud.firestore_v1.types.StructuredQuery attribute) offset() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method) on_snapshot() (google.cloud.firestore_v1.collection.CollectionReference method) (google.cloud.firestore_v1.document.DocumentReference method) (google.cloud.firestore_v1.query.Query method) once (google.cloud.firestore_v1.types.Target attribute) op (google.cloud.firestore_v1.types.StructuredQuery.CompositeFilter attribute) (google.cloud.firestore_v1.types.StructuredQuery.FieldFilter attribute) (google.cloud.firestore_v1.types.StructuredQuery.UnaryFilter attribute)

operation_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) options (google.cloud.firestore_v1.types.BeginTransactionRequest attribute) Or (class in google.cloud.firestore_v1.base_query) order_by (google.cloud.firestore_v1.types.ListDocumentsRequest attribute) (google.cloud.firestore_v1.types.StructuredQuery attribute) order_by() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method)

P

padding (google.cloud.firestore_v1.types.BitSequence attribute) page_size (google.cloud.firestore_v1.types.ListCollectionIdsRequest attribute) (google.cloud.firestore_v1.types.ListDocumentsRequest attribute) (google.cloud.firestore_v1.types.PartitionQueryRequest attribute) page_token (google.cloud.firestore_v1.types.ListCollectionIdsRequest attribute) (google.cloud.firestore_v1.types.ListDocumentsRequest attribute) (google.cloud.firestore_v1.types.PartitionQueryRequest attribute) parent (google.cloud.firestore_v1.base_collection.BaseCollectionReference property) (google.cloud.firestore_v1.base_document.BaseDocumentReference property) (google.cloud.firestore_v1.types.CreateDocumentRequest attribute) (google.cloud.firestore_v1.types.ListCollectionIdsRequest attribute) (google.cloud.firestore_v1.types.ListDocumentsRequest attribute) (google.cloud.firestore_v1.types.PartitionQueryRequest attribute) (google.cloud.firestore_v1.types.RunAggregationQueryRequest attribute) (google.cloud.firestore_v1.types.RunQueryRequest attribute) (google.cloud.firestore_v1.types.Target.QueryTarget attribute) parse_backup_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_backup_schedule_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_collection_group_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method)

parse_common_billing_account_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_common_folder_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_common_location_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_common_organization_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_common_project_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_database_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_field_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) (in module google.cloud.firestore_v1.field_path) parse_index_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_location_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) parse_operation_path() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient static method) partition_count (google.cloud.firestore_v1.types.PartitionQueryRequest attribute) PartitionQueryRequest (class in google.cloud.firestore_v1.types) PartitionQueryResponse (class in google.cloud.firestore_v1.types) partitions (google.cloud.firestore_v1.types.PartitionQueryResponse attribute) path (google.cloud.firestore_v1.base_document.BaseDocumentReference property) plan_summary (google.cloud.firestore_v1.types.ExplainMetrics attribute) PlanSummary (class in google.cloud.firestore_v1.types) Precondition (class in google.cloud.firestore_v1.types)

Q

Query (class in google.cloud.firestore_v1.query) query (google.cloud.firestore_v1.types.Target attribute)

query() (google.cloud.firestore_v1.base_query.QueryPartition method) query_vector (google.cloud.firestore_v1.types.StructuredQuery.FindNearest attribute) QueryPartition (class in google.cloud.firestore_v1.base_query)

R

read_only (google.cloud.firestore_v1.types.TransactionOptions attribute) read_operations (google.cloud.firestore_v1.types.ExecutionStats attribute) read_time (google.cloud.firestore_v1.types.BatchGetDocumentsRequest attribute) (google.cloud.firestore_v1.types.BatchGetDocumentsResponse attribute) (google.cloud.firestore_v1.types.DocumentDelete attribute) (google.cloud.firestore_v1.types.DocumentRemove attribute) (google.cloud.firestore_v1.types.GetDocumentRequest attribute) (google.cloud.firestore_v1.types.ListCollectionIdsRequest attribute) (google.cloud.firestore_v1.types.ListDocumentsRequest attribute) (google.cloud.firestore_v1.types.PartitionQueryRequest attribute) (google.cloud.firestore_v1.types.RunAggregationQueryRequest attribute) (google.cloud.firestore_v1.types.RunAggregationQueryResponse attribute) (google.cloud.firestore_v1.types.RunQueryRequest attribute) (google.cloud.firestore_v1.types.RunQueryResponse attribute) (google.cloud.firestore_v1.types.Target attribute) (google.cloud.firestore_v1.types.TargetChange attribute) (google.cloud.firestore_v1.types.TransactionOptions.ReadOnly attribute) read_write (google.cloud.firestore_v1.types.TransactionOptions attribute) recursive() (google.cloud.firestore_v1.base_query.BaseQuery method) recursive_delete() (google.cloud.firestore_v1.async_client.AsyncClient method) (google.cloud.firestore_v1.client.Client method)

reference (google.cloud.firestore_v1.base_document.DocumentSnapshot property) reference_value (google.cloud.firestore_v1.types.Value attribute) remove_all_from_array (google.cloud.firestore_v1.types.DocumentTransform.FieldTransform attribute) remove_target (google.cloud.firestore_v1.types.ListenRequest attribute) removed_target_ids (google.cloud.firestore_v1.types.DocumentChange attribute) (google.cloud.firestore_v1.types.DocumentDelete attribute) (google.cloud.firestore_v1.types.DocumentRemove attribute) render_field_path() (in module google.cloud.firestore_v1.field_path) restore_database() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) result (google.cloud.firestore_v1.types.RunAggregationQueryResponse attribute) results_returned (google.cloud.firestore_v1.types.ExecutionStats attribute) resume_token (google.cloud.firestore_v1.types.Target attribute) (google.cloud.firestore_v1.types.TargetChange attribute) retry_transaction (google.cloud.firestore_v1.types.TransactionOptions.ReadWrite attribute) RollbackRequest (class in google.cloud.firestore_v1.types) RunAggregationQueryRequest (class in google.cloud.firestore_v1.types) RunAggregationQueryResponse (class in google.cloud.firestore_v1.types) RunQueryRequest (class in google.cloud.firestore_v1.types) RunQueryResponse (class in google.cloud.firestore_v1.types)

S

SCOPE (google.cloud.firestore_v1.base_client.BaseClient attribute) select (google.cloud.firestore_v1.types.StructuredQuery attribute) select() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method) Sentinel (class in google.cloud.firestore_v1.transforms) set() (google.cloud.firestore_v1.async_document.AsyncDocumentReference method) (google.cloud.firestore_v1.async_transaction.AsyncTransaction method) (google.cloud.firestore_v1.base_batch.BaseBatch method) (google.cloud.firestore_v1.document.DocumentReference method) (google.cloud.firestore_v1.transaction.Transaction method) set_to_server_value (google.cloud.firestore_v1.types.DocumentTransform.FieldTransform attribute) show_missing (google.cloud.firestore_v1.types.ListDocumentsRequest attribute) skipped_results (google.cloud.firestore_v1.types.RunQueryResponse attribute) split_field_path() (in module google.cloud.firestore_v1.field_path) start_after() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method) start_at (google.cloud.firestore_v1.types.StructuredQuery attribute) start_at() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method) status (google.cloud.firestore_v1.types.BatchWriteResponse attribute) stream() (google.cloud.firestore_v1.aggregation.AggregationQuery method) (google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery method) (google.cloud.firestore_v1.async_collection.AsyncCollectionReference method) (google.cloud.firestore_v1.async_query.AsyncQuery method) (google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery method) (google.cloud.firestore_v1.collection.CollectionReference method) (google.cloud.firestore_v1.query.Query method) stream_id (google.cloud.firestore_v1.types.WriteRequest attribute) (google.cloud.firestore_v1.types.WriteResponse attribute) stream_token (google.cloud.firestore_v1.types.WriteRequest attribute) (google.cloud.firestore_v1.types.WriteResponse attribute)

string_value (google.cloud.firestore_v1.types.Value attribute) structured_aggregation_query (google.cloud.firestore_v1.types.RunAggregationQueryRequest attribute) structured_query (google.cloud.firestore_v1.types.PartitionQueryRequest attribute) (google.cloud.firestore_v1.types.RunQueryRequest attribute) (google.cloud.firestore_v1.types.StructuredAggregationQuery attribute) (google.cloud.firestore_v1.types.Target.QueryTarget attribute) StructuredAggregationQuery (class in google.cloud.firestore_v1.types) StructuredAggregationQuery.Aggregation (class in google.cloud.firestore_v1.types) StructuredAggregationQuery.Aggregation.Avg (class in google.cloud.firestore_v1.types) StructuredAggregationQuery.Aggregation.Count (class in google.cloud.firestore_v1.types) StructuredAggregationQuery.Aggregation.Sum (class in google.cloud.firestore_v1.types) StructuredQuery (class in google.cloud.firestore_v1.types) StructuredQuery.CollectionSelector (class in google.cloud.firestore_v1.types) StructuredQuery.CompositeFilter (class in google.cloud.firestore_v1.types) StructuredQuery.CompositeFilter.Operator (class in google.cloud.firestore_v1.types) StructuredQuery.Direction (class in google.cloud.firestore_v1.types) StructuredQuery.FieldFilter (class in google.cloud.firestore_v1.types) StructuredQuery.FieldFilter.Operator (class in google.cloud.firestore_v1.types) StructuredQuery.FieldReference (class in google.cloud.firestore_v1.types) StructuredQuery.Filter (class in google.cloud.firestore_v1.types) StructuredQuery.FindNearest (class in google.cloud.firestore_v1.types) StructuredQuery.FindNearest.DistanceMeasure (class in google.cloud.firestore_v1.types) StructuredQuery.Order (class in google.cloud.firestore_v1.types) StructuredQuery.Projection (class in google.cloud.firestore_v1.types) StructuredQuery.UnaryFilter (class in google.cloud.firestore_v1.types) StructuredQuery.UnaryFilter.Operator (class in google.cloud.firestore_v1.types) sum (google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation attribute) sum() (google.cloud.firestore_v1.async_query.AsyncQuery method) (google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery method) (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.query.Query method) SumAggregation (class in google.cloud.firestore_v1.base_aggregation)

T

Target (class in google.cloud.firestore_v1.types) Target.DocumentsTarget (class in google.cloud.firestore_v1.types) Target.QueryTarget (class in google.cloud.firestore_v1.types) target_change (google.cloud.firestore_v1.types.ListenResponse attribute) target_change_type (google.cloud.firestore_v1.types.TargetChange attribute) target_id (google.cloud.firestore_v1.types.ExistenceFilter attribute) (google.cloud.firestore_v1.types.Target attribute) target_ids (google.cloud.firestore_v1.types.DocumentChange attribute) (google.cloud.firestore_v1.types.TargetChange attribute) TargetChange (class in google.cloud.firestore_v1.types) TargetChange.TargetChangeType (class in google.cloud.firestore_v1.types) timestamp_value (google.cloud.firestore_v1.types.Value attribute) to_api_repr() (google.cloud.firestore_v1.field_path.FieldPath method) to_dict() (google.cloud.firestore_v1.base_document.DocumentSnapshot method) Transaction (class in google.cloud.firestore_v1.transaction) transaction (google.cloud.firestore_v1.types.BatchGetDocumentsRequest attribute) (google.cloud.firestore_v1.types.BatchGetDocumentsResponse attribute) (google.cloud.firestore_v1.types.BeginTransactionResponse attribute) (google.cloud.firestore_v1.types.CommitRequest attribute) (google.cloud.firestore_v1.types.GetDocumentRequest attribute) (google.cloud.firestore_v1.types.ListDocumentsRequest attribute) (google.cloud.firestore_v1.types.RollbackRequest attribute) (google.cloud.firestore_v1.types.RunAggregationQueryRequest attribute) (google.cloud.firestore_v1.types.RunAggregationQueryResponse attribute) (google.cloud.firestore_v1.types.RunQueryRequest attribute) (google.cloud.firestore_v1.types.RunQueryResponse attribute)

transaction() (google.cloud.firestore_v1.async_client.AsyncClient method) (google.cloud.firestore_v1.client.Client method) transactional() (in module google.cloud.firestore_v1.transaction) TransactionOptions (class in google.cloud.firestore_v1.types) TransactionOptions.ReadOnly (class in google.cloud.firestore_v1.types) TransactionOptions.ReadWrite (class in google.cloud.firestore_v1.types) transform (google.cloud.firestore_v1.types.Write attribute) transform_results (google.cloud.firestore_v1.types.WriteResult attribute) transport (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient property)

U

unary_filter (google.cloud.firestore_v1.types.StructuredQuery.Filter attribute) unchanged_names (google.cloud.firestore_v1.types.ExistenceFilter attribute) universe_domain (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient property) up_to (google.cloud.firestore_v1.types.StructuredAggregationQuery.Aggregation.Count attribute) update (google.cloud.firestore_v1.types.Write attribute) update() (google.cloud.firestore_v1.async_document.AsyncDocumentReference method) (google.cloud.firestore_v1.async_transaction.AsyncTransaction method) (google.cloud.firestore_v1.base_batch.BaseBatch method) (google.cloud.firestore_v1.document.DocumentReference method) (google.cloud.firestore_v1.transaction.Transaction method)

update_backup_schedule() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) update_database() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) update_field() (google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient method) update_mask (google.cloud.firestore_v1.types.UpdateDocumentRequest attribute) (google.cloud.firestore_v1.types.Write attribute) update_time (google.cloud.firestore_v1.types.Document attribute) (google.cloud.firestore_v1.types.Precondition attribute) (google.cloud.firestore_v1.types.WriteResult attribute) update_transforms (google.cloud.firestore_v1.types.Write attribute) UpdateDocumentRequest (class in google.cloud.firestore_v1.types)

V

Value (class in google.cloud.firestore_v1.types) value (google.cloud.firestore_v1.types.StructuredQuery.FieldFilter attribute)

values (google.cloud.firestore_v1.types.ArrayValue attribute) (google.cloud.firestore_v1.types.Cursor attribute) vector_field (google.cloud.firestore_v1.types.StructuredQuery.FindNearest attribute)

W

where (google.cloud.firestore_v1.types.StructuredQuery attribute) where() (google.cloud.firestore_v1.base_collection.BaseCollectionReference method) (google.cloud.firestore_v1.base_query.BaseQuery method) Write (class in google.cloud.firestore_v1.types) write_option() (google.cloud.firestore_v1.base_client.BaseClient static method) write_results (google.cloud.firestore_v1.types.BatchWriteResponse attribute) (google.cloud.firestore_v1.types.CommitResponse attribute) (google.cloud.firestore_v1.types.WriteResponse attribute)

WriteBatch (class in google.cloud.firestore_v1.batch) WriteRequest (class in google.cloud.firestore_v1.types) WriteRequest.LabelsEntry (class in google.cloud.firestore_v1.types) WriteResponse (class in google.cloud.firestore_v1.types) WriteResult (class in google.cloud.firestore_v1.types) writes (google.cloud.firestore_v1.types.BatchWriteRequest attribute) (google.cloud.firestore_v1.types.CommitRequest attribute) (google.cloud.firestore_v1.types.WriteRequest attribute)