SDK Client Reference
Classes
BulkWriter
close
create
delete
flush
onWriteError
onWriteResult
set
update
BulkWriterError
BundleBuilder
add
CollectionGroup
getPartitions
CollectionReference
add
doc
endAt
endBefore
get
isEqual
limit
limitToLast
listDocuments
offset
onSnapshot
orderBy
select
startAfter
startAt
stream
where
DocumentChange
isEqual
DocumentReference
collection
create
delete
get
isEqual
listCollections
onSnapshot
set
update
DocumentSnapshot
data
get
isEqual
FieldPath
documentId
isEqual
FieldValue
arrayRemove
arrayUnion
delete
increment
serverTimestamp
isEqual
Firestore
batch
bulkWriter
bundle
collection
collectionGroup
doc
getAll
listCollections
runTransaction
settings
terminate
BundledDocumentMetadata
fromObject
toObject
toJSON
BundledQuery
fromObject
toObject
toJSON
BundleElement
fromObject
toObject
toJSON
BundleMetadata
fromObject
toObject
toJSON
NamedQuery
fromObject
toObject
toJSON
GeoPoint
isEqual
google.api.CustomHttpPattern
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.api.Http
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.api.HttpRule
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.api.ResourceDescriptor
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.api.ResourceReference
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
CreateIndexRequest
fromObject
toObject
toJSON
DeleteIndexRequest
fromObject
toObject
toJSON
ExportDocumentsMetadata
fromObject
toObject
toJSON
ExportDocumentsRequest
fromObject
toObject
toJSON
ExportDocumentsResponse
fromObject
toObject
toJSON
Field
fromObject
toObject
toJSON
IndexConfig
fromObject
toObject
toJSON
FieldOperationMetadata
fromObject
toObject
toJSON
IndexConfigDelta
fromObject
toObject
toJSON
FirestoreAdmin
createIndex
createIndex
deleteIndex
deleteIndex
exportDocuments
exportDocuments
getField
getField
getIndex
getIndex
importDocuments
importDocuments
listFields
listFields
listIndexes
listIndexes
updateField
updateField
GetFieldRequest
fromObject
toObject
toJSON
GetIndexRequest
fromObject
toObject
toJSON
ImportDocumentsMetadata
fromObject
toObject
toJSON
ImportDocumentsRequest
fromObject
toObject
toJSON
Index
fromObject
toObject
toJSON
IndexField
fromObject
toObject
toJSON
IndexOperationMetadata
fromObject
toObject
toJSON
ListFieldsRequest
fromObject
toObject
toJSON
ListFieldsResponse
fromObject
toObject
toJSON
ListIndexesRequest
fromObject
toObject
toJSON
ListIndexesResponse
fromObject
toObject
toJSON
LocationMetadata
fromObject
toObject
toJSON
Progress
fromObject
toObject
toJSON
UpdateFieldRequest
fromObject
toObject
toJSON
google.firestore.v1.ArrayValue
fromObject
toObject
toJSON
google.firestore.v1.BatchGetDocumentsRequest
fromObject
toObject
toJSON
google.firestore.v1.BatchGetDocumentsResponse
fromObject
toObject
toJSON
BatchWriteRequest
fromObject
toObject
toJSON
BatchWriteResponse
fromObject
toObject
toJSON
google.firestore.v1.BeginTransactionRequest
fromObject
toObject
toJSON
google.firestore.v1.BeginTransactionResponse
fromObject
toObject
toJSON
google.firestore.v1beta1.ArrayValue
fromObject
toObject
toJSON
google.firestore.v1beta1.BatchGetDocumentsRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.BatchGetDocumentsResponse
fromObject
toObject
toJSON
google.firestore.v1beta1.BeginTransactionRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.BeginTransactionResponse
fromObject
toObject
toJSON
google.firestore.v1beta1.CommitRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.CommitResponse
fromObject
toObject
toJSON
google.firestore.v1beta1.CreateDocumentRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.Cursor
fromObject
toObject
toJSON
google.firestore.v1beta1.DeleteDocumentRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.Document
fromObject
toObject
toJSON
google.firestore.v1beta1.DocumentChange
fromObject
toObject
toJSON
google.firestore.v1beta1.DocumentDelete
fromObject
toObject
toJSON
google.firestore.v1beta1.DocumentMask
fromObject
toObject
toJSON
google.firestore.v1beta1.DocumentRemove
fromObject
toObject
toJSON
google.firestore.v1beta1.DocumentTransform
fromObject
toObject
toJSON
google.firestore.v1beta1.DocumentTransform.FieldTransform
fromObject
toObject
toJSON
google.firestore.v1beta1.ExistenceFilter
fromObject
toObject
toJSON
google.firestore.v1beta1.Firestore
batchGetDocuments
batchGetDocuments
beginTransaction
beginTransaction
commit
commit
createDocument
createDocument
deleteDocument
deleteDocument
getDocument
getDocument
listCollectionIds
listCollectionIds
listDocuments
listDocuments
listen
listen
rollback
rollback
runQuery
runQuery
updateDocument
updateDocument
write
write
google.firestore.v1beta1.GetDocumentRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.ListCollectionIdsRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.ListCollectionIdsResponse
fromObject
toObject
toJSON
google.firestore.v1beta1.ListDocumentsRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.ListDocumentsResponse
fromObject
toObject
toJSON
google.firestore.v1beta1.ListenRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.ListenResponse
fromObject
toObject
toJSON
google.firestore.v1beta1.MapValue
fromObject
toObject
toJSON
google.firestore.v1beta1.Precondition
fromObject
toObject
toJSON
google.firestore.v1beta1.RollbackRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.RunQueryRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.RunQueryResponse
fromObject
toObject
toJSON
google.firestore.v1beta1.StructuredQuery
fromObject
toObject
toJSON
google.firestore.v1beta1.StructuredQuery.CollectionSelector
fromObject
toObject
toJSON
google.firestore.v1beta1.StructuredQuery.CompositeFilter
fromObject
toObject
toJSON
google.firestore.v1beta1.StructuredQuery.FieldFilter
fromObject
toObject
toJSON
google.firestore.v1beta1.StructuredQuery.FieldReference
fromObject
toObject
toJSON
google.firestore.v1beta1.StructuredQuery.Filter
fromObject
toObject
toJSON
google.firestore.v1beta1.StructuredQuery.Order
fromObject
toObject
toJSON
google.firestore.v1beta1.StructuredQuery.Projection
fromObject
toObject
toJSON
google.firestore.v1beta1.StructuredQuery.UnaryFilter
fromObject
toObject
toJSON
google.firestore.v1beta1.Target
fromObject
toObject
toJSON
google.firestore.v1beta1.Target.DocumentsTarget
fromObject
toObject
toJSON
google.firestore.v1beta1.Target.QueryTarget
fromObject
toObject
toJSON
google.firestore.v1beta1.TargetChange
fromObject
toObject
toJSON
google.firestore.v1beta1.TransactionOptions
fromObject
toObject
toJSON
google.firestore.v1beta1.TransactionOptions.ReadOnly
fromObject
toObject
toJSON
google.firestore.v1beta1.TransactionOptions.ReadWrite
fromObject
toObject
toJSON
google.firestore.v1beta1.UpdateDocumentRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.Value
fromObject
toObject
toJSON
google.firestore.v1beta1.Write
fromObject
toObject
toJSON
google.firestore.v1beta1.WriteRequest
fromObject
toObject
toJSON
google.firestore.v1beta1.WriteResponse
fromObject
toObject
toJSON
google.firestore.v1beta1.WriteResult
fromObject
toObject
toJSON
google.firestore.v1.CommitRequest
fromObject
toObject
toJSON
google.firestore.v1.CommitResponse
fromObject
toObject
toJSON
google.firestore.v1.CreateDocumentRequest
fromObject
toObject
toJSON
google.firestore.v1.Cursor
fromObject
toObject
toJSON
google.firestore.v1.DeleteDocumentRequest
fromObject
toObject
toJSON
google.firestore.v1.Document
fromObject
toObject
toJSON
google.firestore.v1.DocumentChange
fromObject
toObject
toJSON
google.firestore.v1.DocumentDelete
fromObject
toObject
toJSON
google.firestore.v1.DocumentMask
fromObject
toObject
toJSON
google.firestore.v1.DocumentRemove
fromObject
toObject
toJSON
google.firestore.v1.DocumentTransform
fromObject
toObject
toJSON
google.firestore.v1.DocumentTransform.FieldTransform
fromObject
toObject
toJSON
google.firestore.v1.ExistenceFilter
fromObject
toObject
toJSON
google.firestore.v1.Firestore
batchGetDocuments
batchGetDocuments
batchWrite
batchWrite
beginTransaction
beginTransaction
commit
commit
createDocument
createDocument
deleteDocument
deleteDocument
getDocument
getDocument
listCollectionIds
listCollectionIds
listDocuments
listDocuments
listen
listen
partitionQuery
partitionQuery
rollback
rollback
runQuery
runQuery
updateDocument
updateDocument
write
write
google.firestore.v1.GetDocumentRequest
fromObject
toObject
toJSON
google.firestore.v1.ListCollectionIdsRequest
fromObject
toObject
toJSON
google.firestore.v1.ListCollectionIdsResponse
fromObject
toObject
toJSON
google.firestore.v1.ListDocumentsRequest
fromObject
toObject
toJSON
google.firestore.v1.ListDocumentsResponse
fromObject
toObject
toJSON
google.firestore.v1.ListenRequest
fromObject
toObject
toJSON
google.firestore.v1.ListenResponse
fromObject
toObject
toJSON
google.firestore.v1.MapValue
fromObject
toObject
toJSON
PartitionQueryRequest
fromObject
toObject
toJSON
PartitionQueryResponse
fromObject
toObject
toJSON
google.firestore.v1.Precondition
fromObject
toObject
toJSON
google.firestore.v1.RollbackRequest
fromObject
toObject
toJSON
google.firestore.v1.RunQueryRequest
fromObject
toObject
toJSON
google.firestore.v1.RunQueryResponse
fromObject
toObject
toJSON
google.firestore.v1.StructuredQuery
fromObject
toObject
toJSON
google.firestore.v1.StructuredQuery.CollectionSelector
fromObject
toObject
toJSON
google.firestore.v1.StructuredQuery.CompositeFilter
fromObject
toObject
toJSON
google.firestore.v1.StructuredQuery.FieldFilter
fromObject
toObject
toJSON
google.firestore.v1.StructuredQuery.FieldReference
fromObject
toObject
toJSON
google.firestore.v1.StructuredQuery.Filter
fromObject
toObject
toJSON
google.firestore.v1.StructuredQuery.Order
fromObject
toObject
toJSON
google.firestore.v1.StructuredQuery.Projection
fromObject
toObject
toJSON
google.firestore.v1.StructuredQuery.UnaryFilter
fromObject
toObject
toJSON
google.firestore.v1.Target
fromObject
toObject
toJSON
google.firestore.v1.Target.DocumentsTarget
fromObject
toObject
toJSON
google.firestore.v1.Target.QueryTarget
fromObject
toObject
toJSON
google.firestore.v1.TargetChange
fromObject
toObject
toJSON
google.firestore.v1.TransactionOptions
fromObject
toObject
toJSON
google.firestore.v1.TransactionOptions.ReadOnly
fromObject
toObject
toJSON
google.firestore.v1.TransactionOptions.ReadWrite
fromObject
toObject
toJSON
google.firestore.v1.UpdateDocumentRequest
fromObject
toObject
toJSON
google.firestore.v1.Value
fromObject
toObject
toJSON
google.firestore.v1.Write
fromObject
toObject
toJSON
google.firestore.v1.WriteRequest
fromObject
toObject
toJSON
google.firestore.v1.WriteResponse
fromObject
toObject
toJSON
google.firestore.v1.WriteResult
fromObject
toObject
toJSON
google.longrunning.CancelOperationRequest
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.longrunning.DeleteOperationRequest
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.longrunning.GetOperationRequest
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.longrunning.ListOperationsRequest
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.longrunning.ListOperationsResponse
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.longrunning.Operation
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.longrunning.OperationInfo
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.longrunning.Operations
cancelOperation
cancelOperation
cancelOperation
cancelOperation
cancelOperation
cancelOperation
deleteOperation
deleteOperation
deleteOperation
deleteOperation
deleteOperation
deleteOperation
getOperation
getOperation
getOperation
getOperation
getOperation
getOperation
listOperations
listOperations
listOperations
listOperations
listOperations
listOperations
waitOperation
waitOperation
waitOperation
waitOperation
waitOperation
waitOperation
google.longrunning.WaitOperationRequest
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.Any
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.BoolValue
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.BytesValue
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.DescriptorProto
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.DescriptorProto.ExtensionRange
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.DescriptorProto.ReservedRange
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.DoubleValue
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.Duration
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.Empty
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.EnumDescriptorProto
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.EnumOptions
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.EnumValueDescriptorProto
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.EnumValueOptions
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.FieldDescriptorProto
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.FieldMask
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.FieldOptions
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.FileDescriptorProto
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.FileDescriptorSet
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.FileOptions
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.FloatValue
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.GeneratedCodeInfo
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.GeneratedCodeInfo.Annotation
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.Int32Value
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.Int64Value
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.ListValue
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.MessageOptions
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.MethodDescriptorProto
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.MethodOptions
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.OneofDescriptorProto
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.OneofOptions
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.ServiceDescriptorProto
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.ServiceOptions
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.SourceCodeInfo
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.SourceCodeInfo.Location
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.StringValue
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.Struct
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.Timestamp
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.UInt32Value
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.UInt64Value
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.UninterpretedOption
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.UninterpretedOption.NamePart
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.protobuf.Value
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.rpc.Status
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
google.type.LatLng
fromObject
fromObject
fromObject
toObject
toObject
toObject
toJSON
toJSON
toJSON
Query
endAt
endBefore
get
isEqual
limit
limitToLast
offset
onSnapshot
orderBy
select
startAfter
startAt
stream
where
QueryDocumentSnapshot
data
get
isEqual
QueryPartition
toQuery
QuerySnapshot
docChanges
forEach
isEqual
Timestamp
fromDate
fromMillis
now
isEqual
toDate
toMillis
valueOf
Transaction
create
delete
get
getAll
set
update
v1beta1.FirestoreClient
batchGetDocuments
beginTransaction
close
commit
createDocument
deleteDocument
getDocument
getProjectId
initialize
listCollectionIds
listCollectionIdsAsync
listCollectionIdsStream
listDocuments
listDocumentsAsync
listDocumentsStream
listen
rollback
runQuery
updateDocument
write
FirestoreAdminClient
checkCreateIndexProgress
checkExportDocumentsProgress
checkImportDocumentsProgress
checkUpdateFieldProgress
close
collectionGroupPath
createIndex
databasePath
deleteIndex
exportDocuments
fieldPath
getField
getIndex
getProjectId
importDocuments
indexPath
initialize
listFields
listFieldsAsync
listFieldsStream
listIndexes
listIndexesAsync
listIndexesStream
matchCollectionFromCollectionGroupName
matchCollectionFromFieldName
matchCollectionFromIndexName
matchDatabaseFromCollectionGroupName
matchDatabaseFromDatabaseName
matchDatabaseFromFieldName
matchDatabaseFromIndexName
matchFieldFromFieldName
matchIndexFromIndexName
matchProjectFromCollectionGroupName
matchProjectFromDatabaseName
matchProjectFromFieldName
matchProjectFromIndexName
updateField
v1.FirestoreClient
batchGetDocuments
batchWrite
beginTransaction
close
commit
createDocument
deleteDocument
getDocument
getProjectId
initialize
listCollectionIds
listCollectionIdsAsync
listCollectionIdsStream
listDocuments
listDocumentsAsync
listDocumentsStream
listen
partitionQuery
partitionQueryAsync
partitionQueryStream
rollback
runQuery
updateDocument
write
WriteBatch
commit
create
delete
set
update
WriteResult
isEqual
Modules
@google-cloud/firestore
Global
gapicConfig
setLogFunction
BulkWriterError
BulkWriterError
new BulkWriterError
()
The error thrown when a BulkWriter operation fails.
BulkWriterError
new BulkWriterError
()