From 90f8b0c55225115cfa288fbcb432d92b7b3a9040 Mon Sep 17 00:00:00 2001 From: Mattie Fu Date: Tue, 23 Mar 2021 15:45:40 +0000 Subject: [PATCH] docs: add backup docs --- docs/backup.rst | 6 ++++++ docs/usage.rst | 1 + google/cloud/bigtable/table.py | 2 ++ 3 files changed, 9 insertions(+) create mode 100644 docs/backup.rst diff --git a/docs/backup.rst b/docs/backup.rst new file mode 100644 index 000000000..e75abd431 --- /dev/null +++ b/docs/backup.rst @@ -0,0 +1,6 @@ +Backup +~~~~~~~~ + +.. automodule:: google.cloud.bigtable.backup + :members: + :show-inheritance: diff --git a/docs/usage.rst b/docs/usage.rst index 4e2776805..532f1ce8d 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -9,6 +9,7 @@ Using the API cluster instance table + backup column-family row row-data diff --git a/google/cloud/bigtable/table.py b/google/cloud/bigtable/table.py index 740a65ae6..c2d114362 100644 --- a/google/cloud/bigtable/table.py +++ b/google/cloud/bigtable/table.py @@ -832,6 +832,8 @@ def backup(self, backup_id, cluster_id=None, expire_time=None): :type expire_time: :class:`datetime.datetime` :param expire_time: (Optional) The expiration time of this new Backup. Required, if the `create` method needs to be called. + :rtype: :class:`.Backup` + :returns: A backup linked to this table. """ return Backup( backup_id,