Class AsyncWriteBatch

Accumulate write operations to be sent in a batch.

This has the same set of methods for write operations that xref_AsyncDocumentReference does, e.g. xref_create.

Inheritance

builtins.object > BaseBatch > BaseWriteBatch > AsyncWriteBatch

Methods

commit

commit(retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None)

Commit the changes accumulated in this batch.

Parameters
NameDescription
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried. Defaults to a system-specified policy.

timeout float

The timeout for this request. Defaults to a system-specified value.

Returns
TypeDescription
List[WriteResult, ...]The write results corresponding to the changes committed, returned in the same order as the changes were applied to this batch. A write result contains an ``update_time`` field.