ProjectsDatabasesDocumentsResourceApi class

Constructors

ProjectsDatabasesDocumentsResourceApi(ApiRequester client)

Properties

hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

batchGet(BatchGetDocumentsRequest request, String database, {String $fields}) Future<BatchGetDocumentsResponse>
Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested. [...]
batchWrite(BatchWriteRequest request, String database, {String $fields}) Future<BatchWriteResponse>
Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead. [...]
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 transaction, String readTime, String $fields}) Future<Document>
Gets a single document. [...]
list(String parent, String collectionId, {List<String> mask_fieldPaths, String pageToken, String orderBy, String readTime, bool showMissing, String transaction, int pageSize, String $fields}) Future<ListDocumentsResponse>
Lists documents. [...]
listCollectionIds(ListCollectionIdsRequest request, String parent, {String $fields}) Future<ListCollectionIdsResponse>
Lists all the collection IDs underneath a document. [...]
listen(ListenRequest request, String database, {String $fields}) Future<ListenResponse>
Listens to changes. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results. [...]
patch(Document request, String name, {bool currentDocument_exists, List<String> updateMask_fieldPaths, List<String> mask_fieldPaths, String currentDocument_updateTime, String $fields}) Future<Document>
Updates or inserts a document. [...]
rollback(RollbackRequest request, String database, {String $fields}) Future<Empty>
Rolls back a transaction. [...]
runQuery(RunQueryRequest request, String parent, {String $fields}) Future<RunQueryResponse>
Runs a query. [...]
toString() String
Returns 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