Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add backup docs #251

Merged
merged 1 commit into from Mar 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/backup.rst
@@ -0,0 +1,6 @@
Backup
~~~~~~~~

.. automodule:: google.cloud.bigtable.backup
:members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/usage.rst
Expand Up @@ -9,6 +9,7 @@ Using the API
cluster
instance
table
backup
column-family
row
row-data
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/bigtable/table.py
Expand Up @@ -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,
Expand Down