ProjectsDatabasesDocumentsResource class

Constructors

ProjectsDatabasesDocumentsResource(ApiRequester client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

batchGet(BatchGetDocumentsRequest request, String database, {String? $fields}) → Future<BatchGetDocumentsResponse>

Gets multiple documents.

batchWrite(BatchWriteRequest request, String database, {String? $fields}) → Future<BatchWriteResponse>

Applies a batch of write operations.

beginTransaction(BeginTransactionRequest request, String database, {String? $fields}) → Future<BeginTransactionResponse>

Starts a new transaction.

commit(CommitRequest request, String database, {String? $fields}) → Future<CommitResponse>

Commits a transaction, while optionally updating documents.

createDocument(Document request, String parent, String collectionId, {String? documentId, List<String>? mask_fieldPaths, String? $fields}) → Future<Document>

Creates a new document.

delete(String name, {bool? currentDocument_exists, String? currentDocument_updateTime, String? $fields}) → Future<Empty>

Deletes a document.

get(String name, {List<String>? mask_fieldPaths, String? readTime, String? transaction, String? $fields}) → Future<Document>

Gets a single document.

list(String parent, String collectionId, {List<String>? mask_fieldPaths, String? orderBy, int? pageSize, String? pageToken, String? readTime, bool? showMissing, String? transaction, String? $fields}) → Future<ListDocumentsResponse>

Lists documents.

listCollectionIds(ListCollectionIdsRequest request, String parent, {String? $fields}) → Future<ListCollectionIdsResponse>

Lists all the collection IDs underneath a document.

listDocuments(String parent, String collectionId, {List<String>? mask_fieldPaths, String? orderBy, int? pageSize, String? pageToken, String? readTime, bool? showMissing, String? transaction, String? $fields}) → Future<ListDocumentsResponse>

Lists documents.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

partitionQuery(PartitionQueryRequest request, String parent, {String? $fields}) → Future<PartitionQueryResponse>

Partitions a query by returning partition cursors that can be used to run the query in parallel.

patch(Document request, String name, {bool? currentDocument_exists, String? currentDocument_updateTime, List<String>? mask_fieldPaths, List<String>? updateMask_fieldPaths, String? $fields}) → Future<Document>

Updates or inserts a document.

rollback(RollbackRequest request, String database, {String? $fields}) → Future<Empty>

Rolls back a transaction.

runAggregationQuery(RunAggregationQueryRequest request, String parent, {String? $fields}) → Future<RunAggregationQueryResponse>

Runs an aggregation query.

runQuery(RunQueryRequest request, String parent, {String? $fields}) → Future<RunQueryResponse>

Runs a query.

toString() → String

A string representation of this object.

inherited

write(WriteRequest request, String database, {String? $fields}) → Future<WriteResponse>

Streams batches of document updates and deletes, in order.

Operators

operator ==(Object other) → bool

The equality operator.

inherited