Skip to content
This repository was archived by the owner on Apr 1, 2026. It is now read-only.

Commit 7d5c7aa

Browse files
authored
docs: add backup docs (#251)
1 parent 0072732 commit 7d5c7aa

3 files changed

Lines changed: 9 additions & 0 deletions

File tree

docs/backup.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Backup
2+
~~~~~~~~
3+
4+
.. automodule:: google.cloud.bigtable.backup
5+
:members:
6+
:show-inheritance:

docs/usage.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Using the API
99
cluster
1010
instance
1111
table
12+
backup
1213
column-family
1314
row
1415
row-data

google/cloud/bigtable/table.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -832,6 +832,8 @@ def backup(self, backup_id, cluster_id=None, expire_time=None):
832832
:type expire_time: :class:`datetime.datetime`
833833
:param expire_time: (Optional) The expiration time of this new Backup.
834834
Required, if the `create` method needs to be called.
835+
:rtype: :class:`.Backup`
836+
:returns: A backup linked to this table.
835837
"""
836838
return Backup(
837839
backup_id,

0 commit comments

Comments
 (0)